|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.stardust.engine.api.query.Query
org.eclipse.stardust.engine.api.query.BusinessObjectQuery
public class BusinessObjectQuery
Query container for building complex queries for business objects.
Valid filter criteria are:
FilterTerm for building complex criteria.DataFilter for finding business objects containing specific data.Supported evaluation policies are:
BusinessObjectQuery.Policy to specify if the result should contain the
business objects descriptions or/and the values.TimeoutPolicy to specify an explicit query timeout.SubsetPolicy to specify an explicit result subset (from, to).
| Nested Class Summary | |
|---|---|
static class |
BusinessObjectQuery.Option
Policy options. |
static class |
BusinessObjectQuery.Policy
Policy that specifies the query options. |
| Field Summary | |
|---|---|
static FilterVerifier |
FILTER_VERIFYER
List of valid filters. |
static String |
ID_ATTRIBUTE
|
static String |
MODEL_ID_ATTRIBUTE
|
static String |
PK_ATTRIBUTE
|
| Method Summary | |
|---|---|
static BusinessObjectQuery |
findAll()
Creates a query for finding all business objects. |
static BusinessObjectQuery |
findForBusinessObject(long modelOid,
String businessObjectId)
Creates a query for finding a business object. |
static BusinessObjectQuery |
findForBusinessObject(String qualifiedBusinessObjectId)
Creates a query for finding a specific business object. |
static BusinessObjectQuery |
findInModel(long modelOid)
Creates a query for finding all business objects declared in the specified model. |
static BusinessObjectQuery |
findInModel(String modelId)
Creates a query for finding all business objects declared in the specified model. |
static BusinessObjectQuery |
findWithPrimaryKey(long modelOid,
String businessObjectId,
Object pk)
Creates a query for finding a business object instance. |
static BusinessObjectQuery |
findWithPrimaryKey(String qualifiedBusinessObjectId,
Object pk)
Creates a query for finding a specific instance of a business object. |
| 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 |
|---|
public static final String MODEL_ID_ATTRIBUTE
public static final String ID_ATTRIBUTE
public static final String PK_ATTRIBUTE
public static final FilterVerifier FILTER_VERIFYER
| Method Detail |
|---|
public static BusinessObjectQuery findAll()
public static BusinessObjectQuery findInModel(String modelId)
modelId - the id of the model.
public static BusinessObjectQuery findForBusinessObject(String qualifiedBusinessObjectId)
qualifiedBusinessObjectId - the qualified id of the business object (in the form '{' + modelId + '}' + dataId).
public static BusinessObjectQuery findWithPrimaryKey(String qualifiedBusinessObjectId,
Object pk)
qualifiedBusinessObjectId - the qualified id of the business object (in the form '{' + modelId + '}' + dataId).pk - the primary key value of the business object instance.
public static BusinessObjectQuery findInModel(long modelOid)
modelOid - the oid of a concrete deployed model or one of the predefined meta oids:
PredefinedConstants.ALL_MODELS includes business objects from all modelsPredefinedConstants.ACTIVE_MODEL includes business objects from the active modelsPredefinedConstants.LAST_DEPLOYED_MODEL includes business objects from the last deployed modelsPredefinedConstants.ALIVE_MODELS includes business objects from alive modelsPredefinedConstants.ANY_MODEL includes business objects from the first matching model
public static BusinessObjectQuery findForBusinessObject(long modelOid,
String businessObjectId)
modelOid - the oid of a concrete deployed model or one of the predefined meta oidsbusinessObjectId - the id of the business object, either qualified or simple.
public static BusinessObjectQuery findWithPrimaryKey(long modelOid,
String businessObjectId,
Object pk)
modelOid - the oid of a concrete deployed model or one of the predefined meta oidsbusinessObjectId - the id of the business object, either qualified or simple.pk - the primary key value of the business object instance.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||