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

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