IBpmProcessStep (server-common-api)

```
public interface IBpmProcessStep
```
Interface which represents process instance step

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STEP_STATUS_CANCELLED` Process cancelled
`static int`	`STEP_STATUS_ENDED` Step successfully completed
`static int`	`STEP_STATUS_FAILED` Step failed
`static int`	`STEP_STATUS_RESUMED` Process Resumed
`static int`	`STEP_STATUS_STARTED` Step was started
`static int`	`STEP_STATUS_SUSPENDED` Process suspended
`static int`	`STEP_STATUS_UNDEFINED` Step status is undefined (for newly added steps)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addError(String errorMessage, String errorStackTrace, String serviceName)` Adds error to this step
`void`	`addTaskUser(String taskUser)` Adds a task user for this step
`IBpmProcessCustomFields`	`getCustomFields()` Returns custom fields for this step
`Date`	`getEndDate()` Date/time when this step was ended
`List<IBpmProcessError>`	`getErrors()` Returns list of errors attached to this step
`String`	`getName()` Returns step name
`IBpmProcess`	`getProcess()` Returns process instance for this step
`Date`	`getStartDate()` Date/time when this step was started
`int`	`getStatus()` Returns status of this step
`IBpmProcessStepDefinition`	`getStepDefinition()` Returns step definition for this step
`String`	`getStepID()` Returns this stepID
`String`	`getTaskID()` Returns taskID for this step
`String`	`getTaskStatus()` Returns task status for this step
`String`	`getTaskTypeID()` Returns taskTypeID for this step
`List<String>`	`getTaskUsers()` Returns list of all task users for this step
`void`	`removeTaskUser(String taskUser)` Removes task user from this step
`void`	`setName(String name)` Sets step name
`void`	`setStatus(int status)` Sets status of this step
`void`	`setTaskID(String taskID)` Sets taskID for this step
`void`	`setTaskStatus(String taskStatus)` Sets task status for this step
`void`	`setTaskTypeID(String taskTypeID)` Sets taskTypeID for this step

- Field Detail
  - STEP_STATUS_UNDEFINED
```
static final int STEP_STATUS_UNDEFINED
```
    Step status is undefined (for newly added steps)
    
    See Also:
    
    Constant Field Values
  - STEP_STATUS_STARTED
```
static final int STEP_STATUS_STARTED
```
    Step was started
    
    See Also:
    
    Constant Field Values
  - STEP_STATUS_ENDED
```
static final int STEP_STATUS_ENDED
```
    Step successfully completed
    
    See Also:
    
    Constant Field Values
  - STEP_STATUS_FAILED
```
static final int STEP_STATUS_FAILED
```
    Step failed
    
    See Also:
    
    Constant Field Values
  - STEP_STATUS_SUSPENDED
```
static final int STEP_STATUS_SUSPENDED
```
    Process suspended
    
    See Also:
    
    Constant Field Values
  - STEP_STATUS_RESUMED
```
static final int STEP_STATUS_RESUMED
```
    Process Resumed
    
    See Also:
    
    Constant Field Values
  - STEP_STATUS_CANCELLED
```
static final int STEP_STATUS_CANCELLED
```
    Process cancelled
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getProcess
```
IBpmProcess getProcess()
```
    Returns process instance for this step
  - getStepDefinition
```
IBpmProcessStepDefinition getStepDefinition()
                                     throws Exception
```
    Returns step definition for this step
    
    Throws:
    
    Exception
  - getStepID
```
String getStepID()
          throws Exception
```
    Returns this stepID
    
    Throws:
    
    Exception
  - getStartDate
```
Date getStartDate()
           throws Exception
```
    Date/time when this step was started
    
    Throws:
    
    Exception
  - getEndDate
```
Date getEndDate()
         throws Exception
```
    Date/time when this step was ended
    
    Throws:
    
    Exception
  - getStatus
```
int getStatus()
```
    Returns status of this step
  - setStatus
```
void setStatus(int status)
```
    Sets status of this step
    
    Parameters:
    
    status -
  - getName
```
String getName()
```
    Returns step name
  - setName
```
void setName(String name)
```
    Sets step name
  - getTaskID
```
String getTaskID()
```
    Returns taskID for this step
  - setTaskID
```
void setTaskID(String taskID)
```
    Sets taskID for this step
    
    Parameters:
    
    taskID -
  - getTaskStatus
```
String getTaskStatus()
```
    Returns task status for this step
  - setTaskStatus
```
void setTaskStatus(String taskStatus)
```
    Sets task status for this step
    
    Parameters:
    
    taskStatus -
  - getTaskTypeID
```
String getTaskTypeID()
```
    Returns taskTypeID for this step
  - setTaskTypeID
```
void setTaskTypeID(String taskTypeID)
```
    Sets taskTypeID for this step
    
    Parameters:
    
    taskTypeID -
  - getTaskUsers
```
List<String> getTaskUsers()
```
    Returns list of all task users for this step
    
    Returns:
  - addTaskUser
```
void addTaskUser(String taskUser)
```
    Adds a task user for this step
    
    Parameters:
    
    taskUser -
  - removeTaskUser
```
void removeTaskUser(String taskUser)
```
    Removes task user from this step
    
    Parameters:
    
    taskUser -
  - getCustomFields
```
IBpmProcessCustomFields getCustomFields()
```
    Returns custom fields for this step
  - getErrors
```
List<IBpmProcessError> getErrors()
                          throws Exception
```
    Returns list of errors attached to this step
    
    Throws:
    
    Exception
  - addError
```
void addError(String errorMessage,
              String errorStackTrace,
              String serviceName)
       throws Exception
```
    Adds error to this step
    
    Throws:
    
    Exception

Interface IBpmProcessStep

Field Summary

Method Summary

Field Detail

STEP_STATUS_UNDEFINED

STEP_STATUS_STARTED

STEP_STATUS_ENDED

STEP_STATUS_FAILED

STEP_STATUS_SUSPENDED

STEP_STATUS_RESUMED

STEP_STATUS_CANCELLED

Method Detail

getProcess

getStepDefinition

getStepID

getStartDate

getEndDate

getStatus

setStatus

getName

setName

getTaskID

setTaskID

getTaskStatus

setTaskStatus

getTaskTypeID

setTaskTypeID

getTaskUsers

addTaskUser

removeTaskUser

getCustomFields

getErrors

addError