SUBJECT
- the WorkflowBean that the report is aboutPARENT
- the parent report typepublic class StatusReport<SUBJECT extends Ported,PARENT extends StatusReport<?,?>> extends Object
State
of a workflow component.Constructor and Description |
---|
StatusReport(SUBJECT subject)
Constructs a new
StatusReport for the subject and sets the created date to the
current date. |
Modifier and Type | Method and Description |
---|---|
void |
addInvocation(Invocation invocation) |
void |
addReportListener(ReportListener reportListener) |
Date |
getCancelledDate()
Returns the date that the status changed to CANCELLED.
|
Date |
getCompletedDate()
Returns the date that the status changed to COMPLETED.
|
Date |
getCreatedDate()
Returns the date that the status was set to CREATED.
|
Date |
getFailedDate()
Returns the date that the status changed to FAILED.
|
Invocation |
getInvocation(String invocationName)
Get an invocation with a given name.
|
NavigableSet<Invocation> |
getInvocations()
Returns the invocations.
|
PARENT |
getParentReport()
Returns the parent report.
|
Date |
getPausedDate()
Returns the date that the status last changed to PAUSED.
|
List<Date> |
getPausedDates()
Returns the dates that the status changed to PAUSED.
|
Date |
getResumedDate()
Returns the date that the status last changed form PAUSED to RUNNING.
|
List<Date> |
getResumedDates()
Returns the dates that the status changed from PAUSED to RUNNING.
|
Date |
getStartedDate()
Returns the date that the status changed to RUNNING.
|
State |
getState()
Returns the current
State . |
SUBJECT |
getSubject()
Returns the subject of this report.
|
URI |
getSubjectURI() |
void |
outputAdded(Path path,
String portName,
int[] index)
Informs the report that an output value has been added.
|
void |
removeReportListener(ReportListener reportListener) |
void |
setCancelledDate(Date cancelledDate)
Sets the date that the status changed to CANCELLED.
|
void |
setCompletedDate(Date completedDate)
Sets the date that the status changed to COMPLETED.
|
void |
setCreatedDate(Date createdDate)
Sets the date that the status was set to CREATED.
|
void |
setFailedDate(Date failedDate)
Sets the date that the status changed to FAILED.
|
void |
setParentReport(PARENT parentReport)
Sets the parent report.
|
void |
setPausedDate(Date pausedDate)
Sets the date that the status last changed to PAUSED.
|
void |
setResumedDate(Date resumedDate)
Sets the date that the status last changed form PAUSED to RUNNING.
|
void |
setStartedDate(Date startedDate)
Sets the date that the status changed to RUNNING.
|
void |
setState(State state) |
public StatusReport(SUBJECT subject)
StatusReport
for the subject and sets the created date to the
current date.subject
- the subject of the reportpublic SUBJECT getSubject()
public URI getSubjectURI()
public PARENT getParentReport()
Returns null if this report has no parent.
public void setParentReport(PARENT parentReport)
Can be null if this report has no parent.
workflowReport
- the parent reportpublic State getState()
State
.
A state can be CREATED, RUNNING, COMPLETED, PAUSED, CANCELLED or FAILED.
State
public void setState(State state)
public Date getCreatedDate()
public void setCreatedDate(Date createdDate)
createdDate
- the date that the status was set to CREATEDpublic Date getStartedDate()
If the status has never been RUNNING null
is returned.
public void setStartedDate(Date startedDate)
startedDate
- the date that the status changed to RUNNINGpublic Date getPausedDate()
If the status has never been PAUSED null
is returned.
public void setPausedDate(Date pausedDate)
pausedDate
- the date that the status last changed to PAUSEDpublic Date getResumedDate()
If the status has never changed form PAUSED to RUNNING null
is returned.
public void setResumedDate(Date resumedDate)
resumedDate
- the date that the status last changed form PAUSED to RUNNINGpublic Date getCancelledDate()
If the status has never been CANCELLED null
is returned.
public void setCancelledDate(Date cancelledDate)
cancelledDate
- the date that the status changed to CANCELLEDpublic Date getCompletedDate()
If the status never been COMPLETED null
is returned.
public void setCompletedDate(Date completedDate)
completedDate
- the date that the status changed to COMPLETEDpublic Date getFailedDate()
null
is returned.public void setFailedDate(Date failedDate)
failedDate
- the date that the status changed to FAILEDpublic List<Date> getPausedDates()
If the status has never been PAUSED an empty list is returned.
public List<Date> getResumedDates()
If the status has never changed from PAUSED to RUNNING an empty list is returned.
public NavigableSet<Invocation> getInvocations()
public void addInvocation(Invocation invocation)
public void outputAdded(Path path, String portName, int[] index)
Any ReportListener
s registered with this report will be notified that an output
value has been added.
path
- the path that the value was added toportName
- the port that the value belongs toindex
- the position of the valuepublic void addReportListener(ReportListener reportListener)
public void removeReportListener(ReportListener reportListener)
public Invocation getInvocation(String invocationName)
invocationName
- Copyright © 2015–2016 The Apache Software Foundation. All rights reserved.