offapi/com/sun/star/xml/crypto/XXMLSecurityTemplate.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 //i20156 - new file for xmlsecurity module
  29
  30 /** -- idl definition -- **/
  31
  32 #ifndef __com_sun_star_xml_crypto_xxmlsecuritytemplate_idl_
  33 #define __com_sun_star_xml_crypto_xxmlsecuritytemplate_idl_
  34
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #include <com/sun/star/lang/IllegalArgumentException.idl>
  37
  38 #include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
  39 #include <com/sun/star/xml/crypto/XUriBinding.idl>
  40 #include <com/sun/star/xml/crypto/SecurityOperationStatus.idl>
  41
  42 module com { module sun { module star { module xml { module crypto {
  43
  44 /**
  45  * Interface of the XML security template
  46  *
  47  * <p>This interface represents a security template, which is the super interface
  48  * of the XXMLSignatureTemplate interface and the XXMLEncryptionTemplate interface.
  49  */
  50 interface XXMLSecurityTemplate : com::sun::star::uno::XInterface
  51 {
  52     /**
  53      * Load a XML signature template from xml signature element
  54      */
  55     void setTemplate(
  56         [in] com::sun::star::xml::wrapper::XXMLElementWrapper aXmlElement
  57     ) raises( com::sun::star::lang::IllegalArgumentException ) ;
  58
  59     /**
  60      * Get the XML signature element that represents the signature template
  61      */
  62     com::sun::star::xml::wrapper::XXMLElementWrapper getTemplate(
  63     ) ;
  64
  65     /**
  66      * Load the target xml element, i.e. the element to be signed
  67      */
  68     void setTarget(
  69         [in] com::sun::star::xml::wrapper::XXMLElementWrapper aXmlElement
  70     ) raises( com::sun::star::lang::IllegalArgumentException ) ;
  71
  72     /**
  73      * Set the template status
  74      */
  75     void setStatus(
  76         [in] SecurityOperationStatus status
  77     ) raises( com::sun::star::lang::IllegalArgumentException ) ;
  78
  79     /**
  80      * Get the template status
  81      */
  82     SecurityOperationStatus getStatus( ) ;
  83 } ;
  84
  85 } ; } ; } ; } ; } ;
  86
  87
  88 #endif
  89