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_embed_XActionsApproval_idl__
24#define __com_sun_star_embed_XActionsApproval_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30//============================================================================
31
32 module com {  module sun {  module star {  module embed {
33
34//============================================================================
35/** allows to request an approval for an action.
36
37	<p>
38	An implementation of this interface is usually provided to another object
39	to allow this object to request an approval for actions. The list of
40	possible actions must be documented in documentation of the object.
41	</p>
42 */
43published interface XActionsApproval: com::sun::star::uno::XInterface
44{
45	//------------------------------------------------------------------------
46    /** requests an approval for the specified action.
47
48		@param nAction
49			a value specifying the action that should be approved. Could take
50			values from <type>Actions</type> constants set. The explicit set
51			of the actions should be documented by the object that is going
52			to use this interface for approval as for example
53			<type>InstanceLocker</type> does.
54
55		@return
56			returns <TRUE/> in case the specified action is approved.
57	 */
58	boolean approveAction( [in] long nAction );
59};
60
61//============================================================================
62
63}; }; }; };
64
65#endif
66
67