|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
@TransientState public interface QueryService
to set SessionProperties.DS_NAME_READ_ONLY
used in DataValueBean
| Method Summary | |
|---|---|
List<Department> |
findAllDepartments(DepartmentInfo parent,
OrganizationInfo organization)
Retrieves all the departments satisfying the search criteria. |
Department |
findDepartment(DepartmentInfo parent,
String id,
OrganizationInfo info)
Searches for a department having the specified id in the scope defined by the parent department. |
ActivityInstance |
findFirstActivityInstance(ActivityInstanceQuery query)
Retrieves the first ActivityInstance satisfying the criteria specified in the provided query. |
Document |
findFirstDocument(DocumentQuery query)
Deprecated. since 8.0 use DocumentManagementService.findDocuments(DocumentQuery). |
LogEntry |
findFirstLogEntry(LogEntryQuery query)
Retrieves the first LogEntry satisfying the criteria specified in the provided query. |
ProcessInstance |
findFirstProcessInstance(ProcessInstanceQuery query)
Retrieves the first ProcessInstance satisfying the criteria specified in the provided query. |
User |
findFirstUser(UserQuery query)
Retrieves the first User satisfying the criteria specified in the provided query. |
UserGroup |
findFirstUserGroup(UserGroupQuery query)
Retrieves the first UserGroup satisfying the criteria specified in the provided query. |
DeployedModel |
getActiveModel()
Deprecated. This method returns the active model with the highest priority. Use getModels(DeployedModelQuery.findActive()) to retrieve all active models. |
DeployedModelDescription |
getActiveModelDescription()
Deprecated. This method returns the description of the active model with the highest priority. Use getModels(DeployedModelQuery.findActive()) to retrieve all active models. |
long |
getActivityInstancesCount(ActivityInstanceQuery query)
Counts the number of activity instances satisfying the criteria specified in the provided query. |
ActivityInstances |
getAllActivityInstances(ActivityInstanceQuery query)
Retrieves all activity instances satisfying the criteria specified in the provided query. |
List<DeployedModelDescription> |
getAllAliveModelDescriptions()
Deprecated. Use getModels(DeployedModelQuery.findInState(DeployedModelQuery.ALIVE)). |
BusinessObjects |
getAllBusinessObjects(BusinessObjectQuery query)
Returns the business objects satisfying the query. |
org.eclipse.stardust.engine.api.runtime.DataQueryResult |
getAllData(DataQuery query)
Retrieves all data satisfying the criteria specified in the provided query. |
Documents |
getAllDocuments(DocumentQuery query)
Deprecated. since 8.0 use DocumentManagementService.findDocuments(DocumentQuery). |
LogEntries |
getAllLogEntries(LogEntryQuery query)
Retrieves all log entries satisfying the criteria specified in the provided query. |
List<DeployedModelDescription> |
getAllModelDescriptions()
Deprecated. Use getModels(DeployedModelQuery.findAll()). |
List<Participant> |
getAllParticipants()
Retrieves all the participants for all active models. |
List<Participant> |
getAllParticipants(long modelOID)
Retrieves all participants defined in the specified model. |
List<Preferences> |
getAllPreferences(PreferenceQuery preferenceQuery)
Retrieves preferences satisfying the criteria specified in the provided query. |
List<ProcessDefinition> |
getAllProcessDefinitions()
Retrieves all process definitions for all active models. |
List<ProcessDefinition> |
getAllProcessDefinitions(long modelOID)
Retrieves all the process definitions contained in the specified model. |
List<ProcessInstanceLinkType> |
getAllProcessInstanceLinkTypes()
Gets all process instance link types defined. |
ProcessInstances |
getAllProcessInstances(ProcessInstanceQuery query)
Retrieves all process instances satisfying the criteria specified in the provided query. |
UserGroups |
getAllUserGroups(UserGroupQuery query)
Retrieves all user groups satisfying the criteria specified in the provided query. |
Users |
getAllUsers(UserQuery query)
Retrieves all users satisfying the criteria specified in the provided query. |
List<ActivityInstance> |
getAuditTrail(long processInstanceOID)
Returns all performed activity instances for the specified process instance. |
long |
getLogEntriesCount(LogEntryQuery query)
Counts the number of log entries satisfying the criteria specified in the provided query. |
DeployedModel |
getModel(long modelOID)
Retrieves the specified model. |
DeployedModel |
getModel(long modelOID,
boolean computeAliveness)
Retrieves the specified model. |
String |
getModelAsXML(long modelOID)
Retrieves the XML representation of the specified model. |
DeployedModelDescription |
getModelDescription(long modelOID)
Retrieves the description of the specified model. |
Models |
getModels(DeployedModelQuery query)
Retrieves the model descriptions satisfying the criteria specified in the provided query. |
Participant |
getParticipant(long modelOID,
String id)
Retrieves a participant from a specified model. |
Participant |
getParticipant(String id)
Retrieves a specific participant from the active model. |
List<Permission> |
getPermissions()
Retrieves all permissions the current user has on this service. |
Preferences |
getPreferences(PreferenceScope scope,
String moduleId,
String preferencesId)
Retrieves preferences from the given scope. |
ProcessDefinition |
getProcessDefinition(long modelOID,
String id)
Retrieves a process definition from the specified model. |
ProcessDefinition |
getProcessDefinition(String id)
Retrieves the specified process definition from the active model. |
ProcessDefinitions |
getProcessDefinitions(ProcessDefinitionQuery query)
|
ProcessInstanceLinkType |
getProcessInstanceLinkType(String id)
Gets a specific process instance link type. |
long |
getProcessInstancesCount(ProcessInstanceQuery query)
Counts the number of process instances satisfying the criteria specified in the provided query. |
ResourceBundle |
getResourceBundle(String moduleId,
String bundleName,
Locale locale)
Retrieves a resource bundle from a specified moduleId. |
RuntimeArtifact |
getRuntimeArtifact(long oid)
Retrieves the artifact by the unique oid. |
org.eclipse.stardust.engine.api.query.DeployedRuntimeArtifacts |
getRuntimeArtifacts(DeployedRuntimeArtifactQuery query)
Retrieves all DeployedRuntimeArtifacts satisfying the criteria specified in the provided query. |
RuntimeEnvironmentInfo |
getRuntimeEnvironmentInfo()
Retrieves the information about the deployed runtime environment (e.g. |
byte[] |
getSchemaDefinition(long modelOID,
String typeDeclarationId)
Retrieves XSD schema of the specified type declaration serialized into a byte[]. |
long |
getUserGroupsCount(UserGroupQuery query)
Counts the number of user groups satisfying the criteria specified in the provided query. |
long |
getUsersCount(UserQuery query)
Counts the number of users satisfying the criteria specified in the provided query. |
boolean |
wasRedeployed(long modelOid,
int revision)
Determines if the model was redeployed, i.e. |
| Method Detail |
|---|
@ExecutionPermission(id=readUserData,
defaults=ALL)
long getUsersCount(UserQuery query)
query - the user query.
@ExecutionPermission(id=readUserData,
defaults=ALL)
long getUserGroupsCount(UserGroupQuery query)
query - the user group query.
@ExecutionPermission(id=readProcessInstanceData,
scope=processDefinition,
defer=true,
defaults=ALL)
long getProcessInstancesCount(ProcessInstanceQuery query)
throws IllegalOperationException
query - the process instance query.
IllegalOperationException - if no attributeName
(XPath) is specified in a DataFilter for queries on a structured data
IllegalOperationException - if attributeName
(XPath) is specified in a DataFilter for queries on a non-structured data
IllegalOperationException - if attributeName
(XPath) specified in a DataFilter contains an invalid XPath
IllegalOperationException - if PerformingOnBehalfOfFilter is used
but activity instance history is disabled.
@ExecutionPermission(id=readActivityInstanceData,
scope=activity,
defer=true,
defaults=ALL,
fixed=OWNER)
long getActivityInstancesCount(ActivityInstanceQuery query)
throws IllegalOperationException
query - the activity instance query.
IllegalOperationException - if no attributeName
(XPath) is specified in a DataFilter for queries on a structured data
IllegalOperationException - if attributeName
(XPath) is specified in a DataFilter for queries on a non-structured data
IllegalOperationException - if attributeName
(XPath) specified in a DataFilter contains an invalid XPath
IllegalOperationException - if PerformingOnBehalfOfFilter is used
but activity instance history is disabled.@ExecutionPermission(id=readAuditTrailStatistics) long getLogEntriesCount(LogEntryQuery query)
query - the log entry query.
@ExecutionPermission(id=readUserData,
defaults=ALL)
Users getAllUsers(UserQuery query)
query - the user query.
@ExecutionPermission(id=readUserData,
defaults=ALL)
UserGroups getAllUserGroups(UserGroupQuery query)
query - the user group query.
UserGroup objects.
@ExecutionPermission(id=readProcessInstanceData,
scope=processDefinition,
defer=true,
defaults=ALL)
ProcessInstances getAllProcessInstances(ProcessInstanceQuery query)
throws IllegalOperationException
query - the process instance query.
IllegalOperationException - if no attributeName
(XPath) is specified in a DataFilter for queries on a structured data
IllegalOperationException - if attributeName
(XPath) is specified in a DataFilter for queries on a non-structured data
IllegalOperationException - if attributeName
(XPath) specified in a DataFilter contains an invalid XPath
IllegalOperationException - if PerformingOnBehalfOfFilter is used
but activity instance history is disabled.
@ExecutionPermission(id=readActivityInstanceData,
scope=activity,
defer=true,
defaults=ALL,
fixed=OWNER)
ActivityInstances getAllActivityInstances(ActivityInstanceQuery query)
throws IllegalOperationException
query - the activity instance query.
IllegalOperationException - if no attributeName
(XPath) is specified in a DataFilter for queries on a structured data
IllegalOperationException - if attributeName
(XPath) is specified in a DataFilter for queries on a non-structured data
IllegalOperationException - if attributeName
(XPath) specified in a DataFilter contains an invalid XPath
IllegalOperationException - if PerformingOnBehalfOfFilter is used
but activity instance history is disabled.
@ExecutionPermission(id=readAuditTrailStatistics)
LogEntries getAllLogEntries(LogEntryQuery query)
throws org.eclipse.stardust.common.error.AccessForbiddenException
query - the log entry query.
org.eclipse.stardust.common.error.AccessForbiddenException
@ExecutionPermission(id=readUserData,
defaults=ALL)
User findFirstUser(UserQuery query)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
query - the user query.
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching user is found.
@ExecutionPermission(id=readUserData,
defaults=ALL)
UserGroup findFirstUserGroup(UserGroupQuery query)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
query - the user group query.
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching user group is found.
@ExecutionPermission(id=readProcessInstanceData,
scope=processDefinition,
defer=true,
defaults=ALL)
ProcessInstance findFirstProcessInstance(ProcessInstanceQuery query)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
query - the process instance query.
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching process instance is found.
IllegalOperationException - if no attributeName
(XPath) is specified in a DataFilter for queries on a structured data
IllegalOperationException - if attributeName
(XPath) is specified in a DataFilter for queries on a non-structured data
IllegalOperationException - if attributeName
(XPath) specified in a DataFilter contains an invalid XPath
IllegalOperationException - if PerformingOnBehalfOfFilter is used
but activity instance history is disabled.
@ExecutionPermission(id=readActivityInstanceData,
scope=activity,
defer=true,
defaults=ALL,
fixed=OWNER)
ActivityInstance findFirstActivityInstance(ActivityInstanceQuery query)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
query - the activity instance query.
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching activity instance is found.
IllegalOperationException - if no attributeName
(XPath) is specified in a DataFilter for queries on a structured data
IllegalOperationException - if attributeName
(XPath) is specified in a DataFilter for queries on a non-structured data
IllegalOperationException - if attributeName
(XPath) specified in a DataFilter contains an invalid XPath
IllegalOperationException - if PerformingOnBehalfOfFilter is used
but activity instance history is disabled.
@ExecutionPermission(id=readAuditTrailStatistics)
LogEntry findFirstLogEntry(LogEntryQuery query)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
query - the log entry query.
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching log entry is found.
@ExecutionPermission(id=readActivityInstanceData,
scope=activity,
defer=true,
defaults=ALL,
fixed=OWNER)
List<ActivityInstance> getAuditTrail(long processInstanceOID)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
processInstanceOID - the OID of the process instance from where we retrieve the audit trail.
ActivityInstance objects.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID.
@ExecutionPermission(id=readDataValues,
scope=data,
defer=true,
defaults=ALL)
BusinessObjects getAllBusinessObjects(BusinessObjectQuery query)
query - the business objects query.
@ExecutionPermission(id=readModelData,
defaults=ALL)
List<DeployedModelDescription> getAllModelDescriptions()
getModels(DeployedModelQuery.findAll()).
DeployedModelDescription objects.
@ExecutionPermission(id=readModelData,
defaults=ALL)
List<DeployedModelDescription> getAllAliveModelDescriptions()
getModels(DeployedModelQuery.findInState(DeployedModelQuery.ALIVE)).
DeployedModelDescription objects.
@ExecutionPermission(id=readModelData,
defaults=ALL)
DeployedModelDescription getActiveModelDescription()
throws org.eclipse.stardust.common.error.ObjectNotFoundException
getModels(DeployedModelQuery.findActive()) to retrieve all active models.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model.
@ExecutionPermission(id=readModelData,
defaults=ALL)
Models getModels(DeployedModelQuery query)
query - the deployed model query.
@ExecutionPermission(id=readModelData,
defaults=ALL)
DeployedModelDescription getModelDescription(long modelOID)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model to retrieve.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID.
@ExecutionPermission(id=readModelData,
defaults=ALL)
boolean wasRedeployed(long modelOid,
int revision)
modelOid - The OID of the model to be checked..revision - The currently retrieved revision of the model.
true if a more recent revision of the model is available,
false if not.
@ExecutionPermission(id=readModelData,
defaults=ALL)
DeployedModel getModel(long modelOID)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model to retrieve.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID.
@ExecutionPermission(id=readModelData,
defaults=ALL)
DeployedModel getModel(long modelOID,
boolean computeAliveness)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model to retrieve.computeAliveness - whether the aliveness of the model should be computed or not
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID.
@ExecutionPermission(id=readModelData,
defaults=ALL)
DeployedModel getActiveModel()
throws org.eclipse.stardust.common.error.ObjectNotFoundException
getModels(DeployedModelQuery.findActive()) to retrieve all active models.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model.
@ExecutionPermission(id=readModelData,
defaults=ALL)
String getModelAsXML(long modelOID)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model to retrieve.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID.
@ExecutionPermission(id=readModelData,
defaults=ALL)
List<ProcessDefinition> getAllProcessDefinitions(long modelOID)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model.
ProcessDefinition objects.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID.
@ExecutionPermission(id=readModelData,
defaults=ALL)
ProcessDefinition getProcessDefinition(long modelOID,
String id)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model.id - the id of the process definition.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID or there is no process
definition with the specified id in the model.
@ExecutionPermission(id=readModelData,
defaults=ALL)
List<ProcessDefinition> getAllProcessDefinitions()
throws org.eclipse.stardust.common.error.ObjectNotFoundException
ProcessDefinition objects.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model.
@ExecutionPermission(id=readModelData,
defaults=ALL)
ProcessDefinition getProcessDefinition(String id)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
id - the id of the process definition.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model or if the active model
does not contain the requested process definition.
@ExecutionPermission(id=readModelData,
defaults=ALL)
ProcessDefinitions getProcessDefinitions(ProcessDefinitionQuery query)
@ExecutionPermission(id=readModelData,
defaults=ALL)
org.eclipse.stardust.engine.api.runtime.DataQueryResult getAllData(DataQuery query)
query - The DataQuery.
@ExecutionPermission(id=readModelData,
defaults=ALL)
List<Participant> getAllParticipants(long modelOID)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model.
Participant objects.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified oid.
@ExecutionPermission(id=readModelData,
defaults=ALL)
Participant getParticipant(long modelOID,
String id)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model.id - the id of the participant.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified oid, or the model does not
contains the requested participant.
@ExecutionPermission(id=readModelData,
defaults=ALL)
List<Participant> getAllParticipants()
throws org.eclipse.stardust.common.error.ObjectNotFoundException
Participant objects.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model.
@ExecutionPermission(id=readModelData,
defaults=ALL)
Participant getParticipant(String id)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
id - the id of the participant.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model, or if the active model does not contain
the requested participant.@ExecutionPermission List<Permission> getPermissions()
@ExecutionPermission(id=readModelData,
defaults=ALL)
byte[] getSchemaDefinition(long modelOID,
String typeDeclarationId)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
modelOID - the oid of the model.typeDeclarationId - the id of the type declaration.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model, or if the active model does not contain the
requested type declaration.
@ExecutionPermission(id=readDepartments,
defaults=ALL)
List<Department> findAllDepartments(DepartmentInfo parent,
OrganizationInfo organization)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
parent - the parent department.organization - the organization to which the retrieved departments are assigned.
org.eclipse.stardust.common.error.ObjectNotFoundException - if either the parent or the organization could not be resolved.
@ExecutionPermission(id=readDepartments,
defaults=ALL)
Department findDepartment(DepartmentInfo parent,
String id,
OrganizationInfo info)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
parent - the search scope. It can be null, in which case the search scope is the
top level.id - the id of the department. Must not be null or empty.info - the organization to which the retrieved departments are assigned.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the parent could not be resolved or if the specified id is null or
empty or if there is no department with the specified id in the parent
scope.
@ExecutionPermission
@Deprecated
Document findFirstDocument(DocumentQuery query)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
DocumentManagementService.findDocuments(DocumentQuery).
query - the document query.
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching document is found.@ExecutionPermission @Deprecated Documents getAllDocuments(DocumentQuery query)
DocumentManagementService.findDocuments(DocumentQuery).
query - the document query.
@ExecutionPermission
Preferences getPreferences(PreferenceScope scope,
String moduleId,
String preferencesId)
scope - the scope from which the preferences are to be retrieved from.moduleId - the moduleId of the preferences.preferencesId - the id of the preferences.
org.eclipse.stardust.common.error.PublicException - if scope is null.@ExecutionPermission List<Preferences> getAllPreferences(PreferenceQuery preferenceQuery)
preferenceQuery - the preference query.
org.eclipse.stardust.common.error.PublicException - if querying is not supported for the specified PreferenceScope.
UnsupportedOperationException - if the PreferenceQuery contains unsupported terms or operations.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferencesQuery is null.@ExecutionPermission RuntimeEnvironmentInfo getRuntimeEnvironmentInfo()
@ExecutionPermission
ResourceBundle getResourceBundle(String moduleId,
String bundleName,
Locale locale)
moduleId - The id of the engine resource bundle module.bundleName - The name of the bundle.locale - The to retrieve the resource bundle for.
@ExecutionPermission(id=readRuntimeArtifact,
defaults=ALL)
RuntimeArtifact getRuntimeArtifact(long oid)
oid - The oid of the artifact.
null if it does not exist.
@ExecutionPermission(id=readRuntimeArtifact,
defaults=ALL)
org.eclipse.stardust.engine.api.query.DeployedRuntimeArtifacts getRuntimeArtifacts(DeployedRuntimeArtifactQuery query)
query - the deployed runtime artifact query.
@ExecutionPermission ProcessInstanceLinkType getProcessInstanceLinkType(String id)
id - the in of the process instance link type.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance link type with the specified id.@ExecutionPermission List<ProcessInstanceLinkType> getAllProcessInstanceLinkTypes()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||