summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/xml/crypto/XXMLSecurityTemplate.idl
blob: c29f2440bb4f2774eb94a5fd0db4d0c93f93dab1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef __com_sun_star_xml_crypto_xxmlsecuritytemplate_idl_
#define __com_sun_star_xml_crypto_xxmlsecuritytemplate_idl_

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
#include <com/sun/star/xml/crypto/XUriBinding.idl>
#include <com/sun/star/xml/crypto/SecurityOperationStatus.idl>

module com { module sun { module star { module xml { module crypto {

/**
 * Interface of the XML security template
 *
 * <p>This interface represents a security template, which is the super interface
 * of the XXMLSignatureTemplate interface and the XXMLEncryptionTemplate interface.
 */
interface XXMLSecurityTemplate : com::sun::star::uno::XInterface
{
    /**
     * Load a XML signature template from XML signature element
     */
    void setTemplate(
        [in] com::sun::star::xml::wrapper::XXMLElementWrapper aXmlElement
    ) raises( com::sun::star::lang::IllegalArgumentException ) ;

    /**
     * Get the XML signature element that represents the signature template
     */
    com::sun::star::xml::wrapper::XXMLElementWrapper getTemplate(
    ) ;

    /**
     * Load the target XML element, i.e. the element to be signed
     */
    void setTarget(
        [in] com::sun::star::xml::wrapper::XXMLElementWrapper aXmlElement
    ) raises( com::sun::star::lang::IllegalArgumentException ) ;

    /**
     * Set the template status
     */
    void setStatus(
        [in] SecurityOperationStatus status
    ) raises( com::sun::star::lang::IllegalArgumentException ) ;

    /**
     * Get the template status
     */
    SecurityOperationStatus getStatus( ) ;
} ;

} ; } ; } ; } ; } ;

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */