com.sun.identity.liberty.ws.common

Class Status

java.lang.Object

com.sun.identity.liberty.ws.common.Status

public class Status
extends Object

This class represents a common status object. The following schema fragment specifies the expected content within the Status object.

 <complexType name="Status">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="Status" minOccurs="0"/>
       </sequence>
       <attribute name="code" use="required" type="{http://www.w3.org/2001/XMLSchema}QName" />
       <attribute name="comment" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="ref" type="{http://www.w3.org/2001/XMLSchema}IDREF" />
     </restriction>
   </complexContent>
 </complexType>
 

Constructor Summary

Constructors

Constructor and Description
Status() Default constructor.
Status(String ns, String nsPrefix) Constructor.

Method Summary

Modifier and Type	Method and Description
QName	getCode() Gets status code.
String	getComment() Gets comment for the status.
String	getRef() Gets reference attribute.
Status	getSubStatus() Gets sub status.
void	setCode(QName value) Sets status code.
void	setComment(String comment) Sets comment
void	setRef(String value) Sets reference attribute.
void	setSubStatus(Status status) Sets sub status.
String	toString() Returns string format of the status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Status

public Status()

Default constructor.

Status

public Status(String ns,
              String nsPrefix)

Constructor.

Parameters:

ns - Name space for the Status object

nsPrefix - prefix used for the name space, for example, disco.

Method Detail

getSubStatus

public Status getSubStatus()

Gets sub status.

Returns:

Status

See Also:

Status.setSubStatus(Status)

setSubStatus

public void setSubStatus(Status status)

Sets sub status. The sub status is used by a service to convey second-level status information in addition to the status code.

Parameters:

status - Status to be set

See Also:

Status.getSubStatus()

getRef

public String getRef()

Gets reference attribute.

Returns:

reference attribute.

See Also:

Status.setRef(String)

setRef

public void setRef(String value)

Sets reference attribute.

Parameters:

value - reference to be set

See Also:

Status.getRef()

getCode

public QName getCode()

Gets status code.

Returns:

status code.

See Also:

Status.setCode(QName)

setCode

public void setCode(QName value)

Sets status code.

Parameters:

value - status code to be set

See Also:

Status.getCode()

getComment

public String getComment()

Gets comment for the status.

Returns:

comment for the status.

See Also:

Status.setComment(String)

setComment

public void setComment(String comment)

Sets comment

Parameters:

comment - String

See Also:

Status.getComment()

toString

public String toString()

Returns string format of the status.

Overrides:

toString in class Object

Returns:

String