org.eclipse.stardust.engine.api.ws
Interface IQueryService


public interface IQueryService

Provides information services for the CARNOT runtime environment. The functionality includes the following tasks: retrieve or counts elements in the audit trail (users, process instance, activity instances or log events), retrieve deployed models from the audit trails, retrieve participants from the models. A Query service always operates against an audit trail database. This class was generated by Apache CXF 2.6.1 2016-02-25T15:28:24.674+01:00 Generated source version: 2.6.1


Method Summary
 ActivityQueryResultXto findActivities(ActivityQueryXto query)
          Retrieves all activity instances satisfying the criteria specified in the provided query.
 DepartmentsXto findAllDepartments(DepartmentInfoXto parent, OrganizationInfoXto organization)
          Retrieves all the departments satisfying the search criteria.
 DepartmentXto findDepartment(DepartmentInfoXto parent, OrganizationInfoXto organization, String id)
          Searches for a department having the specified id in the scope defined by the parent department.
 LogEntryQueryResultXto findLogEntries(LogEntryQueryXto logEntryQuery)
          Retrieves all log entries satisfying the criteria specified in the provided query.
 ModelsQueryResultXto findModels(DeployedModelQueryXto deployedModelQuery)
          documentation
 PreferencesListXto findPreferences(PreferenceQueryXto preferenceQuery)
          documentation
 ProcessDefinitionQueryResultXto findProcessDefinitions(ProcessDefinitionQueryXto query)
          Retrieves all process instances satisfying the criteria specified in the provided query.
 ProcessInstanceQueryResultXto findProcesses(ProcessQueryXto query)
          Retrieves all process instances satisfying the criteria specified in the provided query.
 DeployedRuntimeArtifactQueryResultXto findRuntimeArtifacts(DeployedRuntimeArtifactQueryXto deployedRuntimeArtifactQuery)
          Retrieves all DeployedRuntimeArtifacts satisfying the criteria specified in the provided query.
 UserGroupQueryResultXto findUserGroups(UserGroupQueryXto userGroupQuery)
          Retrieves all user groups satisfying the criteria specified in the provided query.
 UserQueryResultXto findUsers(UserQueryXto userQuery)
          Retrieves all users satisfying the criteria specified in the provided query.
 VariableDefinitionQueryResultXto findVariableDefinitions(VariableDefinitionQueryXto variableDefinitionQuery)
          Retrieves all variable definitions satisfying the criteria specified in the provided query.
 ModelDescriptionsXto getAllAliveModelDescriptions()
          Retrieves the list of model descriptions for all alive models.
 BusinessObjectsXto getAllBusinessObjects(BusinessObjectQueryXto businessObjectQuery)
          documentation
 DocumentQueryResultXto getAllDocuments(DocumentQueryXto query)
          Gets Documents based on the specified DocumentQuery.
 ModelDescriptionsXto getAllModelDescriptions()
          Retrieves the list of model descriptions for all deployed models.
 ParticipantsXto getAllParticipants(Long modelOid)
          Retrieves all participants defined in the active or specified model.
 ProcessDefinitionsXto getAllProcessDefinitions(Long modelOid)
          Retrieves all process definitions for the active or specified model.
 ModelXto getModel(Long modelOid, Boolean computeAliveness)
          Retrieves the specified model.
 XmlValueXto getModelAsXML(Long modelOid)
          Retrieves the XML representation of the specified model.
 ModelDescriptionXto getModelDescription(Long modelOid)
          Retrieves the description of the specified model.
 ParticipantXto getParticipant(String participantId, Long modelOid)
          Retrieves a participant from a active or specified model.
 PermissionsXto getPermissions()
          Retrieves all permissions the current user has on this service.
 PreferencesXto getPreferences(PreferenceScopeXto scope, String moduleId, String preferencesId)
          documentation
 ProcessDefinitionXto getProcessDefinition(String processId, Long modelOid)
          Retrieves a process definition from the active or specified model.
 RuntimeArtifactXto getRuntimeArtifact(long oid)
          Retrieves the artifact by the unique oid.
 XmlValueXto getSchemaDefinition(QName type, Long modelOid)
          Retrieves XSD schema of the specified type declaration.
 

Method Detail

getRuntimeArtifact

@RequestWrapper(localName="getRuntimeArtifact",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetRuntimeArtifact")
@ResponseWrapper(localName="getRuntimeArtifactResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetRuntimeArtifactResponse")
RuntimeArtifactXto getRuntimeArtifact(long oid)
                                      throws BpmFault
Retrieves the artifact by the unique oid.

Throws:
BpmFault

findProcessDefinitions

@RequestWrapper(localName="findProcessDefinitions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindProcessDefinitions")
@ResponseWrapper(localName="findProcessDefinitionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindProcessDefinitionsResponse")
ProcessDefinitionQueryResultXto findProcessDefinitions(ProcessDefinitionQueryXto query)
                                                       throws BpmFault
Retrieves all process instances satisfying the criteria specified in the provided query.

Throws:
BpmFault

getAllAliveModelDescriptions

@RequestWrapper(localName="getAllAliveModelDescriptions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetAllAliveModelDescriptions")
@ResponseWrapper(localName="getAllAliveModelDescriptionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetAllAliveModelDescriptionsResponse")
ModelDescriptionsXto getAllAliveModelDescriptions()
                                                  throws BpmFault
Retrieves the list of model descriptions for all alive models.

Throws:
BpmFault

getModelAsXML

@RequestWrapper(localName="getModelAsXML",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetModelAsXML")
@ResponseWrapper(localName="getModelAsXMLResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetModelAsXMLResponse")
XmlValueXto getModelAsXML(Long modelOid)
                          throws BpmFault
Retrieves the XML representation of the specified model.

Throws:
BpmFault

findModels

@RequestWrapper(localName="findModels",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindModels")
@ResponseWrapper(localName="findModelsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindModelsResponse")
ModelsQueryResultXto findModels(DeployedModelQueryXto deployedModelQuery)
                                throws BpmFault
documentation

Throws:
BpmFault

getModel

@RequestWrapper(localName="getModel",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetModel")
@ResponseWrapper(localName="getModelResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetModelResponse")
ModelXto getModel(Long modelOid,
                                                                                                                   Boolean computeAliveness)
                  throws BpmFault
Retrieves the specified model.

Throws:
BpmFault

findPreferences

@RequestWrapper(localName="findPreferences",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindPreferences")
@ResponseWrapper(localName="findPreferencesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindPreferencesResponse")
PreferencesListXto findPreferences(PreferenceQueryXto preferenceQuery)
                                   throws BpmFault
documentation

Throws:
BpmFault

findVariableDefinitions

@RequestWrapper(localName="findVariableDefinitions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindVariableDefinitions")
@ResponseWrapper(localName="findVariableDefinitionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindVariableDefinitionsResponse")
VariableDefinitionQueryResultXto findVariableDefinitions(VariableDefinitionQueryXto variableDefinitionQuery)
                                                         throws BpmFault
Retrieves all variable definitions satisfying the criteria specified in the provided query.

Throws:
BpmFault

findUsers

@RequestWrapper(localName="findUsers",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindUsers")
@ResponseWrapper(localName="findUsersResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindUsersResponse")
UserQueryResultXto findUsers(UserQueryXto userQuery)
                             throws BpmFault
Retrieves all users satisfying the criteria specified in the provided query.

Throws:
BpmFault

getAllModelDescriptions

@RequestWrapper(localName="getAllModelDescriptions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetAllModelDescriptions")
@ResponseWrapper(localName="getAllModelDescriptionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetAllModelDescriptionsResponse")
ModelDescriptionsXto getAllModelDescriptions()
                                             throws BpmFault
Retrieves the list of model descriptions for all deployed models.

Throws:
BpmFault

getSchemaDefinition

@RequestWrapper(localName="getSchemaDefinition",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetSchemaDefinition")
@ResponseWrapper(localName="getSchemaDefinitionResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetSchemaDefinitionResponse")
XmlValueXto getSchemaDefinition(QName type,
                                                                                                                                 Long modelOid)
                                throws BpmFault
Retrieves XSD schema of the specified type declaration.

Throws:
BpmFault

findAllDepartments

@RequestWrapper(localName="findAllDepartments",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindAllDepartments")
@ResponseWrapper(localName="findAllDepartmentsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindAllDepartmentsResponse")
DepartmentsXto findAllDepartments(DepartmentInfoXto parent,
                                                                                                                                   OrganizationInfoXto organization)
                                  throws BpmFault
Retrieves all the departments satisfying the search criteria.

Throws:
BpmFault

findUserGroups

@RequestWrapper(localName="findUserGroups",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindUserGroups")
@ResponseWrapper(localName="findUserGroupsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindUserGroupsResponse")
UserGroupQueryResultXto findUserGroups(UserGroupQueryXto userGroupQuery)
                                       throws BpmFault
Retrieves all user groups satisfying the criteria specified in the provided query.

Throws:
BpmFault

getParticipant

@RequestWrapper(localName="getParticipant",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetParticipant")
@ResponseWrapper(localName="getParticipantResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetParticipantResponse")
ParticipantXto getParticipant(String participantId,
                                                                                                                               Long modelOid)
                              throws BpmFault
Retrieves a participant from a active or specified model.

Throws:
BpmFault

getPermissions

@RequestWrapper(localName="getPermissions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetPermissions")
@ResponseWrapper(localName="getPermissionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetPermissionsResponse")
PermissionsXto getPermissions()
                              throws BpmFault
Retrieves all permissions the current user has on this service.

Throws:
BpmFault

getAllParticipants

@RequestWrapper(localName="getAllParticipants",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetAllParticipants")
@ResponseWrapper(localName="getAllParticipantsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetAllParticipantsResponse")
ParticipantsXto getAllParticipants(Long modelOid)
                                   throws BpmFault
Retrieves all participants defined in the active or specified model.

Throws:
BpmFault

getAllBusinessObjects

@RequestWrapper(localName="getAllBusinessObjects",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetAllBusinessObjects")
@ResponseWrapper(localName="getAllBusinessObjectsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetAllBusinessObjectsResponse")
BusinessObjectsXto getAllBusinessObjects(BusinessObjectQueryXto businessObjectQuery)
                                         throws BpmFault
documentation

Throws:
BpmFault

getPreferences

@RequestWrapper(localName="getPreferences",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetPreferences")
@ResponseWrapper(localName="getPreferencesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetPreferencesResponse")
PreferencesXto getPreferences(PreferenceScopeXto scope,
                                                                                                                               String moduleId,
                                                                                                                               String preferencesId)
                              throws BpmFault
documentation

Throws:
BpmFault

getAllDocuments

@RequestWrapper(localName="getAllDocuments",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetAllDocuments")
@ResponseWrapper(localName="getAllDocumentsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetAllDocumentsResponse")
DocumentQueryResultXto getAllDocuments(DocumentQueryXto query)
                                       throws BpmFault
Gets Documents based on the specified DocumentQuery.

Throws:
BpmFault

findRuntimeArtifacts

@RequestWrapper(localName="findRuntimeArtifacts",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindRuntimeArtifacts")
@ResponseWrapper(localName="findRuntimeArtifactsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindRuntimeArtifactsResponse")
DeployedRuntimeArtifactQueryResultXto findRuntimeArtifacts(DeployedRuntimeArtifactQueryXto deployedRuntimeArtifactQuery)
                                                           throws BpmFault
Retrieves all DeployedRuntimeArtifacts satisfying the criteria specified in the provided query.

Throws:
BpmFault

findLogEntries

@RequestWrapper(localName="findLogEntries",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindLogEntries")
@ResponseWrapper(localName="findLogEntriesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindLogEntriesResponse")
LogEntryQueryResultXto findLogEntries(LogEntryQueryXto logEntryQuery)
                                      throws BpmFault
Retrieves all log entries satisfying the criteria specified in the provided query.

Throws:
BpmFault

findActivities

@RequestWrapper(localName="findActivities",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindActivities")
@ResponseWrapper(localName="findActivitiesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindActivitiesResponse")
ActivityQueryResultXto findActivities(ActivityQueryXto query)
                                      throws BpmFault
Retrieves all activity instances satisfying the criteria specified in the provided query.

Throws:
BpmFault

getAllProcessDefinitions

@RequestWrapper(localName="getAllProcessDefinitions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetAllProcessDefinitions")
@ResponseWrapper(localName="getAllProcessDefinitionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetAllProcessDefinitionsResponse")
ProcessDefinitionsXto getAllProcessDefinitions(Long modelOid)
                                               throws BpmFault
Retrieves all process definitions for the active or specified model.

Throws:
BpmFault

getModelDescription

@RequestWrapper(localName="getModelDescription",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetModelDescription")
@ResponseWrapper(localName="getModelDescriptionResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetModelDescriptionResponse")
ModelDescriptionXto getModelDescription(Long modelOid)
                                        throws BpmFault
Retrieves the description of the specified model.

Throws:
BpmFault

findProcesses

@RequestWrapper(localName="findProcesses",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindProcesses")
@ResponseWrapper(localName="findProcessesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindProcessesResponse")
ProcessInstanceQueryResultXto findProcesses(ProcessQueryXto query)
                                            throws BpmFault
Retrieves all process instances satisfying the criteria specified in the provided query.

Throws:
BpmFault

findDepartment

@RequestWrapper(localName="findDepartment",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindDepartment")
@ResponseWrapper(localName="findDepartmentResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindDepartmentResponse")
DepartmentXto findDepartment(DepartmentInfoXto parent,
                                                                                                                              OrganizationInfoXto organization,
                                                                                                                              String id)
                             throws BpmFault
Searches for a department having the specified id in the scope defined by the parent department.

Throws:
BpmFault

getProcessDefinition

@RequestWrapper(localName="getProcessDefinition",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetProcessDefinition")
@ResponseWrapper(localName="getProcessDefinitionResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetProcessDefinitionResponse")
ProcessDefinitionXto getProcessDefinition(String processId,
                                                                                                                                           Long modelOid)
                                          throws BpmFault
Retrieves a process definition from the active or specified model.

Throws:
BpmFault


Copyright © 2017 Eclipse Stardust. All Rights Reserved.