Package com.sun.identity.saml2.protocol

Interface StatusCode

All Known Implementing Classes:

StatusCodeImpl

public interface StatusCode

This class represents the StatusCodeType complex type in SAML protocol schema. The StatusCode element specifies a code or a set of nested codes representing the status of the corresponding request.

 <complexType name="StatusCodeType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusCode" minOccurs="0"/>
       </sequence>
       <attribute name="Value" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

Modifier and Type	Method	Description
StatusCode	getStatusCode()	Returns the value of the statusCode property.
String	getValue()	Returns the value of the value property.
boolean	isMutable()	Returns true if the object is mutable, false otherwise
void	makeImmutable()	Makes the object immutable
void	setStatusCode(StatusCode value)	Sets the value of the statusCode property.
void	setValue(String value)	Sets the value of the value property.
String	toXMLString()	Returns the StatusCode in an XML document String format based on the StatusCode schema described above.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns the StatusCode in an XML document String format based on the StatusCode schema described above.

Method Detail

getStatusCode

StatusCode getStatusCode()

Returns the value of the statusCode property.

Returns:

the value of the statusCode property

See Also:

setStatusCode(StatusCode)

setStatusCode

void setStatusCode(StatusCode value)
            throws SAML2Exception

Sets the value of the statusCode property.

Parameters:

value - the value of the statusCode property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatusCode()

getValue

String getValue()

Returns the value of the value property.

Returns:

the value of the value property

See Also:

setValue(String)

setValue

void setValue(String value)
       throws SAML2Exception

Sets the value of the value property.

Parameters:

value - the value of the value property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getValue()

toXMLString

String toXMLString()
            throws SAML2Exception

Returns the StatusCode in an XML document String format based on the StatusCode schema described above.

Returns:

An XML String representing the StatusCode.

Throws:

SAML2Exception - if some error occurs during conversion to String.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns the StatusCode in an XML document String format based on the StatusCode schema described above.

Parameters:

includeNSPrefix - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A XML String representing the StatusCode.

Throws:

SAML2Exception - if some error occurs during conversion to String.

makeImmutable

void makeImmutable()

Makes the object immutable

isMutable

boolean isMutable()

Returns true if the object is mutable, false otherwise

Returns:

true if the object is mutable, false otherwise