All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractDashBoardItemImpl, 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.

Since:

5.5

Author:

Julien Anguenot

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Map<String,Object>`	`asMap()`	Returns JSON representation of the item as map
`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.
`String`	`getDocumentLink(boolean includeWorkflowTab)`	Return the link url to the target Document
`Date`	`getDueDate()`	Returns the date at which the task needs to be closed.
`String`	`getI18nDirective()`	Get the Translated Task Directive (Locale must be set)
`String`	`getI18nTaskName()`	Get the Translated TaskName (Locale must be set)
`String`	`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.
`Task`	`getTask()`	Returns the underneath task instance
`boolean`	`isExpired()`	Does the user reach the deadline?
`void`	`setLocale(Locale locale)`	Defines the `Locale` that will be used to generate translations

- Method Detail
  - getId
```
String getId()
```
    Returns the identifier of the workflow task instance.
    
    Returns:
    
    the identifier of the dash board item.
  - 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.
  - getTask
```
Task getTask()
```
    Returns the underneath task instance
  - setLocale
```
void setLocale(Locale locale)
```
    Defines the Locale that will be used to generate translations
  - getI18nTaskName
```
String getI18nTaskName()
```
    Get the Translated TaskName (Locale must be set)
  - getI18nDirective
```
String getI18nDirective()
```
    Get the Translated Task Directive (Locale must be set)
  - asMap
```
Map<String,Object> asMap()
```
    Returns JSON representation of the item as map
  - getDocumentLink
```
String getDocumentLink(boolean includeWorkflowTab)
```
    Return the link url to the target Document

Interface DashBoardItem

Method Summary

Method Detail

getId

getName

getDocRef

getDescription

getComment

getStartDate

getDueDate

getDirective

getDocument

isExpired

getTask

setLocale

getI18nTaskName

getI18nDirective

asMap

getDocumentLink