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