xref: /aoo42x/main/offapi/com/sun/star/ucb/XInteractionCookieHandling.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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