com.edustructures.sifworks.reporting
Class ReportDefinitionSource

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.reporting.ReportDefinitionSource

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ReportDefinitionSource
extends SIFKeyedElement

Indicates where the report definition can be found. If Type="Description", this element's value contains the report definition. If Type="URL", this element's value is the URL pointing to the external source for the definition. Type="SIF_Query" indicates that the SIF_QueryGroup element below contains the definition.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

ReportDefinitionSource()
Constructor

ReportDefinitionSource(ReportDefinitionSourceType type, java.lang.String value)
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	getQueryLanguage() Gets the value of the QueryLanguage attribute.
java.lang.String	getType() Gets the value of the Type attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
void	setQueryLanguage(java.lang.String value) Sets the value of the QueryLanguage attribute.
void	setType(ReportDefinitionSourceType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.
void	setValue(java.lang.String value) Sets the value of the <Value> 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

ReportDefinitionSource

public ReportDefinitionSource()

Constructor

ReportDefinitionSource

public ReportDefinitionSource(ReportDefinitionSourceType type,
                              java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

type - This attribute indicates the source of the report definition.

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

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

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <ReportDefinitionSource> element"

Returns:

The Value element of this object.

Since:

1.5r1

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <ReportDefinitionSource> element"

Parameters:

value - A String object

Since:

1.5r1

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "This attribute indicates the source of the report definition."

Returns:

The Type attribute of this object.

Since:

1.5r1

setType

public void setType(ReportDefinitionSourceType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "This attribute indicates the source of the report definition."

Parameters:

value - A constant defined by the ReportDefinitionSourceType class

Since:

1.5r1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "This attribute indicates the source of the report definition."

Parameters:

value - The value as a String

Since:

1.5r1

getQueryLanguage

public java.lang.String getQueryLanguage()

Gets the value of the QueryLanguage attribute.

The SIF specification defines the meaning of this attribute as: "The vendor-defined query language used in the report definition (e.g. SQL, ExampleObject, com.vendor.format, etc.). If the Type attribute is SIF_Query, then QueryLanguage should also be SIF_Query. If the Type attribute is SIF_ExtendedQuery, then QueryLanguage should also be SIF_ExtendedQuery. "

Returns:

The QueryLanguage attribute of this object.

Since:

2.0

setQueryLanguage

public void setQueryLanguage(java.lang.String value)

Sets the value of the QueryLanguage attribute.

The SIF specification defines the meaning of this attribute as: "The vendor-defined query language used in the report definition (e.g. SQL, ExampleObject, com.vendor.format, etc.). If the Type attribute is SIF_Query, then QueryLanguage should also be SIF_Query. If the Type attribute is SIF_ExtendedQuery, then QueryLanguage should also be SIF_ExtendedQuery. "

Parameters:

value - A String object

Since:

2.0