com.edustructures.sifworks.infra
Class SIF_ExtendedQuery

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.infra.SIF_ExtendedQuery

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_ExtendedQuery
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_ExtendedQuery()
Constructor

SIF_ExtendedQuery(SIF_Select sifSelect, SIF_From sifFrom)
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	getSIF_DestinationProvider() Gets the value of the <SIF_DestinationProvider> element.
SIF_From	getSIF_From() Gets the value of the <SIF_From> element.
SIF_OrderBy	getSIF_OrderBy() Gets the value of the <SIF_OrderBy> element.
SIF_Select	getSIF_Select() Gets the value of the <SIF_Select> element.
SIF_Where	getSIF_Where() Gets the value of the <SIF_Where> element.
void	removeSIF_From() Removes the SIF_From child element previously created by calling setSIF_From
void	removeSIF_OrderBy() Removes the SIF_OrderBy child element previously created by calling setSIF_OrderBy
void	removeSIF_Select() Removes the SIF_Select child element previously created by calling setSIF_Select
void	removeSIF_Where() Removes the SIF_Where child element previously created by calling setSIF_Where
void	setSIF_DestinationProvider(java.lang.String value) Sets the value of the <SIF_DestinationProvider> element as a String.
void	setSIF_DestinationProvider(Topics value) Sets the value of the <SIF_DestinationProvider> element.
void	setSIF_From(SIF_From value) Sets the value of the <SIF_From> element.
void	setSIF_From(Topics objectName, SIF_Object sifObject) Sets the value of the <SIF_From> child element.
void	setSIF_OrderBy(SIF_OrderBy value) Sets the value of the <SIF_OrderBy> element.
void	setSIF_OrderBy(SIFOrderByElement sifElement) Sets the value of the <SIF_OrderBy> child element.
void	setSIF_Select(java.lang.Boolean distinct, java.lang.String rowCount, SIFSelectElement sifElement) Sets the value of the <SIF_Select> child element.
void	setSIF_Select(SIF_Select value) Sets the value of the <SIF_Select> element.
void	setSIF_Where(SIF_ConditionGroup sifConditionGroup) Sets the value of the <SIF_Where> child element.
void	setSIF_Where(SIF_Where value) Sets the value of the <SIF_Where> 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_ExtendedQuery

public SIF_ExtendedQuery()

Constructor

SIF_ExtendedQuery

public SIF_ExtendedQuery(SIF_Select sifSelect,
                         SIF_From sifFrom)

Constructor that accepts values for all mandatory fields

Parameters:

sifSelect -

sifFrom -

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

getSIF_DestinationProvider

public java.lang.String getSIF_DestinationProvider()

Gets the value of the <SIF_DestinationProvider> element.

Returns:

The SIF_DestinationProvider element of this object.

Since:

2.0

setSIF_DestinationProvider

public void setSIF_DestinationProvider(Topics value)

Sets the value of the <SIF_DestinationProvider> element.

Parameters:

value - A constant defined by the Topics class

Since:

2.0

setSIF_DestinationProvider

public void setSIF_DestinationProvider(java.lang.String value)

Sets the value of the <SIF_DestinationProvider> element as a String.

Parameters:

value - The value as a String

Since:

2.0

setSIF_Select

public void setSIF_Select(SIF_Select value)

Sets the value of the <SIF_Select> element.

Parameters:

value - A SIF_Select object

Since:

2.0

setSIF_Select

public void setSIF_Select(java.lang.Boolean distinct,
                          java.lang.String rowCount,
                          SIFSelectElement sifElement)

Sets the value of the <SIF_Select> child element. This form of setSIF_Select is provided as a convenience method that is functionally equivalent to the version of setSIF_Select that accepts a single SIF_Select object.

Parameters:

distinct - Specifies whether query results should return all rows (false) or just distinct ones (true). Rows are distinct if at least one column differs between them.

rowCount - The maximum number of rows to return. If All, return all rows, otherwise return the top rows up to the maximum row count indicated.

sifElement -

Since:

2.0

getSIF_Select

public SIF_Select getSIF_Select()

Gets the value of the <SIF_Select> element.

Returns:

A SIF_Select object

Since:

2.0

removeSIF_Select

public void removeSIF_Select()

Removes the SIF_Select child element previously created by calling setSIF_Select

Since:

2.0

setSIF_From

public void setSIF_From(SIF_From value)

Sets the value of the <SIF_From> element.

Parameters:

value - A SIF_From object

Since:

2.0

setSIF_From

public void setSIF_From(Topics objectName,
                        SIF_Object sifObject)

Sets the value of the <SIF_From> child element. This form of setSIF_From is provided as a convenience method that is functionally equivalent to the version of setSIF_From that accepts a single SIF_From object.

Parameters:

objectName -

sifObject -

Since:

2.0

getSIF_From

public SIF_From getSIF_From()

Gets the value of the <SIF_From> element.

Returns:

A SIF_From object

Since:

2.0

removeSIF_From

public void removeSIF_From()

Removes the SIF_From child element previously created by calling setSIF_From

Since:

2.0

setSIF_Where

public void setSIF_Where(SIF_Where value)

Sets the value of the <SIF_Where> element.

Parameters:

value - A SIF_Where object

Since:

2.0

setSIF_Where

public void setSIF_Where(SIF_ConditionGroup sifConditionGroup)

Sets the value of the <SIF_Where> child element. This form of setSIF_Where is provided as a convenience method that is functionally equivalent to the version of setSIF_Where that accepts a single SIF_Where object.

Parameters:

sifConditionGroup -

Since:

2.0

getSIF_Where

public SIF_Where getSIF_Where()

Gets the value of the <SIF_Where> element.

Returns:

A SIF_Where object

Since:

2.0

removeSIF_Where

public void removeSIF_Where()

Removes the SIF_Where child element previously created by calling setSIF_Where

Since:

2.0

setSIF_OrderBy

public void setSIF_OrderBy(SIF_OrderBy value)

Sets the value of the <SIF_OrderBy> element.

Parameters:

value - A SIF_OrderBy object

Since:

2.0

setSIF_OrderBy

public void setSIF_OrderBy(SIFOrderByElement sifElement)

Sets the value of the <SIF_OrderBy> child element. This form of setSIF_OrderBy is provided as a convenience method that is functionally equivalent to the version of setSIF_OrderBy that accepts a single SIF_OrderBy object.

Parameters:

sifElement - Indicates the element/attribute by which to sort.

Since:

2.0

getSIF_OrderBy

public SIF_OrderBy getSIF_OrderBy()

Gets the value of the <SIF_OrderBy> element.

Returns:

A SIF_OrderBy object

Since:

2.0

removeSIF_OrderBy

public void removeSIF_OrderBy()

Removes the SIF_OrderBy child element previously created by calling setSIF_OrderBy

Since:

2.0