offapi/com/sun/star/ucb/XInteractionCookieHandling.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: XInteractionCookieHandling.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_XInteractionCookieHandling_idl__
  31 #define __com_sun_star_ucb_XInteractionCookieHandling_idl__
  32
  33 #ifndef __com_sun_star_task_XInteractionContinuation_idl__
  34 #include <com/sun/star/task/XInteractionContinuation.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_CookiePolicy_idl__
  38 #include <com/sun/star/ucb/CookiePolicy.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_Cookie_idl__
  42 #include <com/sun/star/ucb/Cookie.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** An interaction continuation handing back some cookie request handling
  52     policy.
  53
  54     <p>This continuation is typically used in conjunction with
  55     <type>HandleCookiesRequest</type>.
  56 */
  57 published interface XInteractionCookieHandling: com::sun::star::task::XInteractionContinuation
  58 {
  59     //-------------------------------------------------------------------------
  60     /** Set a general policy to hand back.
  61
  62         <p>This method should be called before select().
  63
  64         @param Policy
  65             Some policy how to handle cookies.
  66     */
  67     void setGeneralPolicy( [in] com::sun::star::ucb::CookiePolicy Policy );
  68
  69     //-------------------------------------------------------------------------
  70     /** Set a policy to hand back for a specific cookie.
  71
  72         <p>This method should be called before select().
  73
  74         @param ConfirmCookie
  75             A cookie that sould come from the sequence of
  76             cookies offered by the <type>HandleCookiesRequest</type> and that
  77             should have a policy of <member>CookiePolicy::CONFIRM</member>.
  78
  79         @param Accept
  80             If <TRUE/>, set the policy for the cookie to
  81             <member>CookiePolicy::ACCEPT</member>; otherwise, set it to
  82             <member>CookiePolicy::IGNORE</member>.
  83     */
  84     void setSpecificPolicy( [in] com::sun::star::ucb::Cookie ConfirmCookie,
  85              [in] boolean Accept );
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif