com.edustructures.sifworks.datamodel
Class Creators

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Creator>
                  com.edustructures.sifworks.datamodel.Creators

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Creator>, java.util.Collection<Creator>

public class Creators
extends SIFKeyedList<Creator>

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

Creators()
Constructor

Creators(Creator creator)
Constructor that accepts values for all mandatory fields

Method Summary

void	addCreator(java.lang.String name, java.lang.String id) Adds a new <Creator> repeatable element.
Creator	getCreator(java.lang.String id) Gets a Creator object instance.
Creator[]	getCreators() Gets all Creator object instances.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
void	removeCreator(java.lang.String id) Removes a Creator object instance.
void	setCreators(Creator[] creators) Sets an array of Creator objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

Creators

public Creators()

Constructor

Creators

public Creators(Creator creator)

Constructor that accepts values for all mandatory fields

Parameters:

creator -

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

addCreator

public void addCreator(java.lang.String name,
                       java.lang.String id)

Adds a new <Creator> repeatable element. This form of setCreator is provided as a convenience method that is functionally equivalent to the version of setCreator that accepts a single Creator object.

Parameters:

name - Human-readable name of the data's creator. If the object contains system-generated data, the name should identify the creating service or application.

id - Unique identifier of the creator. An email address or URI could be used here.

Since:

2.0

removeCreator

public void removeCreator(java.lang.String id)

Removes a Creator object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

id - Identifies the Creator object to remove by its ID value

Since:

2.0

getCreator

public Creator getCreator(java.lang.String id)

Gets a Creator object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

id - Identifies the Creator object to return by its "ID" attribute value

Returns:

A Creator object

Since:

2.0

getCreators

public Creator[] getCreators()

Gets all Creator object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of Creator objects

Since:

2.0

setCreators

public void setCreators(Creator[] creators)

Sets an array of Creator objects. All existing Creator instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all Creators.

Since:

2.0