offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XInteractionSupplyAuthentication.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_XInteractionSupplyAuthentication2_idl__
  31 #define __com_sun_star_ucb_XInteractionSupplyAuthentication2_idl__
  32
  33 #ifndef __com_sun_star_ucb_XInteractionSupplyAuthentication_idl__
  34 #include <com/sun/star/ucb/XInteractionSupplyAuthentication.idl>
  35 #endif
  36
  37
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module ucb {
  42
  43 //=============================================================================
  44 /** An interaction continuation handing back some authentication data.
  45
  46     <p> This continuation is typically used in conjunction with
  47     <type>AuthenticationRequest</type>. </p>
  48 */
  49 /*published*/ interface XInteractionSupplyAuthentication2 : XInteractionSupplyAuthentication
  50 {
  51     //-------------------------------------------------------------------------
  52     /** Specifies if 'system credentials' can be obtained and used by the issuer
  53         of the authentiction request.
  54
  55         @param Default
  56         Returns the default behavior for system credentials handling (to be
  57         initially displayed to the user).
  58
  59         @returns
  60         <true/> if the issuer is able to obtain and use system credentials.
  61         <false/> otherwise.
  62     */
  63     boolean canUseSystemCredentials( [out] boolean Default );
  64
  65     //-------------------------------------------------------------------------
  66     /** Set a new 'use system credentials' value to hand back.
  67
  68         @param UseSystemCredentials
  69         <true/> means the request issuer shall obtain and use system credentials.
  70      */
  71     void setUseSystemCredentials( [in] boolean UseSystemCredentials );
  72
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif