com.edustructures.sifworks.trans
Class BusStaff

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.trans.BusStaff

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BusStaff
extends SIFKeyedElement

List identifying other staff. This may include aides, nurses, proctors, etc.

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

BusStaff()
Constructor

BusStaff(StaffBoardingStatus status)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getEmployeePersonalRefId() Gets the value of the <EmployeePersonalRefId> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
Name	getName() Gets the value of the <Name> element.
java.lang.String	getStatus() Gets the value of the Status attribute.
void	removeName() Removes the Name child element previously created by calling setName
void	setEmployeePersonalRefId(java.lang.String value) Sets the value of the <EmployeePersonalRefId> element.
void	setName(Name value) Sets the value of the <Name> element.
void	setName(NameType type, java.lang.String lastName, java.lang.String firstName) Sets the value of the <Name> child element.
void	setStatus(StaffBoardingStatus value) Sets the value of the Status attribute.
void	setStatus(java.lang.String value) Sets the value of the Status attribute as a String.

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

BusStaff

public BusStaff()

Constructor

BusStaff

public BusStaff(StaffBoardingStatus status)

Constructor that accepts values for all mandatory fields

Parameters:

status - Boarding status of this staff member.

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

getStatus

public java.lang.String getStatus()

Gets the value of the Status attribute.

The SIF specification defines the meaning of this attribute as: "Boarding status of this staff member."

Returns:

The Status attribute of this object.

Since:

1.5r1

setStatus

public void setStatus(StaffBoardingStatus value)

Sets the value of the Status attribute.

The SIF specification defines the meaning of this attribute as: "Boarding status of this staff member."

Parameters:

value - A constant defined by the StaffBoardingStatus class

Since:

1.5r1

setStatus

public void setStatus(java.lang.String value)

Sets the value of the Status attribute as a String.

The SIF specification defines the meaning of this attribute as: "Boarding status of this staff member."

Parameters:

value - The value as a String

Since:

1.5r1

setName

public void setName(Name value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The name of this staff member. Condition is that at least one of this and BusStaff/EmpLink must be included."

Parameters:

value - A Name object

Since:

1.5r1

setName

public void setName(NameType type,
                    java.lang.String lastName,
                    java.lang.String firstName)

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

Parameters:

type - Code that specifies what type of name this is. If unsure, use 04.

lastName - The last name.

firstName - The first name.

Since:

1.5r1

getName

public Name getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The name of this staff member. Condition is that at least one of this and BusStaff/EmpLink must be included."

Returns:

A Name object

Since:

1.5r1

removeName

public void removeName()

Removes the Name child element previously created by calling setName

Since:

1.5r1

getEmployeePersonalRefId

public java.lang.String getEmployeePersonalRefId()

Gets the value of the <EmployeePersonalRefId> element. This element 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 elements of this kind.

Version	Tag
1.5r1	"EmpLink"
SIF2.0	"EmployeePersonalRefId"

Returns:

The EmployeePersonalRefId element of this object.

Since:

1.5r1

setEmployeePersonalRefId

public void setEmployeePersonalRefId(java.lang.String value)

Sets the value of the <EmployeePersonalRefId> element. This element 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 elements of this kind.

Version	Tag
1.5r1	"EmpLink"
SIF2.0	"EmployeePersonalRefId"

Parameters:

value - A String object

Since:

1.5r1