com.edustructures.sifworks.gradebook
Class CreationUser

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.gradebook.CreationUser

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreationUser
extends SIFKeyedElement

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

CreationUser()
Constructor

CreationUser(AuditInfoType type, java.lang.String userId)
Constructor that accepts values for all mandatory fields

Method Summary

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	getType() Gets the value of the Type attribute.
java.lang.String	getUserId() Gets the value of the <UserId> element.
void	setType(AuditInfoType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.
void	setUserId(java.lang.String value) Sets the value of the <UserId> 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

CreationUser

public CreationUser()

Constructor

CreationUser

public CreationUser(AuditInfoType type,
                    java.lang.String userId)

Constructor that accepts values for all mandatory fields

Parameters:

type - The role of the staff member for that created this attendance record.

userId - Unique identifier of the user that created the attendance record. This will depend on the user and the source. The preferred identifier would be a RefId for a StaffPersonal, StudentContact, or StudentPersonal Object. However, the user may not be associated with any of these SIF objects. In that case a unique ID given by the source should be used.

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "The role of the staff member for that created this attendance record."

Returns:

The Type attribute of this object.

Since:

2.0

setType

public void setType(AuditInfoType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "The role of the staff member for that created this attendance record."

Parameters:

value - A constant defined by the AuditInfoType class

Since:

2.0

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: "The role of the staff member for that created this attendance record."

Parameters:

value - The value as a String

Since:

2.0

getUserId

public java.lang.String getUserId()

Gets the value of the <UserId> element.

The SIF specification defines the meaning of this element as: "Unique identifier of the user that created the attendance record. This will depend on the user and the source. The preferred identifier would be a RefId for a StaffPersonal, StudentContact, or StudentPersonal Object. However, the user may not be associated with any of these SIF objects. In that case a unique ID given by the source should be used."

Returns:

The UserId element of this object.

Since:

2.0

setUserId

public void setUserId(java.lang.String value)

Sets the value of the <UserId> element.

The SIF specification defines the meaning of this element as: "Unique identifier of the user that created the attendance record. This will depend on the user and the source. The preferred identifier would be a RefId for a StaffPersonal, StudentContact, or StudentPersonal Object. However, the user may not be associated with any of these SIF objects. In that case a unique ID given by the source should be used."

Parameters:

value - A String object

Since:

2.0