a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: Obligations.java,v 1.3 2008/11/10 22:57:05 veiming Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>Obligations</code> element is a container of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * one or more <code>Obligation</code>s issuded by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * authorization authority.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster <xs:element name="Obligations" type="xacml:ObligationsType"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster <xs:complexType name="ObligationsType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster <xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster <xs:element ref="xacml:Obligation" maxOccurs="unbounded"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster </xs:complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static final String OBLIGATIONS_ELEMENT = "Obligations";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>Obligation</code> objects set in this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>Obligation</code> objects set in this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>Obligation</code> objects of this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param obligations the <code>Obligation</code> objects to set in this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setObligations(List obligations) throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void addObligation(Obligation obligation) throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a string representation of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNSPrefix Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a string representation of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Makes this object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Checks if this object is mutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return <code>true</code> if the object is mutable,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>false</code> otherwise