com.edustructures.sifworks.profdev
Class ProfessionalDevelopmentActivities

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.profdev.ProfessionalDevelopmentActivities

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ProfessionalDevelopmentActivities
extends SIFDataObject

This object contains information about courses and activities for which employees can earn credits or hours to maintain their certification. 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

ProfessionalDevelopmentActivities()
Constructor

ProfessionalDevelopmentActivities(java.lang.String refId, java.lang.String activityProviderRefId, java.lang.String localId, java.util.Calendar startDate, java.util.Calendar endDate, java.lang.String description, java.math.BigDecimal clockHours)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getActivityProviderRefId() Gets the value of the ActivityProviderRefId attribute.
java.math.BigDecimal	getClockHours() Gets the value of the <ClockHours> element.
java.math.BigDecimal	getCredits() Gets the value of the <Credits> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
java.util.Calendar	getEndDate() Gets the value of the <EndDate> 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.lang.String	getLocalId() Gets the value of the <LocalId> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.util.Calendar	getStartDate() Gets the value of the <StartDate> element.
void	setActivityProviderRefId(java.lang.String value) Sets the value of the ActivityProviderRefId attribute.
void	setClockHours(java.math.BigDecimal value) Sets the value of the <ClockHours> element.
void	setCredits(java.math.BigDecimal value) Sets the value of the <Credits> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setEndDate(java.util.Calendar value) Sets the value of the <EndDate> element.
void	setLocalId(java.lang.String value) Sets the value of the <LocalId> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> 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

ProfessionalDevelopmentActivities

public ProfessionalDevelopmentActivities()

Constructor

ProfessionalDevelopmentActivities

public ProfessionalDevelopmentActivities(java.lang.String refId,
                                         java.lang.String activityProviderRefId,
                                         java.lang.String localId,
                                         java.util.Calendar startDate,
                                         java.util.Calendar endDate,
                                         java.lang.String description,
                                         java.math.BigDecimal clockHours)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID for this object.

activityProviderRefId - References the ActivityProvider object

localId - Locally assigned number or provider referenced course number used to represent the course or activity

startDate - The starting date of the course or activity

endDate - The ending date of the course or activity

description - The description of the course or activity

clockHours - The actual number of hours required for the course or activity

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: "GUID for this object."

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: "GUID for this object."

Parameters:

value - A String object

Since:

1.5r1

getActivityProviderRefId

public java.lang.String getActivityProviderRefId()

Gets the value of the ActivityProviderRefId attribute.

The SIF specification defines the meaning of this attribute as: "References the ActivityProvider object"

Returns:

The ActivityProviderRefId attribute of this object.

Since:

1.5r1

setActivityProviderRefId

public void setActivityProviderRefId(java.lang.String value)

Sets the value of the ActivityProviderRefId attribute.

The SIF specification defines the meaning of this attribute as: "References the ActivityProvider object"

Parameters:

value - A String object

Since:

1.5r1

getLocalId

public java.lang.String getLocalId()

Gets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "Locally assigned number or provider referenced course number used to represent the course or activity"

Returns:

The LocalId element of this object.

Since:

1.5r1

setLocalId

public void setLocalId(java.lang.String value)

Sets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "Locally assigned number or provider referenced course number used to represent the course or activity"

Parameters:

value - A String object

Since:

1.5r1

getStartDate

public java.util.Calendar getStartDate()

Gets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "The starting date of the course or activity"

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: "The starting date of the course or activity"

Parameters:

value - A Calendar object

Since:

1.5r1

getEndDate

public java.util.Calendar getEndDate()

Gets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "The ending date of the course or activity"

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: "The ending date of the course or activity"

Parameters:

value - A Calendar object

Since:

1.5r1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "The description of the course or activity"

Returns:

The Description element of this object.

Since:

1.5r1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "The description of the course or activity"

Parameters:

value - A String object

Since:

1.5r1

getClockHours

public java.math.BigDecimal getClockHours()

Gets the value of the <ClockHours> element.

The SIF specification defines the meaning of this element as: "The actual number of hours required for the course or activity"

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	"ClockHrs"
SIF2.0	"ClockHours"

Returns:

The ClockHours element of this object.

Since:

1.5r1

setClockHours

public void setClockHours(java.math.BigDecimal value)

Sets the value of the <ClockHours> element.

The SIF specification defines the meaning of this element as: "The actual number of hours required for the course or activity"

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	"ClockHrs"
SIF2.0	"ClockHours"

Parameters:

value - A BigDecimal object

Since:

1.5r1

getCredits

public java.math.BigDecimal getCredits()

Gets the value of the <Credits> element.

The SIF specification defines the meaning of this element as: "Number of credits that can be earned by completing the course or activity."

Returns:

The Credits element of this object.

Since:

1.5r1

setCredits

public void setCredits(java.math.BigDecimal value)

Sets the value of the <Credits> element.

The SIF specification defines the meaning of this element as: "Number of credits that can be earned by completing the course or activity."

Parameters:

value - A BigDecimal object

Since:

1.5r1