WorkflowDeployment (broadleaf-enterprise 3.0.18-GA API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

WorkflowDeploymentImpl
```
public interface WorkflowDeployment
extends Serializable
```
Represents a list of changes scheduled to be deployed to production at a future date.

Author:

Jeff Fischer

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ApprovalDetails`	`getApprovalDetails()` The thread state and other information necessary to replay this deployment in an asynchronous thread of execution.
`Date`	`getDeploymentDate()` The date/time on which the deployment should execute
`List<WorkflowEvent>`	`getEvents()` The list of changes that should be executed
`Long`	`getId()`
`Long`	`getJobId()` When a deployment is created, a scheduled job should be created as well.
`String`	`getMessage()` An optional message describing the deployment
`String`	`getName()` An optional name describing the deployment
`WorkflowDeploymentRecurrenceType`	`getRecurrenceType()` Describes the recurrence type of the deployment in its overall lifecycle
`DeploymentStatusType`	`getStatus()` Describes the state of the deployment in its overall lifecycle
`void`	`setApprovalDetails(ApprovalDetails approvalDetails)`
`void`	`setDeploymentDate(Date deploymentDate)` The date/time on which the deployment should execute
`void`	`setEvents(List<WorkflowEvent> events)` The list of changes that should be executed
`void`	`setId(Long id)`
`void`	`setJobId(Long jobId)` When a deployment is created, a scheduled job should be created as well.
`void`	`setMessage(String message)` An optional message describing the deployment
`void`	`setName(String name)` An optional name describing the deployment
`void`	`setRecurrenceType(WorkflowDeploymentRecurrenceType recurrenceType)` Describes the recurrence type of the deployment in its overall lifecycle
`void`	`setStatus(DeploymentStatusType status)` Describes the state of the deployment in its overall lifecycle

- Method Detail
  - getDeploymentDate
```
Date getDeploymentDate()
```
    The date/time on which the deployment should execute
    
    Returns:
    
    the deployment date
  - setDeploymentDate
```
void setDeploymentDate(Date deploymentDate)
```
    The date/time on which the deployment should execute
    
    Parameters:
    
    deploymentDate - the deployment date
  - getEvents
```
List<WorkflowEvent> getEvents()
```
    The list of changes that should be executed
    
    Returns:
    
    the list of changes
  - setEvents
```
void setEvents(List<WorkflowEvent> events)
```
    The list of changes that should be executed
    
    Parameters:
    
    events - the list of changes
  - getId
```
Long getId()
```
  - setId
```
void setId(Long id)
```
  - getJobId
```
Long getJobId()
```
    When a deployment is created, a scheduled job should be created as well. This id points to the ScheduledJob instance.
    
    Returns:
    
    the scheduled job id
  - setJobId
```
void setJobId(Long jobId)
```
    When a deployment is created, a scheduled job should be created as well. This id points to the ScheduledJob instance.
    
    Parameters:
    
    jobId - the scheduled job id
  - getMessage
```
String getMessage()
```
    An optional message describing the deployment
    
    Returns:
    
    descriptive message
  - setMessage
```
void setMessage(String message)
```
    An optional message describing the deployment
    
    Parameters:
    
    message - descriptive message
  - getName
```
String getName()
```
    An optional name describing the deployment
    
    Returns:
    
    descriptive name
  - setName
```
void setName(String name)
```
    An optional name describing the deployment
    
    Parameters:
    
    name - descriptive name
  - getStatus
```
DeploymentStatusType getStatus()
```
    Describes the state of the deployment in its overall lifecycle
    
    Returns:
    
    deployment state
  - setStatus
```
void setStatus(DeploymentStatusType status)
```
    Describes the state of the deployment in its overall lifecycle
    
    Parameters:
    
    status - deployment state
  - getRecurrenceType
```
WorkflowDeploymentRecurrenceType getRecurrenceType()
```
    Describes the recurrence type of the deployment in its overall lifecycle
    
    Returns:
    
    deployment recurrence type
  - setRecurrenceType
```
void setRecurrenceType(WorkflowDeploymentRecurrenceType recurrenceType)
```
    Describes the recurrence type of the deployment in its overall lifecycle
    
    Parameters:
    
    recurrenceType - deployment recurrence type
  - getApprovalDetails
```
ApprovalDetails getApprovalDetails()
```
    The thread state and other information necessary to replay this deployment in an asynchronous thread of execution.
    
    Returns:
  - setApprovalDetails
```
void setApprovalDetails(ApprovalDetails approvalDetails)
```

Interface WorkflowDeployment

Method Summary

Method Detail

getDeploymentDate

setDeploymentDate

getEvents

setEvents

getId

setId

getJobId

setJobId

getMessage

setMessage

getName

setName

getStatus

setStatus

getRecurrenceType

setRecurrenceType

getApprovalDetails

setApprovalDetails