com.edustructures.sifworks.instr
Class ResourceEvaluation

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.instr.ResourceEvaluation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ResourceEvaluation
extends SIFKeyedElement

Evaluations/reviews of resource.

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

ResourceEvaluation()
Constructor

ResourceEvaluation(java.lang.String evaluationRefId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
java.util.Calendar	getEvaluationDate() Gets the value of the <EvaluationDate> element.
java.lang.String	getEvaluationRefId() Gets the value of the EvaluationRefId 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
Name	getName() Gets the value of the <Name> element.
void	removeName() Removes the Name child element previously created by calling setName
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setEvaluationDate(java.util.Calendar value) Sets the value of the <EvaluationDate> element.
void	setEvaluationRefId(java.lang.String value) Sets the value of the EvaluationRefId attribute.
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.

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

ResourceEvaluation

public ResourceEvaluation()

Constructor

ResourceEvaluation

public ResourceEvaluation(java.lang.String evaluationRefId)

Constructor that accepts values for all mandatory fields

Parameters:

evaluationRefId - GUID assigned to an evaluation.

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

getEvaluationRefId

public java.lang.String getEvaluationRefId()

Gets the value of the EvaluationRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID assigned to an evaluation."

Returns:

The EvaluationRefId attribute of this object.

Since:

1.5r1

setEvaluationRefId

public void setEvaluationRefId(java.lang.String value)

Sets the value of the EvaluationRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID assigned to an evaluation."

Parameters:

value - A String 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: "Description of evaluation of resource."

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: "Description of evaluation of resource."

Parameters:

value - A String object

Since:

1.5r1

getEvaluationDate

public java.util.Calendar getEvaluationDate()

Gets the value of the <EvaluationDate> element.

The SIF specification defines the meaning of this element as: "Date evaluation was performed"

Returns:

The EvaluationDate element of this object.

Since:

1.5r1

setEvaluationDate

public void setEvaluationDate(java.util.Calendar value)

Sets the value of the <EvaluationDate> element.

The SIF specification defines the meaning of this element as: "Date evaluation was performed"

Parameters:

value - A Calendar object

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: "Name of individual who submitted evaluation."

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: "Name of individual who submitted evaluation."

Returns:

A Name object

Since:

1.5r1

removeName

public void removeName()

Removes the Name child element previously created by calling setName

Since:

1.5r1