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


public interface IAdministrationService

Provides administration services for the CARNOT runtime environment. The functionality includes the following tasks: manage the workflow models (deploy, modify or delete) recover the runtime environment or single workflow objects terminate running process instances manage the life cycle management of CARNOT daemons An administration service always operates against an audit trail database. The administration service requires that the user performing tasks has been assigned to the predefined role Administrator. This class was generated by Apache CXF 2.6.1 2016-02-25T15:28:24.572+01:00 Generated source version: 2.6.1


Method Summary
 ProcessInstanceXto abortProcessInstance(long oid, AbortScopeXto abortScope)
          Aborts a process instance disregarding any activities which were or are performed by the process instance.
 void cleanupRuntime(boolean keepUsers)
          Removes all records from the runtime environment making up the audit trail database.
 void cleanupRuntimeAndModels()
          Removes all records from the runtime environment making up the audit trail database.
 DepartmentXto createDepartment(String id, String name, String description, DepartmentInfoXto parent, OrganizationInfoXto organization)
          Creates a new department.
 DeploymentInfoXto deleteModel(int modelOid)
          Deletes the specified model.
 void deleteProcesses(org.eclipse.stardust.engine.api.ws.DeleteProcesses.OidsXto oids)
          Deletes process instances from the audit trail.
 void deleteRuntimeArtifact(long oid)
          Deleted a deployed artifact by oid.
 DeploymentInfoXto deployModel(Integer predecessorOid, Date validFrom, Date validTo, String comment, Boolean disabled, Boolean ignoreWarnings, String configuration, XmlValueXto xml)
          Deploys a new model.
 DeployedRuntimeArtifactXto deployRuntimeArtifact(RuntimeArtifactXto runtimeArtifact)
          Deploys a new artifact with a new oid.
 void flushCaches()
          Flushes all internal caches, effectively returning the engine to a state just like after it has started.
 ActivityInstanceXto forceCompletion(long activityOid, ParametersXto outDataValues)
          Forces the completion of a non-interactive activity instance.
 ActivityInstanceXto forceSuspend(long activityOid)
          Forces an activity instance to be suspended.
 AuditTrailHealthReportXto getAuditTrailHealthReport()
          Determines key indicators of audit trail health.
 ConfigurationVariablesListXto getConfigurationVariables(StringListXto modelIds, XmlValueXto modelXml)
          Retrieves merged configuration variables from all models matching the specified modelIds.
 DaemonsXto getDaemonStatus(DaemonParametersXto daemonParameters)
          Retrieves the specified daemon status.
 DepartmentXto getDepartment(long oid)
          Retrieves the department with the given oid.
 RuntimePermissionsXto getGlobalPermissions()
          Retrieves permissions that are globally set.
 PasswordRulesXto getPasswordRules()
          Returns the password rules.
 PermissionsXto getPermissions()
          Retrieves all permissions the current user has on this service.
 PreferencesXto getPreferences(PreferenceScopeXto scope, String moduleId, String preferencesId)
          Retrieves preferences from the given scope.
 RuntimeArtifactXto getRuntimeArtifact(long oid)
          Retrieves the artifact by the unique oid.
 UserXto getSessionUser()
          Retrieves information on the current user.
 org.eclipse.stardust.engine.api.ws.GetSupportedRuntimeArtifactTypesResponse.ArtifactTypesXto getSupportedRuntimeArtifactTypes()
          Returns a list of supported artifact types.
 DepartmentXto modifyDepartment(long oid, String name, String description)
          Change the description of a department.
 DeploymentInfoXto overwriteModel(int modelOid, Date validFrom, Date validTo, String comment, Boolean disabled, Boolean ignoreWarnings, String configuration, XmlValueXto xml)
          Overwrites the specified model.
 DeployedRuntimeArtifactXto overwriteRuntimeArtifact(long oid, RuntimeArtifactXto runtimeArtifact)
          Overwrites only content of a specified already deployed artifact.
 void recoverProcessInstances(org.eclipse.stardust.engine.api.ws.RecoverProcessInstances.OidsXto oids)
          Recovers the process instances identified by the given list of OIDs and all associated subprocess instances.
 void recoverRuntimeEnvironment()
          Recovers the complete CARNOT runtime environment.
 void removeDepartment(long oid)
          Removes the department having the specified oid, all his children and all user grants associated with the department.
 ModelReconfigurationInfoListXto saveConfigurationVariables(ConfigurationVariablesXto configurationVariables, boolean force)
          Saves changes to configuration variables values.
 void savePreferences(PreferencesListXto preferenceList)
          Saves a complete list of preferences to the preference store.
 void setGlobalPermissions(RuntimePermissionsXto runtimePermissions)
          Saves the changed Permissions.
 void setPasswordRules(PasswordRulesXto passwordRules)
          Set password rule.
 ProcessInstanceXto setProcessInstancePriority(long oid, int priority, Boolean propagateToSubProcesses)
          Changes the process instance priority.
 DaemonsXto startDaemon(DaemonParametersXto daemonParameters)
          Starts the specified daemon.
 ProcessInstanceXto startProcessForModel(long modelOid, String processId, ParametersXto parameters, Boolean startSynchronously, InputDocumentsXto attachments)
          Starts a process from a specified model.
 DaemonsXto stopDaemon(DaemonParametersXto daemonParameters)
          Stops the specified daemon.
 void writeLogEntry(LogTypeXto logType, Long activityOid, Long processOid, String message)
          Logs an audit trail event of type LogCode.ADMINISTRATION.
 

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

getConfigurationVariables

@RequestWrapper(localName="getConfigurationVariables",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetConfigurationVariables")
@ResponseWrapper(localName="getConfigurationVariablesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetConfigurationVariablesResponse")
ConfigurationVariablesListXto getConfigurationVariables(StringListXto modelIds,
                                                                                                                                                         XmlValueXto modelXml)
                                                        throws BpmFault
Retrieves merged configuration variables from all models matching the specified modelIds.

Throws:
BpmFault

deleteModel

@RequestWrapper(localName="deleteModel",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DeleteModel")
@ResponseWrapper(localName="deleteModelResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DeleteModelResponse")
DeploymentInfoXto deleteModel(int modelOid)
                              throws BpmFault
Deletes the specified model.

Throws:
BpmFault

deleteProcesses

@RequestWrapper(localName="deleteProcesses",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DeleteProcesses")
@ResponseWrapper(localName="deleteProcessesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DeleteProcessesResponse")
void deleteProcesses(org.eclipse.stardust.engine.api.ws.DeleteProcesses.OidsXto oids)
                     throws BpmFault
Deletes process instances from the audit trail.

Throws:
BpmFault

abortProcessInstance

@RequestWrapper(localName="abortProcessInstance",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.AbortProcessInstance")
@ResponseWrapper(localName="abortProcessInstanceResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.AbortProcessInstanceResponse")
ProcessInstanceXto abortProcessInstance(long oid,
                                                                                                                                         AbortScopeXto abortScope)
                                        throws BpmFault
Aborts a process instance disregarding any activities which were or are performed by the process instance. Regularly the process instance to be aborted will be set to the state ABORTING synchronously. The returned ProcessInstance object will already be in that state. Before returning the ProcessInstance object, a asynchronous abortion task is scheduled for it. If the process instance is not yet inserted in the database but needs to be aborted for some reason ( e.g. by abort process event) then the abort operation is optimized to happen completely synchronously. In that case the returned ProcessInstance will already be in state ABORTED. This method also aborts all super process instances disregarding the parameter AbortScope.

Throws:
BpmFault

recoverProcessInstances

@RequestWrapper(localName="recoverProcessInstances",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.RecoverProcessInstances")
@ResponseWrapper(localName="recoverProcessInstancesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.RecoverProcessInstancesResponse")
void recoverProcessInstances(org.eclipse.stardust.engine.api.ws.RecoverProcessInstances.OidsXto oids)
                             throws BpmFault
Recovers the process instances identified by the given list of OIDs and all associated subprocess instances.

Throws:
BpmFault

overwriteModel

@RequestWrapper(localName="overwriteModel",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.OverwriteModel")
@ResponseWrapper(localName="overwriteModelResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.OverwriteModelResponse")
DeploymentInfoXto overwriteModel(int modelOid,
                                                                                                                                  Date validFrom,
                                                                                                                                  Date validTo,
                                                                                                                                  String comment,
                                                                                                                                  Boolean disabled,
                                                                                                                                  Boolean ignoreWarnings,
                                                                                                                                  String configuration,
                                                                                                                                  XmlValueXto xml)
                                 throws BpmFault
Overwrites the specified model.

Throws:
BpmFault

getSupportedRuntimeArtifactTypes

@RequestWrapper(localName="getSupportedRuntimeArtifactTypes",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetSupportedRuntimeArtifactTypes")
@ResponseWrapper(localName="getSupportedRuntimeArtifactTypesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetSupportedRuntimeArtifactTypesResponse")
org.eclipse.stardust.engine.api.ws.GetSupportedRuntimeArtifactTypesResponse.ArtifactTypesXto getSupportedRuntimeArtifactTypes()
                                                                                                                              throws BpmFault
Returns a list of supported artifact types.

Throws:
BpmFault

getSessionUser

@RequestWrapper(localName="getSessionUser",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetSessionUser")
@ResponseWrapper(localName="getSessionUserResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetSessionUserResponse")
UserXto getSessionUser()
                       throws BpmFault
Retrieves information on the current user.

Throws:
BpmFault

getPasswordRules

@RequestWrapper(localName="getPasswordRules",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetPasswordRules")
@ResponseWrapper(localName="getPasswordRulesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetPasswordRulesResponse")
PasswordRulesXto getPasswordRules()
                                  throws BpmFault
Returns the password rules.

Throws:
BpmFault

forceSuspend

@RequestWrapper(localName="forceSuspend",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ForceSuspend")
@ResponseWrapper(localName="forceSuspendResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ForceSuspendResponse")
ActivityInstanceXto forceSuspend(long activityOid)
                                 throws BpmFault
Forces an activity instance to be suspended.

Throws:
BpmFault

cleanupRuntime

@RequestWrapper(localName="cleanupRuntime",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CleanupRuntime")
@ResponseWrapper(localName="cleanupRuntimeResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CleanupRuntimeResponse")
void cleanupRuntime(boolean keepUsers)
                    throws BpmFault
Removes all records from the runtime environment making up the audit trail database.

Throws:
BpmFault

startDaemon

@RequestWrapper(localName="startDaemon",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.StartDaemon")
@ResponseWrapper(localName="startDaemonResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.StartDaemonResponse")
DaemonsXto startDaemon(DaemonParametersXto daemonParameters)
                       throws BpmFault
Starts the specified daemon.

Throws:
BpmFault

deleteRuntimeArtifact

@RequestWrapper(localName="deleteRuntimeArtifact",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DeleteRuntimeArtifact")
@ResponseWrapper(localName="deleteRuntimeArtifactResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DeleteRuntimeArtifactResponse")
void deleteRuntimeArtifact(long oid)
                           throws BpmFault
Deleted a deployed artifact by oid.

Throws:
BpmFault

overwriteRuntimeArtifact

@RequestWrapper(localName="overwriteRuntimeArtifact",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.OverwriteRuntimeArtifact")
@ResponseWrapper(localName="overwriteRuntimeArtifactResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.OverwriteRuntimeArtifactResponse")
DeployedRuntimeArtifactXto overwriteRuntimeArtifact(long oid,
                                                                                                                                                     RuntimeArtifactXto runtimeArtifact)
                                                    throws BpmFault
Overwrites only content of a specified already deployed artifact. Other fields cannot be changed.

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

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
Retrieves preferences from the given scope.

Throws:
BpmFault

createDepartment

@RequestWrapper(localName="createDepartment",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CreateDepartment")
@ResponseWrapper(localName="createDepartmentResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CreateDepartmentResponse")
DepartmentXto createDepartment(String id,
                                                                                                                                String name,
                                                                                                                                String description,
                                                                                                                                DepartmentInfoXto parent,
                                                                                                                                OrganizationInfoXto organization)
                               throws BpmFault
Creates a new department.

Throws:
BpmFault

modifyDepartment

@RequestWrapper(localName="modifyDepartment",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ModifyDepartment")
@ResponseWrapper(localName="modifyDepartmentResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ModifyDepartmentResponse")
DepartmentXto modifyDepartment(long oid,
                                                                                                                                String name,
                                                                                                                                String description)
                               throws BpmFault
Change the description of a department.

Throws:
BpmFault

cleanupRuntimeAndModels

@RequestWrapper(localName="cleanupRuntimeAndModels",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CleanupRuntimeAndModels")
@ResponseWrapper(localName="cleanupRuntimeAndModelsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CleanupRuntimeAndModelsResponse")
void cleanupRuntimeAndModels()
                             throws BpmFault
Removes all records from the runtime environment making up the audit trail database.

Throws:
BpmFault

stopDaemon

@RequestWrapper(localName="stopDaemon",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.StopDaemon")
@ResponseWrapper(localName="stopDaemonResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.StopDaemonResponse")
DaemonsXto stopDaemon(DaemonParametersXto daemonParameters)
                      throws BpmFault
Stops the specified daemon.

Throws:
BpmFault

removeDepartment

@RequestWrapper(localName="removeDepartment",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.RemoveDepartment")
@ResponseWrapper(localName="removeDepartmentResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.RemoveDepartmentResponse")
void removeDepartment(long oid)
                      throws BpmFault
Removes the department having the specified oid, all his children and all user grants associated with the department.

Throws:
BpmFault

setPasswordRules

@RequestWrapper(localName="setPasswordRules",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SetPasswordRules")
@ResponseWrapper(localName="setPasswordRulesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SetPasswordRulesResponse")
void setPasswordRules(PasswordRulesXto passwordRules)
                      throws BpmFault
Set password rule.

Throws:
BpmFault

getGlobalPermissions

@RequestWrapper(localName="getGlobalPermissions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetGlobalPermissions")
@ResponseWrapper(localName="getGlobalPermissionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetGlobalPermissionsResponse")
RuntimePermissionsXto getGlobalPermissions()
                                           throws BpmFault
Retrieves permissions that are globally set. For example permissions concerning model deployment, preference saving, modifying AuditTrail, managing deamons ect.

Throws:
BpmFault

getDepartment

@RequestWrapper(localName="getDepartment",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetDepartment")
@ResponseWrapper(localName="getDepartmentResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetDepartmentResponse")
DepartmentXto getDepartment(long oid)
                            throws BpmFault
Retrieves the department with the given oid.

Throws:
BpmFault

deployModel

@RequestWrapper(localName="deployModel",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DeployModel")
@ResponseWrapper(localName="deployModelResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DeployModelResponse")
DeploymentInfoXto deployModel(Integer predecessorOid,
                                                                                                                               Date validFrom,
                                                                                                                               Date validTo,
                                                                                                                               String comment,
                                                                                                                               Boolean disabled,
                                                                                                                               Boolean ignoreWarnings,
                                                                                                                               String configuration,
                                                                                                                               XmlValueXto xml)
                              throws BpmFault
Deploys a new model.

Throws:
BpmFault

getAuditTrailHealthReport

@RequestWrapper(localName="getAuditTrailHealthReport",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetAuditTrailHealthReport")
@ResponseWrapper(localName="getAuditTrailHealthReportResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetAuditTrailHealthReportResponse")
AuditTrailHealthReportXto getAuditTrailHealthReport()
                                                    throws BpmFault
Determines key indicators of audit trail health.

Throws:
BpmFault

flushCaches

@RequestWrapper(localName="flushCaches",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FlushCaches")
@ResponseWrapper(localName="flushCachesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FlushCachesResponse")
void flushCaches()
                 throws BpmFault
Flushes all internal caches, effectively returning the engine to a state just like after it has started.

Throws:
BpmFault

deployRuntimeArtifact

@RequestWrapper(localName="deployRuntimeArtifact",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DeployRuntimeArtifact")
@ResponseWrapper(localName="deployRuntimeArtifactResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DeployRuntimeArtifactResponse")
DeployedRuntimeArtifactXto deployRuntimeArtifact(RuntimeArtifactXto runtimeArtifact)
                                                 throws BpmFault
Deploys a new artifact with a new oid. If an artifact with the same validFrom date already exists, the newly deployed artifact takes priority when querying for active artifacts.

Throws:
BpmFault

recoverRuntimeEnvironment

@RequestWrapper(localName="recoverRuntimeEnvironment",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.RecoverRuntimeEnvironment")
@ResponseWrapper(localName="recoverRuntimeEnvironmentResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.RecoverRuntimeEnvironmentResponse")
void recoverRuntimeEnvironment()
                               throws BpmFault
Recovers the complete CARNOT runtime environment.

Throws:
BpmFault

writeLogEntry

@RequestWrapper(localName="writeLogEntry",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.WriteLogEntry")
@ResponseWrapper(localName="writeLogEntryResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.WriteLogEntryResponse")
void writeLogEntry(LogTypeXto logType,
                                                                                                                    Long activityOid,
                                                                                                                    Long processOid,
                                                                                                                    String message)
                   throws BpmFault
Logs an audit trail event of type LogCode.ADMINISTRATION.

Throws:
BpmFault

startProcessForModel

@RequestWrapper(localName="startProcessForModel",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.StartProcessForModel")
@ResponseWrapper(localName="startProcessForModelResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.StartProcessForModelResponse")
ProcessInstanceXto startProcessForModel(long modelOid,
                                                                                                                                         String processId,
                                                                                                                                         ParametersXto parameters,
                                                                                                                                         Boolean startSynchronously,
                                                                                                                                         InputDocumentsXto attachments)
                                        throws BpmFault
Starts a process from a specified model.

Throws:
BpmFault

getDaemonStatus

@RequestWrapper(localName="getDaemonStatus",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetDaemonStatus")
@ResponseWrapper(localName="getDaemonStatusResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetDaemonStatusResponse")
DaemonsXto getDaemonStatus(DaemonParametersXto daemonParameters)
                           throws BpmFault
Retrieves the specified daemon status.

Throws:
BpmFault

saveConfigurationVariables

@RequestWrapper(localName="saveConfigurationVariables",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SaveConfigurationVariables")
@ResponseWrapper(localName="saveConfigurationVariablesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SaveConfigurationVariablesResponse")
ModelReconfigurationInfoListXto saveConfigurationVariables(ConfigurationVariablesXto configurationVariables,
                                                                                                                                                            boolean force)
                                                           throws BpmFault
Saves changes to configuration variables values.

Throws:
BpmFault

setGlobalPermissions

@RequestWrapper(localName="setGlobalPermissions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SetGlobalPermissions")
@ResponseWrapper(localName="setGlobalPermissionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SetGlobalPermissionsResponse")
void setGlobalPermissions(RuntimePermissionsXto runtimePermissions)
                          throws BpmFault
Saves the changed Permissions. Use getGlobalPermissions to retrieve currently valid global permissions first. Permissions with null or empty lists set as grants will be reset to their internal default. Changed grants are validated against the currently active model for existing model participants.

Throws:
BpmFault

forceCompletion

@RequestWrapper(localName="forceCompletion",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ForceCompletion")
@ResponseWrapper(localName="forceCompletionResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ForceCompletionResponse")
ActivityInstanceXto forceCompletion(long activityOid,
                                                                                                                                     ParametersXto outDataValues)
                                    throws BpmFault
Forces the completion of a non-interactive activity instance. Optionally out data mappings may be provided.

Throws:
BpmFault

savePreferences

@RequestWrapper(localName="savePreferences",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SavePreferences")
@ResponseWrapper(localName="savePreferencesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SavePreferencesResponse")
void savePreferences(PreferencesListXto preferenceList)
                     throws BpmFault
Saves a complete list of preferences to the preference store.

Throws:
BpmFault

setProcessInstancePriority

@RequestWrapper(localName="setProcessInstancePriority",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SetProcessInstancePriority")
@ResponseWrapper(localName="setProcessInstancePriorityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SetProcessInstancePriorityResponse")
ProcessInstanceXto setProcessInstancePriority(long oid,
                                                                                                                                               int priority,
                                                                                                                                               Boolean propagateToSubProcesses)
                                              throws BpmFault
Changes the process instance priority.

Throws:
BpmFault


Copyright © 2017 Eclipse Stardust. All Rights Reserved.