Class WorkflowJobSchedulingRequest
- java.lang.Object
-
- com.broadleafcommerce.data.tracking.core.transition.WorkflowJobSchedulingRequest
-
- All Implemented Interfaces:
com.broadleafcommerce.common.messaging.Securable
,Serializable
public class WorkflowJobSchedulingRequest extends Object implements com.broadleafcommerce.common.messaging.Securable, Serializable
A container object for information regarding a workflow operation that should be scheduled for future completion. This is commonly used for scheduling future deployments and results in a scheduled job being created that, once triggered, causes aWorkflowDeployRequest
being emitted.- Author:
- Nathan Moore (nathandmoore)
- See Also:
WorkflowJobUnschedulingRequest
, Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
String
getAuthor()
Identifies the user who is scheduling or creating this request.Instant
getDateScheduled()
The time when the workflow operation is scheduled to occur.String
getDisplayName()
The name to display to the user that represents the scheduled operation.String
getMessage()
A message describing the operation being scheduled.String
getToken()
String
getTransferId()
ID of the transfer item involved in a workflow request being scheduled.String
getTransferType()
Type of the transfer item involved in a workflow request being scheduled.int
hashCode()
void
setToken(String token)
String
toString()
-
-
-
Method Detail
-
getTransferType
public String getTransferType()
Type of the transfer item involved in a workflow request being scheduled.- See Also:
TransferType
-
getTransferId
public String getTransferId()
ID of the transfer item involved in a workflow request being scheduled. Could be the id of a change summary, summary group, or deployment.
-
getDateScheduled
public Instant getDateScheduled()
The time when the workflow operation is scheduled to occur.- Returns:
- The time when the workflow operation is scheduled to occur.
-
getDisplayName
public String getDisplayName()
The name to display to the user that represents the scheduled operation.- Returns:
- The name to display to the user that represents the scheduled operation
-
getMessage
public String getMessage()
A message describing the operation being scheduled. This could be used when scheduling recurring workflow operations.- Returns:
- A message describing the operation being scheduled.
-
getAuthor
public String getAuthor()
Identifies the user who is scheduling or creating this request.- Returns:
- The identifier of the user who is scheduling or creating this request.
-
getToken
public String getToken()
- Specified by:
getToken
in interfacecom.broadleafcommerce.common.messaging.Securable
-
canEqual
protected boolean canEqual(Object other)
-
setToken
public void setToken(String token)
- Specified by:
setToken
in interfacecom.broadleafcommerce.common.messaging.Securable
-
-