com.edustructures.sifworks.programs
Class StudentPlacement

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.programs.StudentPlacement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentPlacement
extends SIFDataObject

This object contains information specific to support programs in which students have been placed. SIF_Events are reported.

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

StudentPlacement()
Constructor

StudentPlacement(java.lang.String refId, java.lang.String studentParticipationRefId, java.lang.String studentPersonalRefId, Service service)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getAgencyType() Gets the value of the <AgencyType> element.
java.lang.Boolean	getAssistiveTechnology() Gets the value of the <AssistiveTechnology> element.
TimeUnit	getDirectTime() Gets the value of the <DirectTime> element.
java.util.Calendar	getEndDate() Gets the value of the <EndDate> element.
java.lang.String	getEntryPerson() Gets the value of the <EntryPerson> element.
FrequencyTime	getFrequencyTime() Gets the value of the <FrequencyTime> element.
java.lang.Boolean	getIncludedInSpecialEducationFTE() Gets the value of the <IncludedInSpecialEducationFTE> element.
TimeUnit	getIndirectTime() Gets the value of the <IndirectTime> 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
java.util.Calendar	getLatestStartDate() Gets the value of the <LatestStartDate> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
SIF_RefId	getSchoolWhereServiceDelivered() Gets the value of the <SchoolWhereServiceDelivered> element.
Service	getService() Gets the value of the <Service> element.
java.lang.String	getServiceCategory() Gets the value of the <ServiceCategory> element.
ServiceFundingSources	getServiceFundingSources() Gets the value of the <ServiceFundingSources> element.
java.lang.String	getServiceProviderAgency() Gets the value of the <ServiceProviderAgency> element.
java.lang.String	getServiceProviderName() Gets the value of the <ServiceProviderName> element.
ServiceProviderType	getServiceProviderType() Gets the value of the <ServiceProviderType> element.
ServiceSetting	getServiceSetting() Gets the value of the <ServiceSetting> element.
SIF_RefId	getServicingPublicAgency() Gets the value of the <ServicingPublicAgency> element.
SIF_RefId	getServicingSchool() Gets the value of the <ServicingSchool> element.
java.lang.Boolean	getSpecialNeedsTransportation() Gets the value of the <SpecialNeedsTransportation> element.
java.util.Calendar	getStartDate() Gets the value of the <StartDate> element.
java.lang.String	getStudentParticipationRefId() Gets the value of the StudentParticipationRefId attribute.
java.lang.String	getStudentPersonalRefId() Gets the value of the StudentPersonalRefId attribute.
java.util.Calendar	getStudentPlacementAsOfDate() Gets the value of the <StudentPlacementAsOfDate> element.
TimeUnit	getTotalServiceDuration() Gets the value of the <TotalServiceDuration> element.
ProgramAvailability	getWhenServiceProvided() Gets the value of the <WhenServiceProvided> element.
void	removeDirectTime() Removes the DirectTime child element previously created by calling setDirectTime
void	removeFrequencyTime() Removes the FrequencyTime child element previously created by calling setFrequencyTime
void	removeIndirectTime() Removes the IndirectTime child element previously created by calling setIndirectTime
void	removeSchoolWhereServiceDelivered() Removes the SchoolWhereServiceDelivered child element previously created by calling setSchoolWhereServiceDelivered
void	removeService() Removes the Service child element previously created by calling setService
void	removeServiceFundingSources() Removes the ServiceFundingSources child element previously created by calling setServiceFundingSources
void	removeServiceProviderType() Removes the ServiceProviderType child element previously created by calling setServiceProviderType
void	removeServiceSetting() Removes the ServiceSetting child element previously created by calling setServiceSetting
void	removeServicingPublicAgency() Removes the ServicingPublicAgency child element previously created by calling setServicingPublicAgency
void	removeServicingSchool() Removes the ServicingSchool child element previously created by calling setServicingSchool
void	removeTotalServiceDuration() Removes the TotalServiceDuration child element previously created by calling setTotalServiceDuration
void	removeWhenServiceProvided() Removes the WhenServiceProvided child element previously created by calling setWhenServiceProvided
void	setAgencyType(java.lang.String value) Sets the value of the <AgencyType> element.
void	setAssistiveTechnology(java.lang.Boolean value) Sets the value of the <AssistiveTechnology> element.
void	setDirectTime(DurationUnit unitOfMeasure, java.math.BigDecimal value) Sets the value of the <DirectTime> child element.
void	setDirectTime(TimeUnit value) Sets the value of the <DirectTime> element.
void	setEndDate(java.util.Calendar value) Sets the value of the <EndDate> element.
void	setEntryPerson(java.lang.String value) Sets the value of the <EntryPerson> element.
void	setFrequencyTime(FrequencyTime value) Sets the value of the <FrequencyTime> element.
void	setIncludedInSpecialEducationFTE(java.lang.Boolean value) Sets the value of the <IncludedInSpecialEducationFTE> element.
void	setIndirectTime(DurationUnit unitOfMeasure, java.math.BigDecimal value) Sets the value of the <IndirectTime> child element.
void	setIndirectTime(TimeUnit value) Sets the value of the <IndirectTime> element.
void	setLatestStartDate(java.util.Calendar value) Sets the value of the <LatestStartDate> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSchoolWhereServiceDelivered(SIF_RefId value) Sets the value of the <SchoolWhereServiceDelivered> element.
void	setSchoolWhereServiceDelivered(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <SchoolWhereServiceDelivered> child element.
void	setService(Service value) Sets the value of the <Service> element.
void	setService(java.lang.String codeType, ServiceCode code, ServiceTypeValue type) Sets the value of the <Service> child element.
void	setServiceCategory(ServiceCategory value) Sets the value of the <ServiceCategory> element.
void	setServiceCategory(java.lang.String value) Sets the value of the <ServiceCategory> element as a String.
void	setServiceFundingSources(ServiceFundingSources value) Sets the value of the <ServiceFundingSources> element.
void	setServiceProviderAgency(java.lang.String value) Sets the value of the <ServiceProviderAgency> element.
void	setServiceProviderName(java.lang.String value) Sets the value of the <ServiceProviderName> element.
void	setServiceProviderType(ServiceProviderType value) Sets the value of the <ServiceProviderType> element.
void	setServiceSetting(ServiceSetting value) Sets the value of the <ServiceSetting> element.
void	setServiceSetting(java.lang.String codeType, ServiceSettingCode code) Sets the value of the <ServiceSetting> child element.
void	setServicingPublicAgency(SIF_RefId value) Sets the value of the <ServicingPublicAgency> element.
void	setServicingPublicAgency(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <ServicingPublicAgency> child element.
void	setServicingSchool(SIF_RefId value) Sets the value of the <ServicingSchool> element.
void	setServicingSchool(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <ServicingSchool> child element.
void	setSpecialNeedsTransportation(java.lang.Boolean value) Sets the value of the <SpecialNeedsTransportation> element.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> element.
void	setStudentParticipationRefId(java.lang.String value) Sets the value of the StudentParticipationRefId attribute.
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the StudentPersonalRefId attribute.
void	setStudentPlacementAsOfDate(java.util.Calendar value) Sets the value of the <StudentPlacementAsOfDate> element.
void	setTotalServiceDuration(DurationUnit unitOfMeasure, java.math.BigDecimal value) Sets the value of the <TotalServiceDuration> child element.
void	setTotalServiceDuration(TimeUnit value) Sets the value of the <TotalServiceDuration> element.
void	setWhenServiceProvided(ProgramAvailability value) Sets the value of the <WhenServiceProvided> element.
void	setWhenServiceProvided(ProgramAvailabilityCode code) Sets the value of the <WhenServiceProvided> child element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

StudentPlacement

public StudentPlacement()

Constructor

StudentPlacement

public StudentPlacement(java.lang.String refId,
                        java.lang.String studentParticipationRefId,
                        java.lang.String studentPersonalRefId,
                        Service service)

Constructor that accepts values for all mandatory fields

Parameters:

refId - This is the unique identification code

studentParticipationRefId - This is the reference code for student eligibility for participation

studentPersonalRefId - The GUID of the student that this object is linked to.

service - Specialized instruction or related service provided to this student.

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "This is the unique identification code"

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "This is the unique identification code"

Parameters:

value - A String object

Since:

1.5r1

getStudentParticipationRefId

public java.lang.String getStudentParticipationRefId()

Gets the value of the StudentParticipationRefId attribute.

The SIF specification defines the meaning of this attribute as: "This is the reference code for student eligibility for participation"

Returns:

The StudentParticipationRefId attribute of this object.

Since:

1.5r1

setStudentParticipationRefId

public void setStudentParticipationRefId(java.lang.String value)

Sets the value of the StudentParticipationRefId attribute.

The SIF specification defines the meaning of this attribute as: "This is the reference code for student eligibility for participation"

Parameters:

value - A String object

Since:

1.5r1

getStudentPersonalRefId

public java.lang.String getStudentPersonalRefId()

Gets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of the student that this object is linked to."

Returns:

The StudentPersonalRefId attribute of this object.

Since:

1.5r1

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)

Sets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of the student that this object is linked to."

Parameters:

value - A String object

Since:

1.5r1

setService

public void setService(Service value)

Sets the value of the <Service> element.

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

Parameters:

value - A Service object

Since:

1.5r1

setService

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

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

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

Since:

1.5r1

getService

public Service getService()

Gets the value of the <Service> element.

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

Returns:

A Service object

Since:

1.5r1

removeService

public void removeService()

Removes the Service child element previously created by calling setService

Since:

1.5r1

getStudentPlacementAsOfDate

public java.util.Calendar getStudentPlacementAsOfDate()

Gets the value of the <StudentPlacementAsOfDate> element.

The SIF specification defines the meaning of this element as: "Effective date (NOT the entry date) of this StudentParticipation instance for the identified student and program. It is intended that each time the contents of this instance of the object changes, it will be published with a new RefId."

Returns:

The StudentPlacementAsOfDate element of this object.

Since:

2.0

setStudentPlacementAsOfDate

public void setStudentPlacementAsOfDate(java.util.Calendar value)

Sets the value of the <StudentPlacementAsOfDate> element.

The SIF specification defines the meaning of this element as: "Effective date (NOT the entry date) of this StudentParticipation instance for the identified student and program. It is intended that each time the contents of this instance of the object changes, it will be published with a new RefId."

Parameters:

value - A Calendar object

Since:

2.0

getServiceProviderAgency

public java.lang.String getServiceProviderAgency()

Gets the value of the <ServiceProviderAgency> element.

The SIF specification defines the meaning of this element as: "Service provider title (such as Physical Therapist or Psychologist), agency (such as Clinic), or local code (ID number of clinic)."

Returns:

The ServiceProviderAgency element of this object.

Since:

1.5r1

setServiceProviderAgency

public void setServiceProviderAgency(java.lang.String value)

Sets the value of the <ServiceProviderAgency> element.

The SIF specification defines the meaning of this element as: "Service provider title (such as Physical Therapist or Psychologist), agency (such as Clinic), or local code (ID number of clinic)."

Parameters:

value - A String object

Since:

1.5r1

getServiceProviderName

public java.lang.String getServiceProviderName()

Gets the value of the <ServiceProviderName> element.

The SIF specification defines the meaning of this element as: "The name of the person who delivers the service."

Returns:

The ServiceProviderName element of this object.

Since:

1.5r1

setServiceProviderName

public void setServiceProviderName(java.lang.String value)

Sets the value of the <ServiceProviderName> element.

The SIF specification defines the meaning of this element as: "The name of the person who delivers the service."

Parameters:

value - A String object

Since:

1.5r1

getServiceCategory

public java.lang.String getServiceCategory()

Gets the value of the <ServiceCategory> element.

The SIF specification defines the meaning of this element as: "Category of service (for example, whether it is instruction or a related / transitional service or a supplemental service). Typically designated by a state."

Returns:

The ServiceCategory element of this object.

Since:

2.0

setServiceCategory

public void setServiceCategory(ServiceCategory value)

Sets the value of the <ServiceCategory> element.

The SIF specification defines the meaning of this element as: "Category of service (for example, whether it is instruction or a related / transitional service or a supplemental service). Typically designated by a state."

Parameters:

value - A constant defined by the ServiceCategory class

Since:

2.0

setServiceCategory

public void setServiceCategory(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Category of service (for example, whether it is instruction or a related / transitional service or a supplemental service). Typically designated by a state."

Parameters:

value - The value as a String

Since:

2.0

setServiceSetting

public void setServiceSetting(ServiceSetting value)

Sets the value of the <ServiceSetting> element.

The SIF specification defines the meaning of this element as: "Location where service is provided (Regular Class, Resource Room, Homebound, Detention Center, etc.)"

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	"ServiceLocation"
SIF2.0	"ServiceSetting"

Parameters:

value - A ServiceSetting object

Since:

1.5r1

setServiceSetting

public void setServiceSetting(java.lang.String codeType,
                              ServiceSettingCode code)

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

Parameters:

codeType - If CodeType = "NCES" Then use Code set 0307 Service Setting [NCES Handbooks]

code - Setting where service is provided (Regular Class, Resource Room, Homebound, Detention Center, etc.).

Since:

1.5r1

getServiceSetting

public ServiceSetting getServiceSetting()

Gets the value of the <ServiceSetting> element.

The SIF specification defines the meaning of this element as: "Location where service is provided (Regular Class, Resource Room, Homebound, Detention Center, etc.)"

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	"ServiceLocation"
SIF2.0	"ServiceSetting"

Returns:

A ServiceSetting object

Since:

1.5r1

removeServiceSetting

public void removeServiceSetting()

Removes the ServiceSetting child element previously created by calling setServiceSetting

Since:

1.5r1

setServiceFundingSources

public void setServiceFundingSources(ServiceFundingSources value)

Sets the value of the <ServiceFundingSources> element.

Parameters:

value - A ServiceFundingSources object

Since:

2.0

getServiceFundingSources

public ServiceFundingSources getServiceFundingSources()

Gets the value of the <ServiceFundingSources> element.

Returns:

A ServiceFundingSources object

Since:

2.0

removeServiceFundingSources

public void removeServiceFundingSources()

Removes the ServiceFundingSources child element previously created by calling setServiceFundingSources

Since:

2.0

getStartDate

public java.util.Calendar getStartDate()

Gets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Actual date this service began for this student."

Returns:

The StartDate element of this object.

Since:

1.5r1

setStartDate

public void setStartDate(java.util.Calendar value)

Sets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Actual date this service began for this student."

Parameters:

value - A Calendar object

Since:

1.5r1

setServicingPublicAgency

public void setServicingPublicAgency(SIF_RefId value)

Sets the value of the <ServicingPublicAgency> element.

Parameters:

value - A SIF_RefId object

Since:

2.0

setServicingPublicAgency

public void setServicingPublicAgency(java.lang.String sifRefObject,
                                     java.lang.String value)

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

Parameters:

sifRefObject -

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

Since:

2.0

getServicingPublicAgency

public SIF_RefId getServicingPublicAgency()

Gets the value of the <ServicingPublicAgency> element.

Returns:

A SIF_RefId object

Since:

2.0

removeServicingPublicAgency

public void removeServicingPublicAgency()

Removes the ServicingPublicAgency child element previously created by calling setServicingPublicAgency

Since:

2.0

getEndDate

public java.util.Calendar getEndDate()

Gets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "Actual date this service ended for this student."

Returns:

The EndDate element of this object.

Since:

1.5r1

setEndDate

public void setEndDate(java.util.Calendar value)

Sets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "Actual date this service ended for this student."

Parameters:

value - A Calendar object

Since:

1.5r1

setServicingSchool

public void setServicingSchool(SIF_RefId value)

Sets the value of the <ServicingSchool> element.

Parameters:

value - A SIF_RefId object

Since:

2.0

setServicingSchool

public void setServicingSchool(java.lang.String sifRefObject,
                               java.lang.String value)

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

Parameters:

sifRefObject -

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

Since:

2.0

getServicingSchool

public SIF_RefId getServicingSchool()

Gets the value of the <ServicingSchool> element.

Returns:

A SIF_RefId object

Since:

2.0

removeServicingSchool

public void removeServicingSchool()

Removes the ServicingSchool child element previously created by calling setServicingSchool

Since:

2.0

setFrequencyTime

public void setFrequencyTime(FrequencyTime value)

Sets the value of the <FrequencyTime> element.

The SIF specification defines the meaning of this element as: "Code or text descriptor of the frequency that the service is provided, such as "once a week", "MWF", or "05" (code representing "every Friday")"

Parameters:

value - A FrequencyTime object

Since:

1.5r1

getFrequencyTime

public FrequencyTime getFrequencyTime()

Gets the value of the <FrequencyTime> element.

The SIF specification defines the meaning of this element as: "Code or text descriptor of the frequency that the service is provided, such as "once a week", "MWF", or "05" (code representing "every Friday")"

Returns:

A FrequencyTime object

Since:

1.5r1

removeFrequencyTime

public void removeFrequencyTime()

Removes the FrequencyTime child element previously created by calling setFrequencyTime

Since:

1.5r1

setSchoolWhereServiceDelivered

public void setSchoolWhereServiceDelivered(SIF_RefId value)

Sets the value of the <SchoolWhereServiceDelivered> element.

Parameters:

value - A SIF_RefId object

Since:

2.0

setSchoolWhereServiceDelivered

public void setSchoolWhereServiceDelivered(java.lang.String sifRefObject,
                                           java.lang.String value)

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

Parameters:

sifRefObject -

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

Since:

2.0

getSchoolWhereServiceDelivered

public SIF_RefId getSchoolWhereServiceDelivered()

Gets the value of the <SchoolWhereServiceDelivered> element.

Returns:

A SIF_RefId object

Since:

2.0

removeSchoolWhereServiceDelivered

public void removeSchoolWhereServiceDelivered()

Removes the SchoolWhereServiceDelivered child element previously created by calling setSchoolWhereServiceDelivered

Since:

2.0

setDirectTime

public void setDirectTime(TimeUnit value)

Sets the value of the <DirectTime> element.

The SIF specification defines the meaning of this element as: "Number of units of time per session spent directly providing the service to the student."

Parameters:

value - A TimeUnit object

Since:

1.5r1

setDirectTime

public void setDirectTime(DurationUnit unitOfMeasure,
                          java.math.BigDecimal value)

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

Parameters:

unitOfMeasure - Identifies unit of measure in which amount of time is expressed.

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

Since:

1.5r1

getDirectTime

public TimeUnit getDirectTime()

Gets the value of the <DirectTime> element.

The SIF specification defines the meaning of this element as: "Number of units of time per session spent directly providing the service to the student."

Returns:

A TimeUnit object

Since:

1.5r1

removeDirectTime

public void removeDirectTime()

Removes the DirectTime child element previously created by calling setDirectTime

Since:

1.5r1

setServiceProviderType

public void setServiceProviderType(ServiceProviderType value)

Sets the value of the <ServiceProviderType> element.

Parameters:

value - A ServiceProviderType object

Since:

2.0

getServiceProviderType

public ServiceProviderType getServiceProviderType()

Gets the value of the <ServiceProviderType> element.

Returns:

A ServiceProviderType object

Since:

2.0

removeServiceProviderType

public void removeServiceProviderType()

Removes the ServiceProviderType child element previously created by calling setServiceProviderType

Since:

2.0

getAgencyType

public java.lang.String getAgencyType()

Gets the value of the <AgencyType> element.

The SIF specification defines the meaning of this element as: "Identifies an agency or clinic that will provide the specified service."

Returns:

The AgencyType element of this object.

Since:

2.0

setAgencyType

public void setAgencyType(java.lang.String value)

Sets the value of the <AgencyType> element.

The SIF specification defines the meaning of this element as: "Identifies an agency or clinic that will provide the specified service."

Parameters:

value - A String object

Since:

2.0

setIndirectTime

public void setIndirectTime(TimeUnit value)

Sets the value of the <IndirectTime> element.

The SIF specification defines the meaning of this element as: "Number of units of time per session NOT spent directly providing the service to the student but rather spent providing consultation services to someone related to the student (e.g. parent, a general ed teacher, a new service provider, etc.)."

Parameters:

value - A TimeUnit object

Since:

1.5r1

setIndirectTime

public void setIndirectTime(DurationUnit unitOfMeasure,
                            java.math.BigDecimal value)

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

Parameters:

unitOfMeasure - Identifies unit of measure in which amount of time is expressed.

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

Since:

1.5r1

getIndirectTime

public TimeUnit getIndirectTime()

Gets the value of the <IndirectTime> element.

The SIF specification defines the meaning of this element as: "Number of units of time per session NOT spent directly providing the service to the student but rather spent providing consultation services to someone related to the student (e.g. parent, a general ed teacher, a new service provider, etc.)."

Returns:

A TimeUnit object

Since:

1.5r1

removeIndirectTime

public void removeIndirectTime()

Removes the IndirectTime child element previously created by calling setIndirectTime

Since:

1.5r1

setTotalServiceDuration

public void setTotalServiceDuration(TimeUnit value)

Sets the value of the <TotalServiceDuration> element.

The SIF specification defines the meaning of this element as: "Total of the direct and indirect time as it relates to the FrequencyTime; e.g., DirectTime 60 + IndirectTime 30 = 90."

Parameters:

value - A TimeUnit object

Since:

1.5r1

setTotalServiceDuration

public void setTotalServiceDuration(DurationUnit unitOfMeasure,
                                    java.math.BigDecimal value)

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

Parameters:

unitOfMeasure - Identifies unit of measure in which amount of time is expressed.

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

Since:

1.5r1

getTotalServiceDuration

public TimeUnit getTotalServiceDuration()

Gets the value of the <TotalServiceDuration> element.

The SIF specification defines the meaning of this element as: "Total of the direct and indirect time as it relates to the FrequencyTime; e.g., DirectTime 60 + IndirectTime 30 = 90."

Returns:

A TimeUnit object

Since:

1.5r1

removeTotalServiceDuration

public void removeTotalServiceDuration()

Removes the TotalServiceDuration child element previously created by calling setTotalServiceDuration

Since:

1.5r1

getSpecialNeedsTransportation

public java.lang.Boolean getSpecialNeedsTransportation()

Gets the value of the <SpecialNeedsTransportation> element.

The SIF specification defines the meaning of this element as: "Indicates whether the student requires transportation to the location of Placement/Service."

Returns:

The SpecialNeedsTransportation element of this object.

Since:

1.5r1

setSpecialNeedsTransportation

public void setSpecialNeedsTransportation(java.lang.Boolean value)

Sets the value of the <SpecialNeedsTransportation> element.

The SIF specification defines the meaning of this element as: "Indicates whether the student requires transportation to the location of Placement/Service."

Parameters:

value - A Boolean object

Since:

1.5r1

setWhenServiceProvided

public void setWhenServiceProvided(ProgramAvailability value)

Sets the value of the <WhenServiceProvided> element.

Parameters:

value - A ProgramAvailability object

Since:

2.0

setWhenServiceProvided

public void setWhenServiceProvided(ProgramAvailabilityCode code)

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

Parameters:

code - Describes the availability of the program.

Since:

2.0

getWhenServiceProvided

public ProgramAvailability getWhenServiceProvided()

Gets the value of the <WhenServiceProvided> element.

Returns:

A ProgramAvailability object

Since:

2.0

removeWhenServiceProvided

public void removeWhenServiceProvided()

Removes the WhenServiceProvided child element previously created by calling setWhenServiceProvided

Since:

2.0

getAssistiveTechnology

public java.lang.Boolean getAssistiveTechnology()

Gets the value of the <AssistiveTechnology> element.

The SIF specification defines the meaning of this element as: "Indicates whether the student requires assistive technology for this Placement/Service."

Returns:

The AssistiveTechnology element of this object.

Since:

1.5r1

setAssistiveTechnology

public void setAssistiveTechnology(java.lang.Boolean value)

Sets the value of the <AssistiveTechnology> element.

The SIF specification defines the meaning of this element as: "Indicates whether the student requires assistive technology for this Placement/Service."

Parameters:

value - A Boolean object

Since:

1.5r1

getLatestStartDate

public java.util.Calendar getLatestStartDate()

Gets the value of the <LatestStartDate> element.

The SIF specification defines the meaning of this element as: "Date by which service is supposed to start for this student."

Returns:

The LatestStartDate element of this object.

Since:

2.0

setLatestStartDate

public void setLatestStartDate(java.util.Calendar value)

Sets the value of the <LatestStartDate> element.

The SIF specification defines the meaning of this element as: "Date by which service is supposed to start for this student."

Parameters:

value - A Calendar object

Since:

2.0

getIncludedInSpecialEducationFTE

public java.lang.Boolean getIncludedInSpecialEducationFTE()

Gets the value of the <IncludedInSpecialEducationFTE> element.

The SIF specification defines the meaning of this element as: "Indicates whether the direct time for this service is included in the calculation of a student's special education FTE."

Returns:

The IncludedInSpecialEducationFTE element of this object.

Since:

2.0

setIncludedInSpecialEducationFTE

public void setIncludedInSpecialEducationFTE(java.lang.Boolean value)

Sets the value of the <IncludedInSpecialEducationFTE> element.

The SIF specification defines the meaning of this element as: "Indicates whether the direct time for this service is included in the calculation of a student's special education FTE."

Parameters:

value - A Boolean object

Since:

2.0

getEntryPerson

public java.lang.String getEntryPerson()

Gets the value of the <EntryPerson> element.

The SIF specification defines the meaning of this element as: "Identification / name of the person who created the transaction that led to the creation of this instance of the object."

Returns:

The EntryPerson element of this object.

Since:

2.0

setEntryPerson

public void setEntryPerson(java.lang.String value)

Sets the value of the <EntryPerson> element.

The SIF specification defines the meaning of this element as: "Identification / name of the person who created the transaction that led to the creation of this instance of the object."

Parameters:

value - A String object

Since:

2.0