com.edustructures.sifworks.infra
Class SIF_ExtendedQueryResults

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

public class SIF_ExtendedQueryResults
extends SIFElement

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_ExtendedQueryResults()
          Constructor
SIF_ExtendedQueryResults(SIFColumnHeader sifColumnHeaders, SIF_Rows sifRows)
          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
 SIF_ColumnHeaders getSIF_ColumnHeaders()
          Gets the value of the <SIF_ColumnHeaders> element.
 SIF_Rows getSIF_Rows()
          Gets the value of the <SIF_Rows> element.
 void removeSIF_ColumnHeaders()
          Removes the SIF_ColumnHeaders child element previously created by calling setSIF_ColumnHeaders
 void removeSIF_Rows()
          Removes the SIF_Rows child element previously created by calling setSIF_Rows
 void setSIF_ColumnHeaders(SIF_ColumnHeaders value)
          Sets the value of the <SIF_ColumnHeaders> element.
 void setSIF_ColumnHeaders(SIFColumnHeader sifElement)
          Sets the value of the <SIF_ColumnHeaders> child element.
 void setSIF_Rows(SIF_Rows value)
          Sets the value of the <SIF_Rows> element.
 
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
 

Constructor Detail

SIF_ExtendedQueryResults

public SIF_ExtendedQueryResults()
Constructor


SIF_ExtendedQueryResults

public SIF_ExtendedQueryResults(SIFColumnHeader sifColumnHeaders,
                                SIF_Rows sifRows)
Constructor that accepts values for all mandatory fields

Parameters:
sifColumnHeaders -
sifRows -
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

setSIF_ColumnHeaders

public void setSIF_ColumnHeaders(SIF_ColumnHeaders value)
Sets the value of the <SIF_ColumnHeaders> element.

Parameters:
value - A SIF_ColumnHeaders object
Since:
2.0

setSIF_ColumnHeaders

public void setSIF_ColumnHeaders(SIFColumnHeader sifElement)
Sets the value of the <SIF_ColumnHeaders> child element. This form of setSIF_ColumnHeaders is provided as a convenience method that is functionally equivalent to the version of setSIF_ColumnHeaders that accepts a single SIF_ColumnHeaders object.

Parameters:
sifElement -
Since:
2.0

getSIF_ColumnHeaders

public SIF_ColumnHeaders getSIF_ColumnHeaders()
Gets the value of the <SIF_ColumnHeaders> element.

Returns:
A SIF_ColumnHeaders object
Since:
2.0

removeSIF_ColumnHeaders

public void removeSIF_ColumnHeaders()
Removes the SIF_ColumnHeaders child element previously created by calling setSIF_ColumnHeaders

Since:
2.0

setSIF_Rows

public void setSIF_Rows(SIF_Rows value)
Sets the value of the <SIF_Rows> element.

Parameters:
value - A SIF_Rows object
Since:
2.0

getSIF_Rows

public SIF_Rows getSIF_Rows()
Gets the value of the <SIF_Rows> element.

Returns:
A SIF_Rows object
Since:
2.0

removeSIF_Rows

public void removeSIF_Rows()
Removes the SIF_Rows child element previously created by calling setSIF_Rows

Since:
2.0


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.