com.edustructures.sifworks.infra
Class SIF_Status

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.infra.SIF_Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Status
extends SIFKeyedElement

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_Status()
Constructor

SIF_Status(java.lang.Integer sifCode)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.Integer	getSIF_Code() Gets the value of the <SIF_Code> element.
SIF_Data	getSIF_Data() Gets the value of the <SIF_Data> element.
java.lang.String	getSIF_Desc() Gets the value of the <SIF_Desc> element.
void	removeSIF_Data() Removes the SIF_Data child element previously created by calling setSIF_Data
void	setSIF_Code(java.lang.Integer value) Sets the value of the <SIF_Code> element.
void	setSIF_Data(SIF_Data value) Sets the value of the <SIF_Data> element.
void	setSIF_Data(java.lang.String value) Sets the value of the <SIF_Data> child element.
void	setSIF_Desc(java.lang.String value) Sets the value of the <SIF_Desc> element.
java.lang.String	toString() Returns the value of getTextValue

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SIF_Status

public SIF_Status()

Constructor

SIF_Status

public SIF_Status(java.lang.Integer sifCode)

Constructor that accepts values for all mandatory fields

Parameters:

sifCode -

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getSIF_Code

public java.lang.Integer getSIF_Code()

Gets the value of the <SIF_Code> element.

Returns:

The SIF_Code element of this object.

Since:

1.1

setSIF_Code

public void setSIF_Code(java.lang.Integer value)

Sets the value of the <SIF_Code> element.

Parameters:

value - A Integer object

Since:

1.1

getSIF_Desc

public java.lang.String getSIF_Desc()

Gets the value of the <SIF_Desc> element.

The SIF specification defines the meaning of this element as: "An optional textual description/equivalent of SIF_Code."

Returns:

The SIF_Desc element of this object.

Since:

2.0

setSIF_Desc

public void setSIF_Desc(java.lang.String value)

Sets the value of the <SIF_Desc> element.

The SIF specification defines the meaning of this element as: "An optional textual description/equivalent of SIF_Code."

Parameters:

value - A String object

Since:

2.0

setSIF_Data

public void setSIF_Data(SIF_Data value)

Sets the value of the <SIF_Data> element.

The SIF specification defines the meaning of this element as: " Optional element to hold data related to a successful operation. This data is currently limited to a SIF_Message returned by the ZIS in response to a Pull-Mode Agent's SIF_GetMessage, SIF_AgentACL returned by the ZIS in response to SIF_Register and SIF_GetAgentACL, and SIF_ZoneStatus returned by the ZIS in response to SIF_GetZoneStatus. "

Parameters:

value - A SIF_Data object

Since:

1.1

setSIF_Data

public void setSIF_Data(java.lang.String value)

Sets the value of the <SIF_Data> child element. This form of setSIF_Data is provided as a convenience method that is functionally equivalent to the version of setSIF_Data that accepts a single SIF_Data object.

Parameters:

value - Gets or sets the content value of the <SIF_Data> element

Since:

1.1

getSIF_Data

public SIF_Data getSIF_Data()

Gets the value of the <SIF_Data> element.

The SIF specification defines the meaning of this element as: " Optional element to hold data related to a successful operation. This data is currently limited to a SIF_Message returned by the ZIS in response to a Pull-Mode Agent's SIF_GetMessage, SIF_AgentACL returned by the ZIS in response to SIF_Register and SIF_GetAgentACL, and SIF_ZoneStatus returned by the ZIS in response to SIF_GetZoneStatus. "

Returns:

A SIF_Data object

Since:

1.1

removeSIF_Data

public void removeSIF_Data()

Removes the SIF_Data child element previously created by calling setSIF_Data

Since:

1.1

toString

public java.lang.String toString()

Description copied from class: Element

Returns the value of getTextValue

Overrides:

toString in class Element

Returns:

The text value of this element if applicable