Nuxeo Enterprise Platform 5.4

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

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
DashBoardItem
All Known Implementing Classes:
DashBoardItemImpl, DashBoardItemImpl

public interface DashBoardItem
extends java.io.Serializable

Dashboard item.

Author:
Julien Anguenot

Method Summary
 java.lang.String getComment()
          Returns the associated item comment.
 java.lang.String getDescription()
          Returns the description of the item.
 java.lang.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.
 java.util.Date getDueDate()
          Returns the date at which the task needs to be closed.
 java.lang.Long getId()
          Returns the identifier of the dash board item.
 java.lang.String getName()
          Returns the name of the DashBoardItem.
 java.util.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

java.lang.Long getId()
Returns the identifier of the dash board item.

Workflow task instance right now.

Returns:
the identifier of the dash board item.
Since:
5.2.M4 uses the long identifier instead of String equivalent

getName

java.lang.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
See Also:
org.nuxeo.ecm.platform.workflow.document.api.relation.WorkflowDocumentRelationManager

getDescription

java.lang.String getDescription()
Returns the description of the item.

Returns:
the description of the item

getComment

java.lang.String getComment()
Returns the associated item comment.

Returns:
the associated item comment

getStartDate

java.util.Date getStartDate()
Returns the date when the task has been started.

Returns:
the date when the task has been started

getDueDate

java.util.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

java.lang.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


Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.