/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: AssertionIDRef.java,v 1.2 2008/06/25 05:47:40 qcheng Exp $
*
*/
/**
* This class represents the AssertionIDRef element.
* <p>The following schema fragment specifies the expected
* content contained within this java content object.
* <p>
* <pre>
* <element name="AssertionIDRef" type="NCName"/>
* </pre>
*
* @supported.all.api
*/
public interface AssertionIDRef {
/**
* Returns the value of the <code>AssertionIDRef</code>.
*
* @return the value of this <code>AssertionIDRef</code>.
* @see #setValue(String)
*/
/**
* Sets the value of this <code>AssertionIDRef</code>.
*
* @param value new <code>AssertionIDRef</code>.
* @throws SAML2Exception if the object is immutable.
* @see #getValue()
*/
/**
* Makes the object immutable.
*/
public void makeImmutable();
/**
* Returns the mutability of the object.
*
* @return <code>true</code> if the object is mutable; <code>false</code>
* otherwise.
*/
public boolean isMutable();
/**
* Returns a String representation of the element.
*
* @return A string containing the valid XML for this element.
* By default name space name is prepended to the element name.
* @throws SAML2Exception if the object does not conform to the schema.
*/
/**
* Returns a String representation of the element.
*
* @param includeNS Determines whether or not the namespace qualifier is
* prepended to the Element when converted
* @param declareNS Determines whether or not the namespace is declared
* within the Element.
* @return A string containing the valid XML for this element
* @throws SAML2Exception if the object does not conform to the schema.
*/
throws SAML2Exception;
}