public interface WorkFlowInterface
Modifier and Type | Method and Description |
---|---|
void |
assignActivity(java.lang.String assignUserId,
java.lang.String companyId,
int workflowKey,
int activityKey,
int caseKey)
Called to assign an activity to a user.
|
void |
completeActivity(java.lang.String userId,
java.lang.String companyId,
int workflowKey,
int activityKey,
int caseKey,
java.util.Map<java.lang.String,java.lang.String> caseValues,
java.lang.String completionNotes)
Completes an activity.
|
void |
completeOptionalActivity(java.lang.String userId,
java.lang.String companyId,
int workflowKey,
int activityKey,
int optionKey,
int caseKey,
java.util.Map<java.lang.String,java.lang.String> caseValues,
java.lang.String completionNotes)
Completes an activity.
|
java.util.Map<java.lang.String,java.lang.String[]> |
getLastErrors()
Users of Workflow interface can call this method to determine if there is
any error during the previous API call
Currently the API returns any errors that are associated with sending
email
|
int |
initiate(java.lang.String wfStartUserId,
java.lang.String companyId,
int workflowKey,
java.util.Map<java.lang.String,java.lang.String> caseValues,
java.lang.String caseNotes,
java.lang.String[] userIds)
Initiates a new case instance of a given WORKFLOW KEY by starting
the first level activities
|
int |
initiate(java.lang.String wfStartUserId,
java.lang.String companyId,
java.lang.String workflowName,
java.util.Map<java.lang.String,java.lang.String> caseValues,
java.lang.String caseNotes,
java.lang.String[] userIds)
Initiates a new case instance for a given WORKFLOW NAME by
starting the first level activities
|
boolean |
isCompleted(java.lang.String companyId,
int workflowKey,
int activityKey,
int caseKey)
Checks whether the activity for the case has already been completed
|
void |
resendEmails(java.lang.String companyId)
Resends emails for activities that are still in activity in box in case
the emails are not yet sent for some reason
Also resends emails for completed activities in MSG inbox for which the
the emails are not yet sent for some reason
|
boolean |
startActivity(java.lang.String startUserId,
java.lang.String companyId,
int workflowKey,
int activityKey,
int optionKey,
int caseKey)
Starts an activity for a given startUserId.
|
int initiate(java.lang.String wfStartUserId, java.lang.String companyId, java.lang.String workflowName, java.util.Map<java.lang.String,java.lang.String> caseValues, java.lang.String caseNotes, java.lang.String[] userIds) throws DEException
wfStartUserId
- User who initiates the workflowcompanyId
- The company idworkflowName
- The name of workflow for which the initiation is requestedcaseValues
- A map of case values where map keys are caseLabels and values for keys are
the corresponding case valuescaseNotes
- An optional notes asscociated with this caseuserIds
- An optional array of user ids which will be used instead of roles/userids
that have been assigned to activities during workflow definitionDEException
- If there is any error , this exception is thrownint initiate(java.lang.String wfStartUserId, java.lang.String companyId, int workflowKey, java.util.Map<java.lang.String,java.lang.String> caseValues, java.lang.String caseNotes, java.lang.String[] userIds) throws DEException
wfStartUserId
- User who initiates the workflowcompanyId
- The company idworkflowKey
- The key of workflow for which the initiation is requestedcaseValues
- A map of case values where map keys are caseLabels and values for keys are
the corresponding case valuescaseNotes
- An optional notes asscociated with this caseuserIds
- An optional array of user ids which will be used instead of roles/userids
that have been assigned to activities during workflow definitionDEException
- If there is any error , this exception is thrownvoid completeActivity(java.lang.String userId, java.lang.String companyId, int workflowKey, int activityKey, int caseKey, java.util.Map<java.lang.String,java.lang.String> caseValues, java.lang.String completionNotes) throws DEException
userId
- user id represents the user who completes this actvity (completeUserId)
and starts next activity (startNextUserId)companyId
- The company idworkflowKey
- The workflow key for which the initiation is requestedactivityKey
- The activity that is to be completedcaseKey
- The case that represents an instance of a workflowcaseValues
- A map of case values where map keys are caseLabels and values for keys are
the corresponding case valuescompletionNotes
- A text message that can be optionally stored when the activity is completedDEException
- in case of an errorvoid completeOptionalActivity(java.lang.String userId, java.lang.String companyId, int workflowKey, int activityKey, int optionKey, int caseKey, java.util.Map<java.lang.String,java.lang.String> caseValues, java.lang.String completionNotes) throws DEException
userId
- user id represents the user who completes this actvity (completeUserId)
and starts next activity (startNextUserId)companyId
- The company idworkflowKey
- The workflow key for which the initiation is requestedactivityKey
- The activity that is to be completedoptionKey
- The option chosen for this activitycaseKey
- The case that represents an instance of a workflowcaseValues
- A map of case values where map keys are caseLabels and values for keys are
the corresponding case valuescompletionNotes
- A text message that can be optionally stored when the activity is completedDEException
- in case of an errorboolean isCompleted(java.lang.String companyId, int workflowKey, int activityKey, int caseKey)
companyId
- The Company identifierworkflowKey
- The workflow key for which the initiation is requestedactivityKey
- The activity that is to be completedcaseKey
- The case that represents an instance of a workflowvoid resendEmails(java.lang.String companyId) throws DEException
companyId
- DEException
- in case of an errorboolean startActivity(java.lang.String startUserId, java.lang.String companyId, int workflowKey, int activityKey, int optionKey, int caseKey) throws DEException
startUserId
- companyId
- workflowKey
- caseKey
- activityKey
- DEException
void assignActivity(java.lang.String assignUserId, java.lang.String companyId, int workflowKey, int activityKey, int caseKey) throws DEException
assignUserId
- companyId
- workflowKey
- caseKey
- activityKey
- DEException
java.util.Map<java.lang.String,java.lang.String[]> getLastErrors()