xref: /aoo42x/main/offapi/com/sun/star/util/XProtectable.idl (revision 37b7d578)

/**************************************************************
 *
 * 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_util_XProtectable_idl__
#define __com_sun_star_util_XProtectable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


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

module com {  module sun {  module star {  module util {

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

/** makes it possible to protect objects from modifications.
 */
published interface XProtectable: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** activates the protection.

		@param aPassword
			a string to specify new password.
	 */
	void protect( [in] string aPassword );

	//-------------------------------------------------------------------------
	/** removes the protection.

		@param aPassword
			a string to match with the current password.
		@throws com::sun::star::lang::IllegalArgumentException
			if invalid password is specified.
	 */
	void unprotect( [in] string aPassword )
			raises( com::sun::star::lang::IllegalArgumentException );

	//-------------------------------------------------------------------------
	/** @returns
				the current state of protection.
	 */
	boolean isProtected();

};

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

}; }; }; };

#endif