/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006 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: Status.java,v 1.2 2008/06/25 05:47:58 qcheng Exp $
*
*/
/**
* This class represents the <code>StatusType</code> complex type in
* SAML protocol schema.
*
* <pre>
* <complexType name="StatusType">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusCode"/>
* <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusMessage" minOccurs="0"/>
* <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusDetail" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
* </pre>
*
* @supported.all.api
*/
public interface Status {
/**
* Returns the value of the statusCode property.
*
* @return the value of the statusCode property
* @see #setStatusCode(StatusCode)
*/
/**
* Sets the value of the statusCode property.
*
* @param value the value of the statusCode property to be set
* @throws SAML2Exception if the object is immutable
* @see #getStatusCode
*/
throws SAML2Exception;
/**
* Returns the value of the statusMessage property.
*
* @return the value of the statusMessage property
* @see #setStatusMessage(String)
*/
/**
* Sets the value of the statusMessage property.
*
* @param value the value of the statusMessage property to be set
* @throws SAML2Exception if the object is immutable
* @see #getStatusMessage
*/
throws SAML2Exception;
/**
* Returns the value of the statusDetail property.
*
* @return the value of the statusDetail property
* @see #setStatusDetail(StatusDetail)
*/
/**
* Sets the value of the statusDetail property.
*
* @param value the value of the statusDetail property to be set
* @throws SAML2Exception if the object is immutable
* @see #getStatusDetail
*/
public void setStatusDetail(
throws SAML2Exception;
/**
* Returns the <code>Status</code> in an XML document String format
* based on the <code>Status</code> schema described above.
*
* @return An XML String representing the <code>Status</code>.
* @throws SAML2Exception if some error occurs during conversion to
* <code>String</code>.
*/
/**
* Returns the <code>Status</code> in an XML document String format
* based on the <code>Status</code> schema described above.
*
* @param includeNSPrefix 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 XML String representing the <code>Status</code>.
* @throws SAML2Exception if some error occurs during conversion to
* <code>String</code>.
*/
throws SAML2Exception;
/**
* Makes the obejct immutable
*/
public void makeImmutable();
/**
* Returns true if the object is mutable, false otherwise
*
* @return true if the object is mutable, false otherwise
*/
public boolean isMutable();
}