public class ActionResultBuilder
extends java.lang.Object
Provides a job action invocation ActionResult builder.
Examples
The example below uses creates a ActionResult object to signal the job step
action has successfully completed.
import com.avoka.tm.job.*
import com.avoka.tm.util.*
import com.avoka.tm.vo.*
import javax.servlet.http.*
class FluentJobActionService {
// Injected at runtime
public Logger logger
ActionResult invoke(SvcDef svcDef, Job job, JobAction jobAction, HttpServletRequest request, User user) {
// Business logic ...
String xml = Jobs.getStartTxnXml(job)
Path path = new Path(xml)
String refNumber = path.val('//Application/RefNumber')
return new ActionResultBuilder()
.setStatus('Completed')
.setMessage('Action completed for: ' + refNumber)
.build()
}
}
- Since:
- 5.0.0
Constructor Summary
Constructors
Constructor |
Description |
ActionResultBuilder() |
|
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type |
Method |
Description |
ActionResult |
build() |
Return a new job action result object based on the specified properties.
|
ActionResultBuilder |
setExpiryTime(java.util.Date expiryTime) |
Set the step action expiry time after which the job action should be
cancelled.
|
ActionResultBuilder |
setMaxRetryAttempts(java.lang.Integer maxRetryAttempts)
|
Set the maximum number of time to attempt performing the step action.
|
ActionResultBuilder |
setMessage(java.lang.String message) |
Set the job action result message for process auditing purposes.
|
ActionResultBuilder |
setNextRetryAttempt(java.util.Date nextRetryAttempt)
|
Set the time to next retry performing step action.
|
ActionResultBuilder |
setNextRetryAttemptMins(int minutes) |
The next time in minutes to retry performing the action.
|
ActionResultBuilder |
setRoute(java.lang.String route) |
Set the job action result route step.
|
ActionResultBuilder |
setStatus(java.lang.String status) |
Set the job action result status.
|
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait
Constructor Detail
ActionResultBuilder
public ActionResultBuilder()
Method Detail
setStatus
public ActionResultBuilder setStatus(java.lang.String status)
Set the job action result status.
- Parameters:
status
- the job action result status
- Returns:
- the job action result builder
setRoute
public ActionResultBuilder setRoute(java.lang.String route)
Set the job action result route step.
- Parameters:
route
- the step name to route the job flow to
- Returns:
- the job action result builder
setMessage
public ActionResultBuilder setMessage(java.lang.String message)
Set the job action result message for process auditing purposes.
- Parameters:
-
message
- the action result message for process auditing
purposes
- Returns:
- the job action result builder
setExpiryTime
public ActionResultBuilder setExpiryTime(java.util.Date expiryTime)
Set the step action expiry time after which the job action should be cancelled.
- Parameters:
-
expiryTime
- the step action expiry time after which the job
action should be cancelled
- Returns:
- the job action result builder
setMaxRetryAttempts
public ActionResultBuilder setMaxRetryAttempts(java.lang.Integer maxRetryAttempts)
Set the maximum number of time to attempt performing the step action.
- Parameters:
-
maxRetryAttempts
- the maximum number of time to attempt
performing the step action
- Returns:
- the job action result builder
setNextRetryAttempt
public ActionResultBuilder setNextRetryAttempt(java.util.Date nextRetryAttempt)
Set the time to next retry performing step action.
- Parameters:
-
nextRetryAttempt
- the time to next retry performing step
action
- Returns:
- the job action result builder
setNextRetryAttemptMins
public ActionResultBuilder setNextRetryAttemptMins(int minutes)
The next time in minutes to retry performing the action.
- Parameters:
-
minutes
- the next time in minutes to retry performing the
action
- Returns:
- the job action result builder
build
public ActionResult build()
Return a new job action result object based on the specified properties.
- Returns:
- a new job action result object based on the specified properties.