com.edustructures.sifworks.infra
Class SIF_Object

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFKeyedElement
              extended by com.edustructures.sifworks.infra.SIF_Object
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class SIF_Object
extends SIFKeyedElement

Since:
1.1
Version:
2.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.edustructures.sifworks.Element
CURRENT_SERIALIZE_VERSION
 
Constructor Summary
SIF_Object()
          Constructor
SIF_Object(java.lang.String objectName)
          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 getObjectName()
          Gets the value of the ObjectName attribute.
 SIF_Contexts getSIF_Contexts()
          Gets the value of the <SIF_Contexts> element.
 java.lang.Boolean getSIF_ExtendedQuerySupport()
          Gets the value of the <SIF_ExtendedQuerySupport> element.
 void removeSIF_Contexts()
          Removes the SIF_Contexts child element previously created by calling setSIF_Contexts
 void setObjectName(java.lang.String value)
          Sets the value of the ObjectName attribute.
 void setSIF_Contexts(SIF_Contexts value)
          Sets the value of the <SIF_Contexts> element.
 void setSIF_ExtendedQuerySupport(java.lang.Boolean value)
          Sets the value of the <SIF_ExtendedQuerySupport> element.
 java.lang.String toString()
          Returns the value of the ObjectName attribute
 
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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SIF_Object

public SIF_Object()
Constructor


SIF_Object

public SIF_Object(java.lang.String objectName)
Constructor that accepts values for all mandatory fields

Parameters:
objectName - The name of a SIF data object
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

getObjectName

public java.lang.String getObjectName()
Gets the value of the ObjectName attribute.

The SIF specification defines the meaning of this attribute as: "The name of a SIF data object"

Returns:
The ObjectName attribute of this object.
Since:
1.1

setObjectName

public void setObjectName(java.lang.String value)
Sets the value of the ObjectName attribute.

The SIF specification defines the meaning of this attribute as: "The name of a SIF data object"

Parameters:
value - A String object
Since:
1.1

getSIF_ExtendedQuerySupport

public java.lang.Boolean getSIF_ExtendedQuerySupport()
Gets the value of the <SIF_ExtendedQuerySupport> element.

Returns:
The SIF_ExtendedQuerySupport element of this object.
Since:
2.0

setSIF_ExtendedQuerySupport

public void setSIF_ExtendedQuerySupport(java.lang.Boolean value)
Sets the value of the <SIF_ExtendedQuerySupport> element.

Parameters:
value - A Boolean object
Since:
2.0

setSIF_Contexts

public void setSIF_Contexts(SIF_Contexts value)
Sets the value of the <SIF_Contexts> element.

Parameters:
value - A SIF_Contexts object
Since:
2.0

getSIF_Contexts

public SIF_Contexts getSIF_Contexts()
Gets the value of the <SIF_Contexts> element.

Returns:
A SIF_Contexts object
Since:
2.0

removeSIF_Contexts

public void removeSIF_Contexts()
Removes the SIF_Contexts child element previously created by calling setSIF_Contexts

Since:
2.0

toString

public java.lang.String toString()
Returns the value of the ObjectName attribute

Overrides:
toString in class Element
Returns:
The text value of this element if applicable


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.