| org.emforge.BpmService
All known Subclasses: org.emforge.jbpm.BpmServiceImpl, org.emforge.test.BpmTestServiceImpl,
| BpmService | | public interface BpmService (Code) | | Web-Service for working with BPM Data
|
| Method Summary | |
| Boolean | addComment(long taskId, String comment)
| | WorkflowTO | addNewWorkflow(byte[] workflowContent, String comment)
| | StepTO | assignStep(StepTO step, String newActor, String comment)
| | boolean | canAddAttachment(long taskId)
| | boolean | canAddNewWorkflow()
| | boolean | canChangeStep(StepTO step)
| | boolean | canChangeTask(TaskTO task)
| | boolean | canCommentTask(long taskId)
| | boolean | canCompleteStep(StepTO step)
| | boolean | canEditTaskDescription(TaskTO task)
| | boolean | canReadTask(long stepId)
| | boolean | canReassignSteps(TaskTO task)
| | boolean | canStartNewTask(String projectName)
| | boolean | canStopTask(TaskTO task)
| | StepTO | changeStepPriority(StepTO step, PriorityTO newPriority, String comment)
| | TaskTO | completeStep(StepTO step, String transitionName, String comment)
| | List<TaskTO> | findTasks(String milestoneName, TaskStatus taskStatus, boolean includeSubTasks)
Find tasks
We will have reporting service, allowed us to generate reports for any criteria. | | List<StepTO> | getActiveSteps(String projectName)
| | StepTO[] | getBlockingSteps(long taskId)
| | TaskTO[] | getBlockingSubTasks(long taskId)
| | TaskTO[] | getFinishedSubTasks(long taskId)
| | StepTO | getStep(long stepId)
| | TaskTO | getTask(long taskId)
| | CommentTO[] | getTaskComments(long taskId)
| | HistoryTO[] | getTaskHistory(long taskId)
| | WorkflowTO[] | getUsedWorkflows(String name, int version)
| | WorkflowTO | getWorkflowById(long workflowId)
Return workflow by id
Parameters:
workflowId - - id of workflow Workflow object for specified id. | | WorkflowTO | getWorkflowByName(String name, int version)
Return workflow by name and version
Parameters:
name - - name of workflow
Parameters:
version - - version. | | HistoryTO[] | getWorkflowHistory(String name, int version)
| | byte[] | getWorkflowIcon(long workflowId)
| | byte[] | getWorkflowImage(long workflowId)
| | StepTO | getWorkflowStartStep(String name, int version, String projectName)
Returns start step for specified workflow.
It is "empty" task - it's id is null since it is not created. | | WorkflowTO[] | getWorkflows()
| | Boolean | hasTask(long taskId)
| | Boolean | hasWorkflow(String name, int version)
Return true if workflow exists
Parameters:
name - - name of workflow to find
Parameters:
version - - version. | | Boolean | isPossibleRequestStatus(long stepId)
| | Boolean | requestStatus(long stepId, String request)
| | Boolean | saveTask(TaskTO task, String comment)
| | TaskTO | startSubTask(long parentStepId, StepTO startStep, String transitionName, String tempPageName)
| | TaskTO | startTask(StepTO startStep, String transitionName, String tempPageName)
Starts new task
Parameters:
startStep - - information about started task like: priority, variable values, required by start task, dueDate and so on
Parameters:
transitionName - - name of transition, should be used for completing start-task
Parameters:
tempPageName - - in case then description and attachments was specified for task,they were stored in temporare Wiki-Page. | | Boolean | stopTask(long taskId, String comment)
| | String | writeWorkflowImageTable(WorkflowTO i_workflow, TaskTO i_task, StepTO i_step)
|
| WORKFLOW_LAST_VERSION | | final public static int WORKFLOW_LAST_VERSION(Code) | | |
| addNewWorkflow | | WorkflowTO addNewWorkflow(byte[] workflowContent, String comment) throws EmForgeException(Code) | | Add new workflow
Parameters:
workflowContent - - content of par-file
Parameters:
comment - - comment for this deployment create workflow |
| canAddAttachment | | boolean canAddAttachment(long taskId)(Code) | | Is Current user allowed to add attachment for task
Parameters:
taskId - |
| canAddNewWorkflow | | boolean canAddNewWorkflow()(Code) | | Is current user allowed to add new workflows
|
| canChangeStep | | boolean canChangeStep(StepTO step)(Code) | | Is current user allowed to change the step
Parameters:
stepId - |
| canChangeTask | | boolean canChangeTask(TaskTO task)(Code) | | Is current user allowed to change the task
Parameters:
taskId - |
| canCommentTask | | boolean canCommentTask(long taskId)(Code) | | Is current user allowed to add comment for the task
Parameters:
taskId - |
| canCompleteStep | | boolean canCompleteStep(StepTO step)(Code) | | is current user allowed to complete specified step
Parameters:
stepId - |
| canEditTaskDescription | | boolean canEditTaskDescription(TaskTO task)(Code) | | Is Current User allowed to edit task description
Parameters:
taskId - |
| canReadTask | | boolean canReadTask(long stepId)(Code) | | is current user allowed to read specified task
Parameters:
stepId - |
| canReassignSteps | | boolean canReassignSteps(TaskTO task)(Code) | | Is Current user allowed to reassign the steps for specified task
Parameters:
taskId - |
| canStartNewTask | | boolean canStartNewTask(String projectName)(Code) | | Is Current user allowed to start new tasks for specified project
Parameters:
projectName - |
| canStopTask | | boolean canStopTask(TaskTO task)(Code) | | Is current user allowed to close the specified task
Parameters:
taskId - |
| completeStep | | TaskTO completeStep(StepTO step, String transitionName, String comment) throws EmForgeException(Code) | | Complete step
Parameters:
step - - step to be completed with all required variables set
Parameters:
transitionName - - transaction name, should be used for completion
Parameters:
comment - - comment related to completion - new state of Task processed
throws:
EmForgeException - |
| findTasks | | List<TaskTO> findTasks(String milestoneName, TaskStatus taskStatus, boolean includeSubTasks) throws EmForgeException(Code) | | Find tasks
We will have reporting service, allowed us to generate reports for any criteria.
But - we will need also some easy-reporting - there we will able find and display list of tasks
This is initial version of method, implemented this 'easy-reporting' it's interface will be changed in future
to support more options for search
Parameters:
milestoneName - -
Parameters:
status -
Parameters:
includeSubTasks - |
| getBlockingSubTasks | | TaskTO[] getBlockingSubTasks(long taskId) throws EmForgeException(Code) | | Returns list of currently active subtasks for specified task
Parameters:
taskId - - parent task id list of active sub-tasks |
| getFinishedSubTasks | | TaskTO[] getFinishedSubTasks(long taskId) throws EmForgeException(Code) | | Returns list of finished subtasks for specified task
Parameters:
taskId - - parent task id list of finished sub-tasks |
| getStep | | StepTO getStep(long stepId) throws EmForgeException(Code) | | Returns Specific Step by ID
Parameters:
stepId - - step to return step object, or null if nothing found |
| getTask | | TaskTO getTask(long taskId) throws EmForgeException(Code) | | Returns Specific Task by ID
Parameters:
taskId - - task to return task object, or null if nothing found |
| getTaskComments | | CommentTO[] getTaskComments(long taskId) throws EmForgeException(Code) | | Returns Comments for Specified Task
Parameters:
taskId - - id of task we need to get comments array of task comments |
| getWorkflowById | | WorkflowTO getWorkflowById(long workflowId) throws EmForgeException(Code) | | Return workflow by id
Parameters:
workflowId - - id of workflow Workflow object for specified id. Null is not found |
| getWorkflowByName | | WorkflowTO getWorkflowByName(String name, int version) throws EmForgeException(Code) | | Return workflow by name and version
Parameters:
name - - name of workflow
Parameters:
version - - version. If -1 is used - means last version of specified workflow Workflow object for specified name and version. Null is not found |
| getWorkflowHistory | | HistoryTO[] getWorkflowHistory(String name, int version) throws EmForgeException(Code) | | Retunrs history for workflow versions
Parameters:
name - - workflow name to get history
Parameters:
version - - workflow version to get history
throws:
EmForgeException - |
| getWorkflowIcon | | byte[] getWorkflowIcon(long workflowId)(Code) | | Method used in Process Icon Servlet
Parameters:
workflowId - |
| getWorkflowImage | | byte[] getWorkflowImage(long workflowId)(Code) | | Returns workflow image
Parameters:
workflowId - |
| getWorkflowStartStep | | StepTO getWorkflowStartStep(String name, int version, String projectName) throws EmForgeException(Code) | | Returns start step for specified workflow.
It is "empty" task - it's id is null since it is not created.
It should be used for filling required variables and any other required information,
getting information about transition, and starting new task later with passing this step back
Parameters:
name - - started workflow name
Parameters:
version - - started workflow version
Parameters:
projectName - - name of project, for which workflow is created |
| hasTask | | Boolean hasTask(long taskId)(Code) | | Returns trie if task for specified workflow exists
Parameters:
taskId - - task to find |
| hasWorkflow | | Boolean hasWorkflow(String name, int version)(Code) | | Return true if workflow exists
Parameters:
name - - name of workflow to find
Parameters:
version - - version. If -1 is used - means last version of specified workflow |
| isPossibleRequestStatus | | Boolean isPossibleRequestStatus(long stepId) throws EmForgeException(Code) | | Is it possible for currently logged user request a status for specified step
Parameters:
stepId - - step id to check true if it is possible to request status
throws:
EmForgeException - |
| startSubTask | | TaskTO startSubTask(long parentStepId, StepTO startStep, String transitionName, String tempPageName) throws EmForgeException(Code) | | Create subtask for specified step
Parameters:
parentStepId - - step used as parent step for new task
Parameters:
startStep - - starting information for subtask
Parameters:
transitionName - - transition should be used for finishing start task
Parameters:
tempPageName - - temprorary page name, used for storing description and attachments
throws:
EmForgeException - |
| startTask | | TaskTO startTask(StepTO startStep, String transitionName, String tempPageName) throws EmForgeException(Code) | | Starts new task
Parameters:
startStep - - information about started task like: priority, variable values, required by start task, dueDate and so on
Parameters:
transitionName - - name of transition, should be used for completing start-task
Parameters:
tempPageName - - in case then description and attachments was specified for task,they were stored in temporare Wiki-Page. this param contains name of this pageMay be empty created task |
| stopTask | | Boolean stopTask(long taskId, String comment) throws EmForgeException(Code) | | Stop Specified Task
Parameters:
taskId - - id of task we need to stop
Parameters:
comment - - comment specified why task is stopped (may be empty) true is task stopped, othervise false |
| writeWorkflowImageTable | | String writeWorkflowImageTable(WorkflowTO i_workflow, TaskTO i_task, StepTO i_step) throws EmForgeException(Code) | | Very specific method
This code got from jBPM and used for image generation
It should be used onli inside ProcessImageComponent
Parameters:
writer -
Parameters:
i_workflow -
Parameters:
i_task -
Parameters:
i_step -
throws:
DocumentException -
throws:
IOException - |
|
|