com.edustructures.sifworks.programs
Class Service

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.programs.Service

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Service
extends SIFKeyedElement

Specialized instruction or related service provided to this student.

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

Service()
Constructor

Service(java.lang.String codeType, ServiceCode code, ServiceTypeValue type)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCode() Gets the value of the <Code> element.
java.lang.String	getCodeType() Gets the value of the CodeType attribute.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
OtherCodeList	getOtherCodeList() Gets the value of the <OtherCodeList> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeOtherCodeList() Removes the OtherCodeList child element previously created by calling setOtherCodeList
void	setCode(ServiceCode value) Sets the value of the <Code> element.
void	setCode(java.lang.String value) Sets the value of the <Code> element as a String.
void	setCodeType(java.lang.String value) Sets the value of the CodeType attribute.
void	setOtherCodeList(OtherCodeList value) Sets the value of the <OtherCodeList> element.
void	setType(ServiceTypeValue value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type 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

Service

public Service()

Constructor

Service

public Service(java.lang.String codeType,
               ServiceCode code,
               ServiceTypeValue type)

Constructor that accepts values for all mandatory fields

Parameters:

codeType - if CodeType is "NCES" then the codes used is NCES 0273 Student Support Service Type [NCES Handbooks] or 0274 Student/Family Program Type [NCES Handbooks], depending on the value of the Type attribute

code - Specialized instruction or related / transitional service provided to this student.

type - Values: InstructionalService, RelatedService, Other

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

getCodeType

public java.lang.String getCodeType()

Gets the value of the CodeType attribute.

The SIF specification defines the meaning of this attribute as: "if CodeType is "NCES" then the codes used is NCES 0273 Student Support Service Type [NCES Handbooks] or 0274 Student/Family Program Type [NCES Handbooks], depending on the value of the Type attribute"

Returns:

The CodeType attribute of this object.

Since:

1.5r1

setCodeType

public void setCodeType(java.lang.String value)

Sets the value of the CodeType attribute.

The SIF specification defines the meaning of this attribute as: "if CodeType is "NCES" then the codes used is NCES 0273 Student Support Service Type [NCES Handbooks] or 0274 Student/Family Program Type [NCES Handbooks], depending on the value of the Type attribute"

Parameters:

value - A String object

Since:

1.5r1

getCode

public java.lang.String getCode()

Gets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "Specialized instruction or related / transitional service provided to this student."

Returns:

The Code element of this object.

Since:

1.5r1

setCode

public void setCode(ServiceCode value)

Sets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "Specialized instruction or related / transitional service provided to this student."

Parameters:

value - A constant defined by the ServiceCode class

Since:

1.5r1

setCode

public void setCode(java.lang.String value)

Sets the value of the <Code> element as a String.

The SIF specification defines the meaning of this element as: "Specialized instruction or related / transitional service provided to this student."

Parameters:

value - The value as a String

Since:

1.5r1

setOtherCodeList

public void setOtherCodeList(OtherCodeList value)

Sets the value of the <OtherCodeList> element.

Parameters:

value - A OtherCodeList object

Since:

2.0

getOtherCodeList

public OtherCodeList getOtherCodeList()

Gets the value of the <OtherCodeList> element.

Returns:

An OtherCodeList object

Since:

2.0

removeOtherCodeList

public void removeOtherCodeList()

Removes the OtherCodeList child element previously created by calling setOtherCodeList

Since:

2.0

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Values: InstructionalService, RelatedService, Other"

Returns:

The Type attribute of this object.

Since:

1.5r1

setType

public void setType(ServiceTypeValue value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Values: InstructionalService, RelatedService, Other"

Parameters:

value - A constant defined by the ServiceTypeValue class

Since:

1.5r1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "Values: InstructionalService, RelatedService, Other"

Parameters:

value - The value as a String

Since:

1.5r1