xref: /aoo4110/main/offapi/com/sun/star/ucb/XInteractionCookieHandling.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_ucb_XInteractionCookieHandling_idl__
#define __com_sun_star_ucb_XInteractionCookieHandling_idl__

#ifndef __com_sun_star_task_XInteractionContinuation_idl__
#include <com/sun/star/task/XInteractionContinuation.idl>
#endif

#ifndef __com_sun_star_ucb_CookiePolicy_idl__
#include <com/sun/star/ucb/CookiePolicy.idl>
#endif

#ifndef __com_sun_star_ucb_Cookie_idl__
#include <com/sun/star/ucb/Cookie.idl>
#endif


//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** An interaction continuation handing back some cookie request handling
	policy.

	<p>This continuation is typically used in conjunction with
	<type>HandleCookiesRequest</type>.
*/
published interface XInteractionCookieHandling: com::sun::star::task::XInteractionContinuation
{
	//-------------------------------------------------------------------------
	/** Set a general policy to hand back.

		<p>This method should be called before select().

		@param Policy
			Some policy how to handle cookies.
	*/
	void setGeneralPolicy( [in] com::sun::star::ucb::CookiePolicy Policy );

	//-------------------------------------------------------------------------
	/** Set a policy to hand back for a specific cookie.

		<p>This method should be called before select().

		@param ConfirmCookie
			A cookie that sould come from the sequence of
			cookies offered by the <type>HandleCookiesRequest</type> and that
			should have a policy of <member>CookiePolicy::CONFIRM</member>.

		@param Accept
			If <TRUE/>, set the policy for the cookie to
			<member>CookiePolicy::ACCEPT</member>; otherwise, set it to
			<member>CookiePolicy::IGNORE</member>.
	*/
	void setSpecificPolicy( [in] com::sun::star::ucb::Cookie ConfirmCookie,
			 [in] boolean Accept );

};

//=============================================================================

}; }; }; };

#endif