org.eclipse.stardust.engine.api.query

Class DataQuery

java.lang.Object

org.eclipse.stardust.engine.api.query.Query

org.eclipse.stardust.engine.api.query.DataQuery

All Implemented Interfaces:

Serializable

public class DataQuery
extends Query

Query container for building complex queries for data.

Author:

roland.stamm

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FilterableAttribute	DATA_TYPE_ID Attribute to filter for a specific data type.
static FilterableAttribute	DECLARED_TYPE_ID Attribute to filter for dms data having a specific declared type id assigned.
static FilterVerifier	FILTER_VERIFYER
static FilterableAttribute	MODEL_OID Attribute to filter for a specific model.
static FilterableAttribute	PROCESS_ID Attribute to filter for the process id.

Method Summary

Methods

Modifier and Type	Method and Description
static DataQuery	findAll() Creates a query for finding all data.
static DataQuery	findAllForModel(long modelOid) Creates a query for finding all data used in the specified model.
static DataQuery	findUsedInProcess(long modelOid, String processId) Creates a query for finding all data used in a specified model and process.
static DataQuery	findUsedInProcessHavingDataType(long modelOid, String processId, String dataTypeId) Creates a query for finding data of a specified type (see DataTypeConstants) used in a specified model and process.
static DataQuery	findUsedInProcessHavingDocumentWithDocType(long modelOid, String processId, DocumentType documentType) Creates a query for finding document data used in a specified process having the specified DocumentType assigned.
static DataQuery	findUsedInProcessHavingDocumentWithoutDocType(long modelOid, String processId) Creates a query for finding document data used in a specified process having no document type assigned.

Methods inherited from class org.eclipse.stardust.engine.api.query.Query

getFilter, getOrderCriteria, getPolicy, orderBy, orderBy, orderBy, removePolicy, setPolicy, toString, where

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROCESS_ID

public static final FilterableAttribute PROCESS_ID

Attribute to filter for the process id.

DATA_TYPE_ID

public static final FilterableAttribute DATA_TYPE_ID

Attribute to filter for a specific data type. See DataTypeConstants.

DECLARED_TYPE_ID

public static final FilterableAttribute DECLARED_TYPE_ID

Attribute to filter for dms data having a specific declared type id assigned.

This is only valid for dms types as document, document list, folder or folder list.

MODEL_OID

public static final FilterableAttribute MODEL_OID

Attribute to filter for a specific model.
Please Note: Currently only supports one single Operator.isEqual(modelOid) term to filter for exactly one modelOid.

See Also:

findAllForModel(long), findUsedInProcess(long, String)

FILTER_VERIFYER

public static final FilterVerifier FILTER_VERIFYER

Method Detail

findAll

public static DataQuery findAll()

Creates a query for finding all data.

Returns:

The configured query.

findAllForModel

public static DataQuery findAllForModel(long modelOid)

Creates a query for finding all data used in the specified model.

Parameters:

modelOid - The model to retrieve the data from.

Returns:

The configured query.

findUsedInProcess

public static DataQuery findUsedInProcess(long modelOid,
                          String processId)

Creates a query for finding all data used in a specified model and process.

Parameters:

modelOid - The model to retrieve the data from.

processId - The process to search used data for.

Returns:

The configured query.

findUsedInProcessHavingDataType

public static DataQuery findUsedInProcessHavingDataType(long modelOid,
                                        String processId,
                                        String dataTypeId)

Creates a query for finding data of a specified type (see DataTypeConstants) used in a specified model and process.

Parameters:

modelOid - The model to retrieve the data from.

processId - The process to search used data for.

dataTypeId - The data type from DataTypeConstants.

Returns:

The configured query.

See Also:

DataTypeConstants

findUsedInProcessHavingDocumentWithDocType

public static DataQuery findUsedInProcessHavingDocumentWithDocType(long modelOid,
                                                   String processId,
                                                   DocumentType documentType)

Creates a query for finding document data used in a specified process having the specified DocumentType assigned.

Parameters:

modelOid - The model to retrieve the data from.

processId - The process to search used data for.

documentType - The document type to search used data for.

Returns:

The configured query.

See Also:

DocumentType, DocumentTypeUtils

findUsedInProcessHavingDocumentWithoutDocType

public static DataQuery findUsedInProcessHavingDocumentWithoutDocType(long modelOid,
                                                      String processId)

Creates a query for finding document data used in a specified process having no document type assigned.

Parameters:

modelOid - The model to retrieve the data from.

processId - The process to search used data for.

Returns:

The configured query.