org.eclipse.stardust.engine.api.ejb2
Interface RemoteQueryService

All Superinterfaces:
javax.ejb.EJBObject, Remote

public interface RemoteQueryService
extends javax.ejb.EJBObject

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.
 void login(String userId, String password)
           
 void login(String userId, String password, Map properties)
           
 void logout()
           
 boolean wasRedeployed(long modelOid, int revision)
          Determines if the model was redeployed, i.e.
 
Methods inherited from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
 

Method Detail

getUsersCount

long getUsersCount(UserQuery query)
                   throws org.eclipse.stardust.common.error.WorkflowException,
                          RemoteException
Counts the number of users satisfying the criteria specified in the provided query.

Parameters:
query - the user query.
Returns:
the user count.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getUsersCount( org.eclipse.stardust.engine.api.query.UserQuery query)

getUserGroupsCount

long getUserGroupsCount(UserGroupQuery query)
                        throws org.eclipse.stardust.common.error.WorkflowException,
                               RemoteException
Counts the number of user groups satisfying the criteria specified in the provided query.

Parameters:
query - the user group query.
Returns:
the user group count.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getUserGroupsCount( org.eclipse.stardust.engine.api.query.UserGroupQuery query)

getProcessInstancesCount

long getProcessInstancesCount(ProcessInstanceQuery query)
                              throws org.eclipse.stardust.common.error.WorkflowException,
                                     RemoteException
Counts the number of process instances satisfying the criteria specified in the provided query.

Parameters:
query - the process instance query.
Returns:
the process instance count.
Throws:
IllegalOperationException - if no attributeName (XPath) is specified in a DataFilter for queries on a structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) is specified in a DataFilter for queries on a non-structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) specified in a DataFilter contains an invalid XPath Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if PerformingOnBehalfOfFilter is used but activity instance history is disabled. Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getProcessInstancesCount( org.eclipse.stardust.engine.api.query.ProcessInstanceQuery query)

getActivityInstancesCount

long getActivityInstancesCount(ActivityInstanceQuery query)
                               throws org.eclipse.stardust.common.error.WorkflowException,
                                      RemoteException
Counts the number of activity instances satisfying the criteria specified in the provided query.

Parameters:
query - the activity instance query.
Returns:
the activity instance count.
Throws:
IllegalOperationException - if no attributeName (XPath) is specified in a DataFilter for queries on a structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) is specified in a DataFilter for queries on a non-structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) specified in a DataFilter contains an invalid XPath Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if PerformingOnBehalfOfFilter is used but activity instance history is disabled. Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getActivityInstancesCount( org.eclipse.stardust.engine.api.query.ActivityInstanceQuery query)

getLogEntriesCount

long getLogEntriesCount(LogEntryQuery query)
                        throws org.eclipse.stardust.common.error.WorkflowException,
                               RemoteException
Counts the number of log entries satisfying the criteria specified in the provided query.

Parameters:
query - the log entry query.
Returns:
the log entry count.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getLogEntriesCount( org.eclipse.stardust.engine.api.query.LogEntryQuery query)

getAllUsers

Users getAllUsers(UserQuery query)
                  throws org.eclipse.stardust.common.error.WorkflowException,
                         RemoteException
Retrieves all users satisfying the criteria specified in the provided query.

Parameters:
query - the user query.
Returns:
a List of User objects.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllUsers( org.eclipse.stardust.engine.api.query.UserQuery query)

getAllUserGroups

UserGroups getAllUserGroups(UserGroupQuery query)
                            throws org.eclipse.stardust.common.error.WorkflowException,
                                   RemoteException
Retrieves all user groups satisfying the criteria specified in the provided query.

Parameters:
query - the user group query.
Returns:
A list of UserGroup objects.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllUserGroups( org.eclipse.stardust.engine.api.query.UserGroupQuery query)

getAllProcessInstances

ProcessInstances getAllProcessInstances(ProcessInstanceQuery query)
                                        throws org.eclipse.stardust.common.error.WorkflowException,
                                               RemoteException
Retrieves all process instances satisfying the criteria specified in the provided query.

Parameters:
query - the process instance query.
Returns:
a List of ProcessInstance objects.
Throws:
IllegalOperationException - if no attributeName (XPath) is specified in a DataFilter for queries on a structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) is specified in a DataFilter for queries on a non-structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) specified in a DataFilter contains an invalid XPath Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if PerformingOnBehalfOfFilter is used but activity instance history is disabled. Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllProcessInstances( org.eclipse.stardust.engine.api.query.ProcessInstanceQuery query)

getAllActivityInstances

ActivityInstances getAllActivityInstances(ActivityInstanceQuery query)
                                          throws org.eclipse.stardust.common.error.WorkflowException,
                                                 RemoteException
Retrieves all activity instances satisfying the criteria specified in the provided query.

Parameters:
query - the activity instance query.
Returns:
a List of ActivityInstance objects.
Throws:
IllegalOperationException - if no attributeName (XPath) is specified in a DataFilter for queries on a structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) is specified in a DataFilter for queries on a non-structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) specified in a DataFilter contains an invalid XPath Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if PerformingOnBehalfOfFilter is used but activity instance history is disabled. Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllActivityInstances( org.eclipse.stardust.engine.api.query.ActivityInstanceQuery query)

getAllLogEntries

LogEntries getAllLogEntries(LogEntryQuery query)
                            throws org.eclipse.stardust.common.error.WorkflowException,
                                   RemoteException
Retrieves all log entries satisfying the criteria specified in the provided query.

Parameters:
query - the log entry query.
Returns:
a List of LogEntry objects.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllLogEntries( org.eclipse.stardust.engine.api.query.LogEntryQuery query)

findFirstUser

User findFirstUser(UserQuery query)
                   throws org.eclipse.stardust.common.error.WorkflowException,
                          RemoteException
Retrieves the first User satisfying the criteria specified in the provided query.

Parameters:
query - the user query.
Returns:
the first matching user.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching user is found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.findFirstUser( org.eclipse.stardust.engine.api.query.UserQuery query)

findFirstUserGroup

UserGroup findFirstUserGroup(UserGroupQuery query)
                             throws org.eclipse.stardust.common.error.WorkflowException,
                                    RemoteException
Retrieves the first UserGroup satisfying the criteria specified in the provided query.

Parameters:
query - the user group query.
Returns:
the first matching user group.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching user group is found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.findFirstUserGroup( org.eclipse.stardust.engine.api.query.UserGroupQuery query)

findFirstProcessInstance

ProcessInstance findFirstProcessInstance(ProcessInstanceQuery query)
                                         throws org.eclipse.stardust.common.error.WorkflowException,
                                                RemoteException
Retrieves the first ProcessInstance satisfying the criteria specified in the provided query.

Parameters:
query - the process instance query.
Returns:
the first matching process instance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching process instance is found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if no attributeName (XPath) is specified in a DataFilter for queries on a structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) is specified in a DataFilter for queries on a non-structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) specified in a DataFilter contains an invalid XPath Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if PerformingOnBehalfOfFilter is used but activity instance history is disabled. Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.findFirstProcessInstance( org.eclipse.stardust.engine.api.query.ProcessInstanceQuery query)

findFirstActivityInstance

ActivityInstance findFirstActivityInstance(ActivityInstanceQuery query)
                                           throws org.eclipse.stardust.common.error.WorkflowException,
                                                  RemoteException
Retrieves the first ActivityInstance satisfying the criteria specified in the provided query.

Parameters:
query - the activity instance query.
Returns:
the first matching activity instance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching activity instance is found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if no attributeName (XPath) is specified in a DataFilter for queries on a structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) is specified in a DataFilter for queries on a non-structured data Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if attributeName (XPath) specified in a DataFilter contains an invalid XPath Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if PerformingOnBehalfOfFilter is used but activity instance history is disabled. Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.findFirstActivityInstance( org.eclipse.stardust.engine.api.query.ActivityInstanceQuery query)

findFirstLogEntry

LogEntry findFirstLogEntry(LogEntryQuery query)
                           throws org.eclipse.stardust.common.error.WorkflowException,
                                  RemoteException
Retrieves the first LogEntry satisfying the criteria specified in the provided query.

Parameters:
query - the log entry query.
Returns:
the first matching log entry.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching log entry is found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.findFirstLogEntry( org.eclipse.stardust.engine.api.query.LogEntryQuery query)

getAuditTrail

List<ActivityInstance> getAuditTrail(long processInstanceOID)
                                     throws org.eclipse.stardust.common.error.WorkflowException,
                                            RemoteException
Returns all performed activity instances for the specified process instance.

Parameters:
processInstanceOID - the OID of the process instance from where we retrieve the audit trail.
Returns:
a List of ActivityInstance objects.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAuditTrail( long processInstanceOID)

getAllBusinessObjects

BusinessObjects getAllBusinessObjects(BusinessObjectQuery query)
                                      throws org.eclipse.stardust.common.error.WorkflowException,
                                             RemoteException
Returns the business objects satisfying the query.

Parameters:
query - the business objects query.
Returns:
a list of business objects, possibly empty.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllBusinessObjects( org.eclipse.stardust.engine.api.query.BusinessObjectQuery query)

getAllModelDescriptions

List<DeployedModelDescription> getAllModelDescriptions()
                                                       throws org.eclipse.stardust.common.error.WorkflowException,
                                                              RemoteException
Deprecated. Use getModels(DeployedModelQuery.findAll()).

Retrieves the list of model descriptions for all deployed models.

Returns:
a List of DeployedModelDescription objects.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllModelDescriptions()

getAllAliveModelDescriptions

List<DeployedModelDescription> getAllAliveModelDescriptions()
                                                            throws org.eclipse.stardust.common.error.WorkflowException,
                                                                   RemoteException
Deprecated. Use getModels(DeployedModelQuery.findInState(DeployedModelQuery.ALIVE)).

Retrieves the list of model descriptions for all alive models. Whereby alive models are models with non-completed and non-aborted processes plus the active model.

Returns:
a List of DeployedModelDescription objects.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllAliveModelDescriptions()

getActiveModelDescription

DeployedModelDescription getActiveModelDescription()
                                                   throws org.eclipse.stardust.common.error.WorkflowException,
                                                          RemoteException
Deprecated. This method returns the description of the active model with the highest priority. Use getModels(DeployedModelQuery.findActive()) to retrieve all active models.

Retrieves the current active model description.

Returns:
the description of the active model.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getActiveModelDescription()

getModels

Models getModels(DeployedModelQuery query)
                 throws org.eclipse.stardust.common.error.WorkflowException,
                        RemoteException
Retrieves the model descriptions satisfying the criteria specified in the provided query.

Parameters:
query - the deployed model query.
Returns:
a List of DeployedModelDescription objects.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getModels( org.eclipse.stardust.engine.api.query.DeployedModelQuery query)

getModelDescription

DeployedModelDescription getModelDescription(long modelOID)
                                             throws org.eclipse.stardust.common.error.WorkflowException,
                                                    RemoteException
Retrieves the description of the specified model.

Parameters:
modelOID - the oid of the model to retrieve.
Returns:
the description of the specified model.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getModelDescription(long modelOID)

wasRedeployed

boolean wasRedeployed(long modelOid,
                      int revision)
                      throws org.eclipse.stardust.common.error.WorkflowException,
                             RemoteException
Determines if the model was redeployed, i.e. if a more recent revision than the provided one is available.

Parameters:
modelOid - The OID of the model to be checked..
revision - The currently retrieved revision of the model.
Returns:
true if a more recent revision of the model is available, false if not.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.wasRedeployed( long modelOid, int revision)

getModel

DeployedModel getModel(long modelOID)
                       throws org.eclipse.stardust.common.error.WorkflowException,
                              RemoteException
Retrieves the specified model.

Parameters:
modelOID - the oid of the model to retrieve.
Returns:
the specified model.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getModel(long modelOID)

getModel

DeployedModel getModel(long modelOID,
                       boolean computeAliveness)
                       throws org.eclipse.stardust.common.error.WorkflowException,
                              RemoteException
Retrieves the specified model.

Parameters:
modelOID - the oid of the model to retrieve.
computeAliveness - whether the aliveness of the model should be computed or not
Returns:
the specified model.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getModel( long modelOID, boolean computeAliveness)

getActiveModel

DeployedModel getActiveModel()
                             throws org.eclipse.stardust.common.error.WorkflowException,
                                    RemoteException
Deprecated. This method returns the active model with the highest priority. Use getModels(DeployedModelQuery.findActive()) to retrieve all active models.

Retrieves the current active model.

Returns:
the active model.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getActiveModel()

getModelAsXML

String getModelAsXML(long modelOID)
                     throws org.eclipse.stardust.common.error.WorkflowException,
                            RemoteException
Retrieves the XML representation of the specified model.

Parameters:
modelOID - the oid of the model to retrieve.
Returns:
A string containing the XML representation of the model.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getModelAsXML(long modelOID)

getAllProcessDefinitions

List<ProcessDefinition> getAllProcessDefinitions(long modelOID)
                                                 throws org.eclipse.stardust.common.error.WorkflowException,
                                                        RemoteException
Retrieves all the process definitions contained in the specified model.

Parameters:
modelOID - the oid of the model.
Returns:
a List of ProcessDefinition objects.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllProcessDefinitions( long modelOID)

getProcessDefinition

ProcessDefinition getProcessDefinition(long modelOID,
                                       String id)
                                       throws org.eclipse.stardust.common.error.WorkflowException,
                                              RemoteException
Retrieves a process definition from the specified model.

Parameters:
modelOID - the oid of the model.
id - the id of the process definition.
Returns:
the process definition.
Throws:
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. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getProcessDefinition( long modelOID, java.lang.String id)

getAllProcessDefinitions

List<ProcessDefinition> getAllProcessDefinitions()
                                                 throws org.eclipse.stardust.common.error.WorkflowException,
                                                        RemoteException
Retrieves all process definitions for all active models.

Returns:
a List of ProcessDefinition objects.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllProcessDefinitions()

getProcessDefinition

ProcessDefinition getProcessDefinition(String id)
                                       throws org.eclipse.stardust.common.error.WorkflowException,
                                              RemoteException
Retrieves the specified process definition from the active model.

Parameters:
id - the id of the process definition.
Returns:
the process definition.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model or if the active model does not contain the requested process definition. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getProcessDefinition( java.lang.String id)

getProcessDefinitions

ProcessDefinitions getProcessDefinitions(ProcessDefinitionQuery query)
                                         throws org.eclipse.stardust.common.error.WorkflowException,
                                                RemoteException
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getProcessDefinitions( org.eclipse.stardust.engine.api.query.ProcessDefinitionQuery query)

getAllData

org.eclipse.stardust.engine.api.runtime.DataQueryResult getAllData(DataQuery query)
                                                                   throws org.eclipse.stardust.common.error.WorkflowException,
                                                                          RemoteException
Retrieves all data satisfying the criteria specified in the provided query.

Parameters:
query - The DataQuery.
Returns:
A list of Data objects.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllData( org.eclipse.stardust.engine.api.query.DataQuery query)

getAllParticipants

List<Participant> getAllParticipants(long modelOID)
                                     throws org.eclipse.stardust.common.error.WorkflowException,
                                            RemoteException
Retrieves all participants defined in the specified model.

Parameters:
modelOID - the oid of the model.
Returns:
a List of Participant objects.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified oid. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllParticipants(long modelOID)

getParticipant

Participant getParticipant(long modelOID,
                           String id)
                           throws org.eclipse.stardust.common.error.WorkflowException,
                                  RemoteException
Retrieves a participant from a specified model.

Parameters:
modelOID - the oid of the model.
id - the id of the participant.
Returns:
the participant.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no model with the specified oid, or the model does not contains the requested participant. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getParticipant( long modelOID, java.lang.String id)

getAllParticipants

List<Participant> getAllParticipants()
                                     throws org.eclipse.stardust.common.error.WorkflowException,
                                            RemoteException
Retrieves all the participants for all active models.

Returns:
a List of Participant objects.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllParticipants()

getParticipant

Participant getParticipant(String id)
                           throws org.eclipse.stardust.common.error.WorkflowException,
                                  RemoteException
Retrieves a specific participant from the active model.

Parameters:
id - the id of the participant.
Returns:
the participant.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model, or if the active model does not contain the requested participant. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getParticipant( java.lang.String id)

getPermissions

List<Permission> getPermissions()
                                throws org.eclipse.stardust.common.error.WorkflowException,
                                       RemoteException
Retrieves all permissions the current user has on this service.

Returns:
a list of permission ids.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getPermissions()

getSchemaDefinition

byte[] getSchemaDefinition(long modelOID,
                           String typeDeclarationId)
                           throws org.eclipse.stardust.common.error.WorkflowException,
                                  RemoteException
Retrieves XSD schema of the specified type declaration serialized into a byte[].

Parameters:
modelOID - the oid of the model.
typeDeclarationId - the id of the type declaration.
Returns:
XSD schema of this type declaration
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model, or if the active model does not contain the requested type declaration. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getSchemaDefinition( long modelOID, java.lang.String typeDeclarationId)

findAllDepartments

List<Department> findAllDepartments(DepartmentInfo parent,
                                    OrganizationInfo organization)
                                    throws org.eclipse.stardust.common.error.WorkflowException,
                                           RemoteException
Retrieves all the departments satisfying the search criteria. The search is performed as following: On synchronization departments will be updated when existing in audit trail and having any changes. If a department does not exist in audit trail but is present in external repository the department will not be created in audit trail on synchronization with external repository.

Parameters:
parent - the parent department.
organization - the organization to which the retrieved departments are assigned.
Returns:
the list of departments. The list can be empty if no departments are matching the search criteria.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if either the parent or the organization could not be resolved. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.findAllDepartments( org.eclipse.stardust.engine.api.runtime.DepartmentInfo parent, org.eclipse.stardust.engine.api.model.OrganizationInfo organization)

findDepartment

Department findDepartment(DepartmentInfo parent,
                          String id,
                          OrganizationInfo info)
                          throws org.eclipse.stardust.common.error.WorkflowException,
                                 RemoteException
Searches for a department having the specified id in the scope defined by the parent department. On synchronization with external repository the specified department will be created in audit trail if it is not already present there but exists in external repository. If the department exists in audit trail it will be updated on synchronization if there are any changes.

Parameters:
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.
Returns:
the department having the specified id.
Throws:
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. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.findDepartment( org.eclipse.stardust.engine.api.runtime.DepartmentInfo parent, java.lang.String id, org.eclipse.stardust.engine.api.model.OrganizationInfo info)

findFirstDocument

Document findFirstDocument(DocumentQuery query)
                           throws org.eclipse.stardust.common.error.WorkflowException,
                                  RemoteException
Deprecated. since 8.0 use DocumentManagementService.findDocuments(DocumentQuery).

Retrieves the first document satisfying the criteria specified in the provided query.

Parameters:
query - the document query.
Returns:
the first matching document.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if no matching document is found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.findFirstDocument( org.eclipse.stardust.engine.api.query.DocumentQuery query)

getAllDocuments

Documents getAllDocuments(DocumentQuery query)
                          throws org.eclipse.stardust.common.error.WorkflowException,
                                 RemoteException
Deprecated. since 8.0 use DocumentManagementService.findDocuments(DocumentQuery).

Retrieves all documents satisfying the criteria specified in the provided query.

Parameters:
query - the document query.
Returns:
a List of Document objects.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllDocuments( org.eclipse.stardust.engine.api.query.DocumentQuery query)

getPreferences

Preferences getPreferences(PreferenceScope scope,
                           String moduleId,
                           String preferencesId)
                           throws org.eclipse.stardust.common.error.WorkflowException,
                                  RemoteException
Retrieves preferences from the given scope.

Parameters:
scope - the scope from which the preferences are to be retrieved from.
moduleId - the moduleId of the preferences.
preferencesId - the id of the preferences.
Returns:
a preferences object.
Throws:
org.eclipse.stardust.common.error.PublicException - if scope is null. Instances of PublicException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getPreferences( org.eclipse.stardust.engine.core.preferences.PreferenceScope scope, java.lang.String moduleId, java.lang.String preferencesId)

getAllPreferences

List<Preferences> getAllPreferences(PreferenceQuery preferenceQuery)
                                    throws org.eclipse.stardust.common.error.WorkflowException,
                                           RemoteException
Retrieves preferences satisfying the criteria specified in the provided query.

Parameters:
preferenceQuery - the preference query.
Returns:
a list of preferences.
Throws:
org.eclipse.stardust.common.error.PublicException - if querying is not supported for the specified PreferenceScope. Instances of PublicException will be wrapped inside WorkflowException.
UnsupportedOperationException - if the PreferenceQuery contains unsupported terms or operations. Instances of UnsupportedOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferencesQuery is null. Instances of InvalidArgumentException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllPreferences( org.eclipse.stardust.engine.api.query.PreferenceQuery preferenceQuery)

getRuntimeEnvironmentInfo

RuntimeEnvironmentInfo getRuntimeEnvironmentInfo()
                                                 throws org.eclipse.stardust.common.error.WorkflowException,
                                                        RemoteException
Retrieves the information about the deployed runtime environment ( e.g. version information).

Returns:
the runtime environment information.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getRuntimeEnvironmentInfo()

getResourceBundle

ResourceBundle getResourceBundle(String moduleId,
                                 String bundleName,
                                 Locale locale)
                                 throws org.eclipse.stardust.common.error.WorkflowException,
                                        RemoteException
Retrieves a resource bundle from a specified moduleId.

Parameters:
moduleId - The id of the engine resource bundle module.
bundleName - The name of the bundle.
locale - The to retrieve the resource bundle for.
Returns:
The ResourceBundle or null if no ResourceBundle was found.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getResourceBundle( java.lang.String moduleId, java.lang.String bundleName, java.util.Locale locale)

getRuntimeArtifact

RuntimeArtifact getRuntimeArtifact(long oid)
                                   throws org.eclipse.stardust.common.error.WorkflowException,
                                          RemoteException
Retrieves the artifact by the unique oid.

Parameters:
oid - The oid of the artifact.
Returns:
The artifact or null if it does not exist.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getRuntimeArtifact(long oid)

getRuntimeArtifacts

org.eclipse.stardust.engine.api.query.DeployedRuntimeArtifacts getRuntimeArtifacts(DeployedRuntimeArtifactQuery query)
                                                                                   throws org.eclipse.stardust.common.error.WorkflowException,
                                                                                          RemoteException
Retrieves all DeployedRuntimeArtifacts satisfying the criteria specified in the provided query.

Parameters:
query - the deployed runtime artifact query.
Returns:
The deployed runtime artifacts matching the specified criteria.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getRuntimeArtifacts( org.eclipse.stardust.engine.api.query.DeployedRuntimeArtifactQuery query)

getProcessInstanceLinkType

ProcessInstanceLinkType getProcessInstanceLinkType(String id)
                                                   throws org.eclipse.stardust.common.error.WorkflowException,
                                                          RemoteException
Gets a specific process instance link type.

Parameters:
id - the in of the process instance link type.
Returns:
the process instance link type.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance link type with the specified id. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getProcessInstanceLinkType( java.lang.String id)

getAllProcessInstanceLinkTypes

List<ProcessInstanceLinkType> getAllProcessInstanceLinkTypes()
                                                             throws org.eclipse.stardust.common.error.WorkflowException,
                                                                    RemoteException
Gets all process instance link types defined.

Returns:
a list of process instance link types.
Throws:
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteException
See Also:
QueryService.getAllProcessInstanceLinkTypes()

login

void login(String userId,
           String password)
           throws org.eclipse.stardust.common.error.WorkflowException,
                  RemoteException
Throws:
org.eclipse.stardust.common.error.WorkflowException
RemoteException

login

void login(String userId,
           String password,
           Map properties)
           throws org.eclipse.stardust.common.error.WorkflowException,
                  RemoteException
Throws:
org.eclipse.stardust.common.error.WorkflowException
RemoteException

logout

void logout()
            throws RemoteException
Throws:
RemoteException


Copyright © 2017 Eclipse Stardust. All Rights Reserved.