com.edustructures.sifworks.infra
Class SIF_JoinOn

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

public class SIF_JoinOn
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_JoinOn()
          Constructor
SIF_JoinOn(SIF_LeftElement sifLeftElement, SIF_RightElement sifRightElement)
          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_LeftElement getSIF_LeftElement()
          Gets the value of the <SIF_LeftElement> element.
 SIF_RightElement getSIF_RightElement()
          Gets the value of the <SIF_RightElement> element.
 void removeSIF_LeftElement()
          Removes the SIF_LeftElement child element previously created by calling setSIF_LeftElement
 void removeSIF_RightElement()
          Removes the SIF_RightElement child element previously created by calling setSIF_RightElement
 void setSIF_LeftElement(SIF_LeftElement value)
          Sets the value of the <SIF_LeftElement> element.
 void setSIF_LeftElement(Topics objectName, java.lang.String value)
          Sets the value of the <SIF_LeftElement> child element.
 void setSIF_RightElement(SIF_RightElement value)
          Sets the value of the <SIF_RightElement> element.
 void setSIF_RightElement(Topics objectName, java.lang.String value)
          Sets the value of the <SIF_RightElement> child 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_JoinOn

public SIF_JoinOn()
Constructor


SIF_JoinOn

public SIF_JoinOn(SIF_LeftElement sifLeftElement,
                  SIF_RightElement sifRightElement)
Constructor that accepts values for all mandatory fields

Parameters:
sifLeftElement -
sifRightElement -
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_LeftElement

public void setSIF_LeftElement(SIF_LeftElement value)
Sets the value of the <SIF_LeftElement> element.

Parameters:
value - A SIF_LeftElement object
Since:
2.0

setSIF_LeftElement

public void setSIF_LeftElement(Topics objectName,
                               java.lang.String value)
Sets the value of the <SIF_LeftElement> child element. This form of setSIF_LeftElement is provided as a convenience method that is functionally equivalent to the version of setSIF_LeftElement that accepts a single SIF_LeftElement object.

Parameters:
objectName -
value - Gets or sets the content value of the <SIF_LeftElement> element
Since:
2.0

getSIF_LeftElement

public SIF_LeftElement getSIF_LeftElement()
Gets the value of the <SIF_LeftElement> element.

Returns:
A SIF_LeftElement object
Since:
2.0

removeSIF_LeftElement

public void removeSIF_LeftElement()
Removes the SIF_LeftElement child element previously created by calling setSIF_LeftElement

Since:
2.0

setSIF_RightElement

public void setSIF_RightElement(SIF_RightElement value)
Sets the value of the <SIF_RightElement> element.

Parameters:
value - A SIF_RightElement object
Since:
2.0

setSIF_RightElement

public void setSIF_RightElement(Topics objectName,
                                java.lang.String value)
Sets the value of the <SIF_RightElement> child element. This form of setSIF_RightElement is provided as a convenience method that is functionally equivalent to the version of setSIF_RightElement that accepts a single SIF_RightElement object.

Parameters:
objectName -
value - Gets or sets the content value of the <SIF_RightElement> element
Since:
2.0

getSIF_RightElement

public SIF_RightElement getSIF_RightElement()
Gets the value of the <SIF_RightElement> element.

Returns:
A SIF_RightElement object
Since:
2.0

removeSIF_RightElement

public void removeSIF_RightElement()
Removes the SIF_RightElement child element previously created by calling setSIF_RightElement

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.