Package com.sun.identity.saml2.ecp

Interface ECPRelayState

@SupportedAll
public interface ECPRelayState

The ECPRelayState interface defines methods for properties required by an ECP RelayState.

Method Summary

Modifier and Type	Method	Description
String	getActor()	Returns value of actor attribute.
String	getValue()	Returns the value of the RelayState.
Boolean	isMustUnderstand()	Returns value of mustUnderstand attribute.
boolean	isMutable()	Returns true if object is mutable.
void	makeImmutable()	Makes this object immutable.
void	setActor(String actor)	Sets the value of actor attribute.
void	setMustUnderstand(Boolean mustUnderstand)	Sets the value of the mustUnderstand attribute.
void	setValue(String value)	Sets the value of the RelayState.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation of this Object.

Method Detail

getValue

String getValue()

Returns the value of the RelayState.

Returns:

value of the RelayState.

See Also:

setValue(String)

setValue

void setValue(String value)
       throws SAML2Exception

Sets the value of the RelayState.

Parameters:

value - new value of the RelayState.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getValue()

isMustUnderstand

Boolean isMustUnderstand()

Returns value of mustUnderstand attribute.

Returns:

value of mustUnderstand attribute.

setMustUnderstand

void setMustUnderstand(Boolean mustUnderstand)
                throws SAML2Exception

Sets the value of the mustUnderstand attribute.

Parameters:

mustUnderstand - the value of mustUnderstand attribute.

Throws:

SAML2Exception - if the object is immutable.

getActor

String getActor()

Returns value of actor attribute.

Returns:

value of actor attribute

setActor

void setActor(String actor)
       throws SAML2Exception

Sets the value of actor attribute.

Parameters:

actor - the value of actor attribute

Throws:

SAML2Exception - if the object is immutable.

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation of this Object.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot create String object.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation of this Object.

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:

the String representation of this Object.

Throws:

SAML2Exception - if cannot create String object.

makeImmutable

void makeImmutable()

Makes this object immutable.

isMutable

boolean isMutable()

Returns true if object is mutable.

Returns:

true if object is mutable.