Package de.espirit.firstspirit.access.store.templatestore

Interface Query

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, PackagePoolItem, StoreElement, TemplateStoreElement, Workflowable

public interface Query
extends PackagePoolItem, StoreElement, TemplateStoreElement

Definition of a query description container.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Field Summary

Fields

Modifier and Type	Field	Description
static final IDProvider.UidType	UID_TYPE	The uid type wich is returned by getUidType().

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem

BLOCKED, MODIFIED, UNMODIFIED

Method Summary

Modifier and Type	Method	Description
EntityList	getData()	Provides the data corresponding to this query.
@NotNull String	getName()	Deprecated. since 4.1.10 - use IDProvider.getUid()
String	getResultTableName()	Provides the name of the result table.
Schema	getSchema()	Provides the schema the query operates on.
@Nullable Select	getSelectStatement()	Returns the select object for this query or null if there isn't one defined yet.
String	getSelectStatementAsString()	Returns the select statement as string - the returned statement may not be valid and is always for the current version.
@NotNull IDProvider.UidType	getUidType()	Returns UID_TYPE.
boolean	getWizardMode()	Indicates the query to be build and using the wizard mode for definition.
void	setSelectStatement(Select statement)	Defines the select statement to be used for this query.
void	setSelectStatement(String statementXML)	Defines the select statement to be used for this query, derived from the given xml format.
void	setWizardMode(boolean value)	Defines to used the wizard mode for definition.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseRevision, getReleaseStatus, getReleaseStatus, getRevision, getUid, hasMeta, hasUid, isInReleaseStore, isInReleaseStore, isReachableInReleaseStore, isReleased, isReleased, isReleaseSupported, moveChild, moveChild, release, release, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem

addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferenceName, getReferences, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.TemplateStoreElement

getSubRootInStore

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Field Details

UID_TYPE

static final IDProvider.UidType UID_TYPE

The uid type wich is returned by getUidType().

Since:

4.0.24

Method Details

getUidType

@NotNull
@NotNull IDProvider.UidType getUidType()

Returns UID_TYPE.

Specified by:

getUidType in interface IDProvider

Returns:

The UID type.

Since:

4.0

See Also:

• IDProvider.hasUid()

getName

@NotNull
@Deprecated
@NotNull String getName()

Deprecated.

since 4.1.10 - use IDProvider.getUid()

Same as IDProvider.getUid().

Specified by:

getName in interface StoreElement

Returns:

The uid.

Since:

3.0

getSelectStatement

@Nullable
@Nullable Select getSelectStatement()

Returns the select object for this query or null if there isn't one defined yet.

Since:

3.0

getSelectStatementAsString

String getSelectStatementAsString()

Returns the select statement as string - the returned statement may not be valid and is always for the current version. Use getSelectStatement() if you want a validated select.

Since:

3.0

setSelectStatement

void setSelectStatement(Select statement)

Defines the select statement to be used for this query.

Parameters:

statement - The select statement.

Since:

3.0

setSelectStatement

void setSelectStatement(String statementXML)

Defines the select statement to be used for this query, derived from the given xml format.

Parameters:

statementXML - The statement XML.

Since:

3.0

getData

EntityList getData()

Provides the data corresponding to this query.

Returns:

A list of database entries.

Since:

3.0

getResultTableName

String getResultTableName()

Provides the name of the result table.

Returns:

The result table's name.

Since:

3.0

getWizardMode

boolean getWizardMode()

Indicates the query to be build and using the wizard mode for definition.

Returns:

true, if in wizard mode.

Since:

3.0

setWizardMode

void setWizardMode(boolean value)

Defines to used the wizard mode for definition.

Parameters:

value - true, if to use the wizard mode.

Since:

3.0

getSchema

Schema getSchema()

Provides the schema the query operates on.

Returns:

The schema.

Since:

4.0.132