com.edustructures.sifworks.infra
Class SIF_OrderBy

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<SIFOrderByElement>
              com.edustructures.sifworks.infra.SIF_OrderBy

All Implemented Interfaces:

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

public class SIF_OrderBy
extends SIFList<SIFOrderByElement>

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

SIF_OrderBy()
Constructor

SIF_OrderBy(SIFOrderByElement sifElement)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Element(Topics objectName, SIFOrderBy ordering, java.lang.String value) Adds a new <SIF_Element> repeatable 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
SIFOrderByElement	getSIF_Element(Topics objectName, SIFOrderBy ordering) Gets a SIFOrderByElement object instance.
SIFOrderByElement[]	getSIF_Elements() Gets all SIFOrderByElement object instances.
void	removeSIF_Element(Topics objectName, SIFOrderBy ordering) Removes a SIFOrderByElement object instance.
void	setSIF_Elements(SIFOrderByElement[] sif_elements) Sets an array of SIFOrderByElement objects.

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, 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

SIF_OrderBy

public SIF_OrderBy()

Constructor

SIF_OrderBy

public SIF_OrderBy(SIFOrderByElement sifElement)

Constructor that accepts values for all mandatory fields

Parameters:

sifElement - Indicates the element/attribute by which to sort.

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

addSIF_Element

public void addSIF_Element(Topics objectName,
                           SIFOrderBy ordering,
                           java.lang.String value)

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

Parameters:

objectName -

ordering -

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

Since:

2.0

removeSIF_Element

public void removeSIF_Element(Topics objectName,
                              SIFOrderBy ordering)

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

Parameters:

objectName - Identifies the SIFOrderByElement object to remove by its ObjectName value

ordering - Identifies the SIFOrderByElement object to remove by its Ordering value

Since:

2.0

getSIF_Element

public SIFOrderByElement getSIF_Element(Topics objectName,
                                        SIFOrderBy ordering)

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

Parameters:

objectName - Identifies the SIFOrderByElement object to return by its "ObjectName" attribute value

ordering - Identifies the SIFOrderByElement object to return by its "Ordering" attribute value

Returns:

A SIFOrderByElement object

Since:

2.0

getSIF_Elements

public SIFOrderByElement[] getSIF_Elements()

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

Returns:

An array of SIFOrderByElement objects

Since:

2.0

setSIF_Elements

public void setSIF_Elements(SIFOrderByElement[] sif_elements)

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

Since:

2.0