com.edustructures.sifworks.infra
Class SIF_RequestAccess

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SIF_Object>
                  com.edustructures.sifworks.infra.SIF_RequestAccess

All Implemented Interfaces:

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

public class SIF_RequestAccess
extends SIFKeyedList<SIF_Object>

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_RequestAccess()
Constructor

SIF_RequestAccess(SIF_Object sifObject)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Object(java.lang.String objectName) Adds a new <SIF_Object> 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
SIF_Object	getSIF_Object(java.lang.String objectName) Gets a SIF_Object object instance.
SIF_Object[]	getSIF_Objects() Gets all SIF_Object object instances.
void	removeSIF_Object(java.lang.String objectName) Removes a SIF_Object object instance.
void	setSIF_Objects(SIF_Object[] sif_objects) Sets an array of SIF_Object 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

SIF_RequestAccess

public SIF_RequestAccess()

Constructor

SIF_RequestAccess

public SIF_RequestAccess(SIF_Object sifObject)

Constructor that accepts values for all mandatory fields

Parameters:

sifObject -

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_Object

public void addSIF_Object(java.lang.String objectName)

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

Parameters:

objectName - The name of a SIF data object

Since:

2.0

removeSIF_Object

public void removeSIF_Object(java.lang.String objectName)

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

Parameters:

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

Since:

2.0

getSIF_Object

public SIF_Object getSIF_Object(java.lang.String objectName)

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

Parameters:

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

Returns:

A SIF_Object object

Since:

2.0

getSIF_Objects

public SIF_Object[] getSIF_Objects()

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

Returns:

An array of SIF_Object objects

Since:

2.0

setSIF_Objects

public void setSIF_Objects(SIF_Object[] sif_objects)

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

Since:

2.0