IWorkflowManagerLocal (docdoku-api-java 2.5-SNAPSHOT API)

```
public interface IWorkflowManagerLocal
```
Since:

V1.0

Version:

2.0, 11/10/14

Author:

Florent Garin

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`approveTaskOnWorkspaceWorkflow(String workspaceId, TaskKey taskKey, String comment, String signature)`
`Role`	`createRole(String roleName, String workspaceId, List<String> userLogins, List<String> userGroupIds)`
`WorkflowModel`	`createWorkflowModel(String pWorkspaceId, String pId, String pFinalLifeCycleState, ActivityModel[] pActivityModels)`
`void`	`deleteRole(RoleKey roleKey)`
`void`	`deleteWorkflowModel(WorkflowModelKey pKey)`
`void`	`deleteWorkspaceWorkflow(String workspaceId, String workspaceWorkflowId)`
`Role[]`	`getRoles(String pWorkspaceId)`
`Role[]`	`getRolesInUse(String pWorkspaceId)`
`Workflow`	`getWorkflow(String workspaceId, int workflowId)`
`Workflow[]`	`getWorkflowAbortedWorkflowList(String workspaceId, int workflowId)`
`WorkflowModel`	`getWorkflowModel(WorkflowModelKey pKey)`
`WorkflowModel[]`	`getWorkflowModels(String pWorkspaceId)`
`WorkspaceWorkflow`	`getWorkspaceWorkflow(String workspaceId, String workspaceWorkflowId)`
`WorkspaceWorkflow[]`	`getWorkspaceWorkflowList(String workspaceId)`
`WorkspaceWorkflow`	`instantiateWorkflow(String workspaceId, String id, String workflowModelId, Map<String,Collection<String>> userRoleMapping, Map<String,Collection<String>> groupRoleMapping)`
`void`	`rejectTaskOnWorkspaceWorkflow(String workspaceId, TaskKey taskKey, String comment, String signature)`
`void`	`removeACLFromWorkflow(String pWorkspaceId, String workflowModelId)`
`void`	`removeUserFromAllRoleMappings(User pUser)`
`void`	`removeUserGroupFromAllRoleMappings(UserGroup pUserGroup)`
`WorkflowModel`	`updateACLForWorkflow(String pWorkspaceId, String workflowModelId, Map<String,String> userEntries, Map<String,String> groupEntries)`
`Role`	`updateRole(RoleKey roleKey, List<String> userLogins, List<String> userGroupIds)`
`WorkflowModel`	`updateWorkflowModel(WorkflowModelKey workflowModelKey, String pFinalLifeCycleState, ActivityModel[] pActivityModels)`

Method Detail

deleteWorkflowModel

void deleteWorkflowModel(WorkflowModelKey pKey)
                  throws WorkspaceNotFoundException,
                         AccessRightException,
                         WorkflowModelNotFoundException,
                         UserNotFoundException,
                         UserNotActiveException,
                         EntityConstraintException,
                         WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; AccessRightException; WorkflowModelNotFoundException; UserNotFoundException; UserNotActiveException; EntityConstraintException; WorkspaceNotEnabledException

getWorkflowModel

WorkflowModel getWorkflowModel(WorkflowModelKey pKey)
                        throws WorkspaceNotFoundException,
                               WorkflowModelNotFoundException,
                               UserNotFoundException,
                               UserNotActiveException,
                               WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; WorkflowModelNotFoundException; UserNotFoundException; UserNotActiveException; WorkspaceNotEnabledException

getWorkflowModels

WorkflowModel[] getWorkflowModels(String pWorkspaceId)
                           throws WorkspaceNotFoundException,
                                  UserNotFoundException,
                                  UserNotActiveException,
                                  WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; UserNotFoundException; UserNotActiveException; WorkspaceNotEnabledException

createWorkflowModel

WorkflowModel createWorkflowModel(String pWorkspaceId,
                                  String pId,
                                  String pFinalLifeCycleState,
                                  ActivityModel[] pActivityModels)
                           throws WorkspaceNotFoundException,
                                  AccessRightException,
                                  WorkflowModelAlreadyExistsException,
                                  UserNotFoundException,
                                  CreationException,
                                  NotAllowedException,
                                  WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; AccessRightException; WorkflowModelAlreadyExistsException; UserNotFoundException; CreationException; NotAllowedException; WorkspaceNotEnabledException

updateWorkflowModel

WorkflowModel updateWorkflowModel(WorkflowModelKey workflowModelKey,
                                  String pFinalLifeCycleState,
                                  ActivityModel[] pActivityModels)
                           throws UserNotFoundException,
                                  WorkspaceNotFoundException,
                                  UserNotActiveException,
                                  AccessRightException,
                                  WorkflowModelNotFoundException,
                                  NotAllowedException,
                                  WorkflowModelAlreadyExistsException,
                                  CreationException,
                                  WorkspaceNotEnabledException

Throws:: UserNotFoundException; WorkspaceNotFoundException; UserNotActiveException; AccessRightException; WorkflowModelNotFoundException; NotAllowedException; WorkflowModelAlreadyExistsException; CreationException; WorkspaceNotEnabledException

getRoles

Role[] getRoles(String pWorkspaceId)
         throws WorkspaceNotFoundException,
                UserNotFoundException,
                UserNotActiveException,
                WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; UserNotFoundException; UserNotActiveException; WorkspaceNotEnabledException

getRolesInUse

Role[] getRolesInUse(String pWorkspaceId)
              throws WorkspaceNotFoundException,
                     UserNotFoundException,
                     UserNotActiveException,
                     WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; UserNotFoundException; UserNotActiveException; WorkspaceNotEnabledException

createRole

Role createRole(String roleName,
                String workspaceId,
                List<String> userLogins,
                List<String> userGroupIds)
         throws WorkspaceNotFoundException,
                UserNotFoundException,
                UserNotActiveException,
                AccessRightException,
                RoleAlreadyExistsException,
                CreationException,
                UserGroupNotFoundException,
                WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; UserNotFoundException; UserNotActiveException; AccessRightException; RoleAlreadyExistsException; CreationException; UserGroupNotFoundException; WorkspaceNotEnabledException

updateRole

Role updateRole(RoleKey roleKey,
                List<String> userLogins,
                List<String> userGroupIds)
         throws WorkspaceNotFoundException,
                UserNotFoundException,
                UserNotActiveException,
                AccessRightException,
                RoleNotFoundException,
                UserGroupNotFoundException,
                WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; UserNotFoundException; UserNotActiveException; AccessRightException; RoleNotFoundException; UserGroupNotFoundException; WorkspaceNotEnabledException

deleteRole

void deleteRole(RoleKey roleKey)
         throws WorkspaceNotFoundException,
                UserNotFoundException,
                UserNotActiveException,
                AccessRightException,
                RoleNotFoundException,
                EntityConstraintException,
                WorkspaceNotEnabledException

Throws:: WorkspaceNotFoundException; UserNotFoundException; UserNotActiveException; AccessRightException; RoleNotFoundException; EntityConstraintException; WorkspaceNotEnabledException

removeUserFromAllRoleMappings

void removeUserFromAllRoleMappings(User pUser)
                            throws UserNotFoundException,
                                   AccessRightException,
                                   WorkspaceNotFoundException,
                                   WorkspaceNotEnabledException

Throws:: UserNotFoundException; AccessRightException; WorkspaceNotFoundException; WorkspaceNotEnabledException

removeUserGroupFromAllRoleMappings

void removeUserGroupFromAllRoleMappings(UserGroup pUserGroup)
                                 throws UserNotFoundException,
                                        AccessRightException,
                                        WorkspaceNotFoundException,
                                        WorkspaceNotEnabledException

Throws:: UserNotFoundException; AccessRightException; WorkspaceNotFoundException; WorkspaceNotEnabledException

removeACLFromWorkflow

void removeACLFromWorkflow(String pWorkspaceId,
                           String workflowModelId)
                    throws WorkflowNotFoundException,
                           UserNotFoundException,
                           UserNotActiveException,
                           WorkspaceNotFoundException,
                           WorkflowModelNotFoundException,
                           AccessRightException,
                           WorkspaceNotEnabledException

Throws:: WorkflowNotFoundException; UserNotFoundException; UserNotActiveException; WorkspaceNotFoundException; WorkflowModelNotFoundException; AccessRightException; WorkspaceNotEnabledException

updateACLForWorkflow

WorkflowModel updateACLForWorkflow(String pWorkspaceId,
                                   String workflowModelId,
                                   Map<String,String> userEntries,
                                   Map<String,String> groupEntries)
                            throws WorkflowNotFoundException,
                                   UserNotFoundException,
                                   UserNotActiveException,
                                   WorkspaceNotFoundException,
                                   WorkflowModelNotFoundException,
                                   AccessRightException,
                                   WorkspaceNotEnabledException

Throws:: WorkflowNotFoundException; UserNotFoundException; UserNotActiveException; WorkspaceNotFoundException; WorkflowModelNotFoundException; AccessRightException; WorkspaceNotEnabledException

instantiateWorkflow

WorkspaceWorkflow instantiateWorkflow(String workspaceId,
                                      String id,
                                      String workflowModelId,
                                      Map<String,Collection<String>> userRoleMapping,
                                      Map<String,Collection<String>> groupRoleMapping)
                               throws UserNotFoundException,
                                      AccessRightException,
                                      WorkspaceNotFoundException,
                                      RoleNotFoundException,
                                      WorkflowModelNotFoundException,
                                      NotAllowedException,
                                      UserGroupNotFoundException,
                                      WorkspaceNotEnabledException

Throws:: UserNotFoundException; AccessRightException; WorkspaceNotFoundException; RoleNotFoundException; WorkflowModelNotFoundException; NotAllowedException; UserGroupNotFoundException; WorkspaceNotEnabledException

getWorkflow

Workflow getWorkflow(String workspaceId,
                     int workflowId)
              throws UserNotFoundException,
                     UserNotActiveException,
                     WorkspaceNotFoundException,
                     AccessRightException,
                     WorkspaceNotEnabledException

Throws:: UserNotFoundException; UserNotActiveException; WorkspaceNotFoundException; AccessRightException; WorkspaceNotEnabledException

getWorkspaceWorkflow

WorkspaceWorkflow getWorkspaceWorkflow(String workspaceId,
                                       String workspaceWorkflowId)
                                throws UserNotFoundException,
                                       UserNotActiveException,
                                       WorkspaceNotFoundException,
                                       WorkflowNotFoundException,
                                       WorkspaceNotEnabledException

Throws:: UserNotFoundException; UserNotActiveException; WorkspaceNotFoundException; WorkflowNotFoundException; WorkspaceNotEnabledException

getWorkspaceWorkflowList

WorkspaceWorkflow[] getWorkspaceWorkflowList(String workspaceId)
                                      throws UserNotFoundException,
                                             UserNotActiveException,
                                             WorkspaceNotFoundException,
                                             WorkspaceNotEnabledException

Throws:: UserNotFoundException; UserNotActiveException; WorkspaceNotFoundException; WorkspaceNotEnabledException

getWorkflowAbortedWorkflowList

Workflow[] getWorkflowAbortedWorkflowList(String workspaceId,
                                          int workflowId)
                                   throws UserNotFoundException,
                                          UserNotActiveException,
                                          WorkspaceNotFoundException,
                                          AccessRightException,
                                          WorkspaceNotEnabledException

Throws:: UserNotFoundException; UserNotActiveException; WorkspaceNotFoundException; AccessRightException; WorkspaceNotEnabledException

approveTaskOnWorkspaceWorkflow

void approveTaskOnWorkspaceWorkflow(String workspaceId,
                                    TaskKey taskKey,
                                    String comment,
                                    String signature)
                             throws UserNotFoundException,
                                    UserNotActiveException,
                                    WorkspaceNotFoundException,
                                    TaskNotFoundException,
                                    AccessRightException,
                                    WorkflowNotFoundException,
                                    NotAllowedException,
                                    WorkspaceNotEnabledException

Throws:: UserNotFoundException; UserNotActiveException; WorkspaceNotFoundException; TaskNotFoundException; AccessRightException; WorkflowNotFoundException; NotAllowedException; WorkspaceNotEnabledException

rejectTaskOnWorkspaceWorkflow

void rejectTaskOnWorkspaceWorkflow(String workspaceId,
                                   TaskKey taskKey,
                                   String comment,
                                   String signature)
                            throws UserNotFoundException,
                                   UserNotActiveException,
                                   WorkspaceNotFoundException,
                                   TaskNotFoundException,
                                   AccessRightException,
                                   WorkflowNotFoundException,
                                   NotAllowedException,
                                   WorkspaceNotEnabledException

Throws:: UserNotFoundException; UserNotActiveException; WorkspaceNotFoundException; TaskNotFoundException; AccessRightException; WorkflowNotFoundException; NotAllowedException; WorkspaceNotEnabledException

deleteWorkspaceWorkflow

void deleteWorkspaceWorkflow(String workspaceId,
                             String workspaceWorkflowId)
                      throws UserNotFoundException,
                             AccessRightException,
                             WorkspaceNotFoundException,
                             WorkspaceNotEnabledException

Throws:: UserNotFoundException; AccessRightException; WorkspaceNotFoundException; WorkspaceNotEnabledException

Interface IWorkflowManagerLocal

Method Summary

Method Detail

deleteWorkflowModel

getWorkflowModel

getWorkflowModels

createWorkflowModel

updateWorkflowModel

getRoles

getRolesInUse

createRole

updateRole

deleteRole

removeUserFromAllRoleMappings

removeUserGroupFromAllRoleMappings

removeACLFromWorkflow

updateACLForWorkflow

instantiateWorkflow

getWorkflow

getWorkspaceWorkflow

getWorkspaceWorkflowList

getWorkflowAbortedWorkflowList

approveTaskOnWorkspaceWorkflow

rejectTaskOnWorkspaceWorkflow

deleteWorkspaceWorkflow