com.edustructures.sifworks.dw
Class LocationRefId

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.dw.LocationRefId

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LocationRefId
extends SIFKeyedElement

RefId of the location object if the location is a SIF object such as School (SchoolInfo)

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

LocationRefId()
Constructor

LocationRefId(LocationRefIdObjectName sifRefObject, java.lang.String value)
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.String	getSIF_RefObject() Gets the value of the SIF_RefObject attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
void	setSIF_RefObject(LocationRefIdObjectName value) Sets the value of the SIF_RefObject attribute.
void	setSIF_RefObject(java.lang.String value) Sets the value of the SIF_RefObject attribute as a String.
void	setValue(java.lang.String value) Sets the value of the <Value> element.

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationRefId

public LocationRefId()

Constructor

LocationRefId

public LocationRefId(LocationRefIdObjectName sifRefObject,
                     java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

sifRefObject - Type of SIF object Location points to.

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

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

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <LocationRefId> element"

Returns:

The Value element of this object.

Since:

1.5r1

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <LocationRefId> element"

Parameters:

value - A String object

Since:

1.5r1

getSIF_RefObject

public java.lang.String getSIF_RefObject()

Gets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "Type of SIF object Location points to."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"ObjectName"
SIF2.0	"SIF_RefObject"

Returns:

The SIF_RefObject attribute of this object.

Since:

1.5r1

setSIF_RefObject

public void setSIF_RefObject(LocationRefIdObjectName value)

Sets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "Type of SIF object Location points to."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"ObjectName"
SIF2.0	"SIF_RefObject"

Parameters:

value - A constant defined by the LocationRefIdObjectName class

Since:

1.5r1

setSIF_RefObject

public void setSIF_RefObject(java.lang.String value)

Sets the value of the SIF_RefObject attribute as a String.

The SIF specification defines the meaning of this attribute as: "Type of SIF object Location points to."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"ObjectName"
SIF2.0	"SIF_RefObject"

Parameters:

value - The value as a String

Since:

1.5r1