com.edustructures.sifworks.instr
Class Authors

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Author>
                  com.edustructures.sifworks.instr.Authors

All Implemented Interfaces:

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

public class Authors
extends SIFKeyedList<Author>

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

Authors()
Constructor

Authors(Author author)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAuthor(java.lang.String value) Adds a new <Author> repeatable element.
Author	getAuthor(java.lang.String value) Gets an Author object instance.
Author[]	getAuthors() Gets all Author object instances.
void	removeAuthor(java.lang.String value) Removes an Author object instance.
void	setAuthors(Author[] authors) Sets an array of Author 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, getKey, 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

Authors

public Authors()

Constructor

Authors

public Authors(Author author)

Constructor that accepts values for all mandatory fields

Parameters:

author - Name of the organization that authored the standards document, i.e. "Mid-Continent Research for Education & Learning (McREL)." May be the same as "Organization" above.

Method Detail

addAuthor

public void addAuthor(java.lang.String value)

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

Parameters:

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

Since:

2.0

removeAuthor

public void removeAuthor(java.lang.String value)

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

Parameters:

value - Identifies the Author object to remove by its Value value

Since:

2.0

getAuthor

public Author getAuthor(java.lang.String value)

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

Parameters:

value - Identifies the Author object to return by its "Value" attribute value

Returns:

An Author object

Since:

2.0

getAuthors

public Author[] getAuthors()

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

Returns:

An array of Author objects

Since:

2.0

setAuthors

public void setAuthors(Author[] authors)

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

Since:

2.0