INTEGRATION: CWS ab20lib (1.1.2); FILE ADDED

2005/09/22 14:47:28 ab 1.1.2.1: #125948# Moved from udkapi

1 files changed, 177 insertions, 0 deletions

diff --git a/offapi/com/sun/star/script/XLibraryContainerPassword.idl b/offapi/com/sun/star/script/XLibraryContainerPassword.idl
new file mode 100644
index 000000000000..ca3f8d0752b8
--- /dev/null
+++ b/offapi/com/sun/star/script/XLibraryContainerPassword.idl
@@ -0,0 +1,177 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XLibraryContainerPassword.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2006-04-07 08:39:51 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library 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 for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_script_XLibraryContainerPassword_idl__
+#define __com_sun_star_script_XLibraryContainerPassword_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
+
+#ifndef __com_sun_star_container_NoSuchElementException_idl__
+#include <com/sun/star/container/NoSuchElementException.idl>
+#endif
+
+
+//=============================================================================
+
+ module com {  module sun {  module star {  module script {
+
+//=============================================================================
+
+/**
+    Extension of XLibraryContainer to provide password functionality.
+    This interface should be implemented together with XLibraryContainer2
+    </p>
+ */
+published interface XLibraryContainerPassword:  com::sun::star::uno::XInterface
+{
+    /**
+        Returns true if the accessed library item is protected
+        by a password.
+
+        If a library with the this name doesn't exist a
+        com::sun::star::container::NoSuchElementException is thrown.
+     */
+    boolean isLibraryPasswordProtected( [in] string Name )
+            raises( com::sun::star::container::NoSuchElementException );
+
+    /**
+        Returns true if the accessed library item is protected by a
+        password (see isLibraryPasswordProtected) and the password
+        was already verified with verifyLibraryPassword or if an
+        initial password was set with changeLibraryPassword.
+
+        If a library with the this name doesn't exist a
+        com::sun::star::container::NoSuchElementException is thrown.
+
+        If the library exists but isn't password protected a
+        com::sun::star::lang::IllegalArgumentException is thrown.
+     */
+    boolean isLibraryPasswordVerified( [in] string Name )
+            raises( com::sun::star::lang::IllegalArgumentException,
+                    com::sun::star::container::NoSuchElementException );
+
+    /**
+        Verifies the library's password. If the correct password
+        was passed, the method returns true and further calls to
+        isLibraryPasswordVerified will also return true.
+
+        If a library with the this name doesn't exist a
+        com::sun::star::container::NoSuchElementException is thrown.
+
+        If the library exists but isn't password protected a
+        com::sun::star::lang::IllegalArgumentException is thrown.
+
+        If the library password is already verified a
+        com::sun::star::lang::IllegalArgumentException is thrown.
+     */
+    boolean verifyLibraryPassword( [in] string Name, [in] string Password )
+            raises( com::sun::star::lang::IllegalArgumentException,
+                    com::sun::star::container::NoSuchElementException );
+
+    /**
+        Changes the library's password.
+
+        If the library wasn't password protected before:
+        The OldPassword parameter has to be an empty string.
+        Afterwards calls to isLibraryPasswordProtected and
+        isLibraryPasswordVerified for this library will
+        return true.
+
+        If the library already was password protected:
+        The OldPassword parameter has to be set to the
+        previous defined password. If then the NewPassword
+        parameter is an empty string the library password
+        protection will be disabled afterwards (afterwards
+        calls to isLibraryPasswordProtected for this library
+        will return false). If the NewPassword parameter is
+        not an empty string it will accepted as the new
+        password for the library.
+
+        If a library with the this name doesn't exist but isn't
+        com::sun::star::container::NoSuchElementException is thrown.
+
+        If the library exists and is password protected and a
+        wrong OldPassword is passed to the method a
+        com::sun::star::lang::IllegalArgumentException is thrown.
+
+        If the library exists and isn't password protected and
+        the OldPassword isn't an empty string or the library is
+        read only a
+        com::sun::star::lang::IllegalArgumentException is thrown.
+     */
+    void changeLibraryPassword( [in] string Name,
+        [in] string OldPassword, [in] string NewPassword )
+            raises( com::sun::star::lang::IllegalArgumentException,
+                    com::sun::star::container::NoSuchElementException );
+
+};
+
+//=============================================================================
+
+
+}; }; }; };
+
+#endif