org.nuxeo.ecm.platform.jbpm.dashboard
Interface DashBoardItem

All Superinterfaces:

Serializable

All Known Subinterfaces:

DashBoardItem

All Known Implementing Classes:

DashBoardItemImpl, DashBoardItemImpl

public interface DashBoardItem
extends Serializable

Item holding information about a Document with a task attached to it.

Aimed at being used in Dashboard fragments.

Author:

Julien Anguenot

Method Summary

String	getComment() Returns the associated item comment.
String	getDescription() Returns the description of the item.
String	getDirective() Returns the item associated directive.
DocumentRef	getDocRef() Returns the document reference on which the item is bound.
DocumentModel	getDocument() Returns the icon path for the doc ref.
Date	getDueDate() Returns the date at which the task needs to be closed.
Long	getId() Returns the identifier of the workflow task instance.
String	getName() Returns the name of the DashBoardItem.
Date	getStartDate() Returns the date when the task has been started.
TaskInstance	getTaskInstance() Returns the underneath task instance
boolean	isExpired() Does the user reach the deadline?

Method Detail

getId

Long getId()

Returns the identifier of the workflow task instance.

Returns:

the identifier of the dash board item.

Since:

5.2.M4 uses the long identifier instead of String equivalent

getName

String getName()

Returns the name of the DashBoardItem.

Returns:

the name of the DashBoardItem

getDocRef

DocumentRef getDocRef()

Returns the document reference on which the item is bound.

Returns:

a document reference instance

getDescription

String getDescription()

Returns the description of the item.

Returns:

the description of the item

getComment

String getComment()

Returns the associated item comment.

Returns:

the associated item comment

getStartDate

Date getStartDate()

Returns the date when the task has been started.

Returns:

the date when the task has been started

getDueDate

Date getDueDate()

Returns the date at which the task needs to be closed.

Returns:

the date at which the task needs to be closed

getDirective

String getDirective()

Returns the item associated directive.

Returns:

the item associated directive

getDocument

DocumentModel getDocument()

Returns the icon path for the doc ref.

Returns:

the icon path for the doc ref

isExpired

boolean isExpired()

Does the user reach the deadline?

Returns:

the expired flag.

getTaskInstance

TaskInstance getTaskInstance()

Returns the underneath task instance