xref: /AOO41X/main/offapi/com/sun/star/xml/crypto/XXMLSecurityTemplate.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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
24//i20156 - new file for xmlsecurity module
25
26/** -- idl definition -- **/
27
28#ifndef __com_sun_star_xml_crypto_xxmlsecuritytemplate_idl_
29#define __com_sun_star_xml_crypto_xxmlsecuritytemplate_idl_
30
31#include <com/sun/star/uno/XInterface.idl>
32#include <com/sun/star/lang/IllegalArgumentException.idl>
33
34#include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
35#include <com/sun/star/xml/crypto/XUriBinding.idl>
36#include <com/sun/star/xml/crypto/SecurityOperationStatus.idl>
37
38module com { module sun { module star { module xml { module crypto {
39
40/**
41 * Interface of the XML security template
42 *
43 * <p>This interface represents a security template, which is the super interface
44 * of the XXMLSignatureTemplate interface and the XXMLEncryptionTemplate interface.
45 */
46interface XXMLSecurityTemplate : com::sun::star::uno::XInterface
47{
48    /**
49     * Load a XML signature template from xml signature element
50     */
51    void setTemplate(
52        [in] com::sun::star::xml::wrapper::XXMLElementWrapper aXmlElement
53    ) raises( com::sun::star::lang::IllegalArgumentException ) ;
54
55    /**
56     * Get the XML signature element that represents the signature template
57     */
58    com::sun::star::xml::wrapper::XXMLElementWrapper getTemplate(
59    ) ;
60
61    /**
62     * Load the target xml element, i.e. the element to be signed
63     */
64    void setTarget(
65        [in] com::sun::star::xml::wrapper::XXMLElementWrapper aXmlElement
66    ) raises( com::sun::star::lang::IllegalArgumentException ) ;
67
68    /**
69     * Set the template status
70     */
71    void setStatus(
72        [in] SecurityOperationStatus status
73    ) raises( com::sun::star::lang::IllegalArgumentException ) ;
74
75    /**
76     * Get the template status
77     */
78    SecurityOperationStatus getStatus( ) ;
79} ;
80
81} ; } ; } ; } ; } ;
82
83
84#endif
85
86