xref: /AOO41X/main/offapi/com/sun/star/ucb/XInteractionCookieHandling.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XInteractionCookieHandling_idl__
24#define __com_sun_star_ucb_XInteractionCookieHandling_idl__
25
26#ifndef __com_sun_star_task_XInteractionContinuation_idl__
27#include <com/sun/star/task/XInteractionContinuation.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_CookiePolicy_idl__
31#include <com/sun/star/ucb/CookiePolicy.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_Cookie_idl__
35#include <com/sun/star/ucb/Cookie.idl>
36#endif
37
38
39//=============================================================================
40
41module com { module sun { module star { module ucb {
42
43//=============================================================================
44/** An interaction continuation handing back some cookie request handling
45    policy.
46
47    <p>This continuation is typically used in conjunction with
48    <type>HandleCookiesRequest</type>.
49*/
50published interface XInteractionCookieHandling: com::sun::star::task::XInteractionContinuation
51{
52    //-------------------------------------------------------------------------
53    /** Set a general policy to hand back.
54
55        <p>This method should be called before select().
56
57        @param Policy
58            Some policy how to handle cookies.
59    */
60    void setGeneralPolicy( [in] com::sun::star::ucb::CookiePolicy Policy );
61
62    //-------------------------------------------------------------------------
63    /** Set a policy to hand back for a specific cookie.
64
65        <p>This method should be called before select().
66
67        @param ConfirmCookie
68            A cookie that sould come from the sequence of
69            cookies offered by the <type>HandleCookiesRequest</type> and that
70            should have a policy of <member>CookiePolicy::CONFIRM</member>.
71
72        @param Accept
73            If <TRUE/>, set the policy for the cookie to
74            <member>CookiePolicy::ACCEPT</member>; otherwise, set it to
75            <member>CookiePolicy::IGNORE</member>.
76    */
77    void setSpecificPolicy( [in] com::sun::star::ucb::Cookie ConfirmCookie,
78             [in] boolean Accept );
79
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87