com.logicaldoc.web.document
Class DocumentRecord

java.lang.Object
  com.logicaldoc.web.navigation.MenuBarBean
      com.logicaldoc.web.document.DocumentRecord

Direct Known Subclasses:

DocumentResult

public class DocumentRecord
extends MenuBarBean

The DocumentRecord class contains the base information for an entry in a data table. This class is meant to represent a model and should only contain base document data

Since:

3.0

Author:

Marco Meschieri - Logical Objects

Field Summary

static java.lang.String	CHILD_ROW_STYLE_CLASS
protected long	docId
protected com.logicaldoc.core.document.Document	document
static java.lang.String	GROUP_ROW_STYLE_CLASS
protected static org.apache.commons.logging.Log	log
protected com.logicaldoc.core.document.Document	shortcut

Fields inherited from class com.logicaldoc.web.navigation.MenuBarBean

accessibleMenues, breadcrumb, itemCache, logger, model

Constructor Summary

DocumentRecord()

DocumentRecord(com.logicaldoc.core.document.Document document)

DocumentRecord(long docId, java.lang.String indentStyleClass, java.lang.String rowStyleClass)
Creates a new DocumentRecord.

Method Summary

java.lang.String	checkin() Executes the checkin and the related document's download
java.lang.String	checkout() Executes the checkout and the related document's download
protected void	createMenuItems() Creates the context menu associated with this record
java.lang.String	discussions() Shows the discussions for this document
java.lang.String	edit()
boolean	equals(java.lang.Object arg0)
java.util.Date	getCreation()
java.util.Date	getCreationDate()
java.lang.String	getCustomId()
java.util.Date	getDate()
java.lang.String	getDisplayFilename()
java.lang.String	getDisplayTitle()
long	getDocId()
com.logicaldoc.core.document.Document	getDocument()
java.lang.String	getDocumentPath()
java.lang.String	getDownloadTextLink()
java.lang.String	getExportName()
int	getExportStatus()
java.lang.String	getIcon()
java.util.Date	getLastModified()
java.lang.String	getRowStyleClass() Gets the style class name used to define all other columns in the document record row, except the first column.
java.lang.String	getRssLink()
com.logicaldoc.core.document.Document	getShortcut()
java.lang.String	getSource()
java.util.Date	getSourceDate()
java.lang.String	getTitle() Gets the description of the record
java.lang.String	history() Shows the history of this document
java.lang.String	info()
void	initCollections() Initializes document's collections
boolean	isCheckedOut()
boolean	isDocumentFound()
boolean	isLinked() Checks if this document has links or is linked
boolean	isLocked()
boolean	isSelected()
java.lang.String	links() Shows all document links
protected void	loadDocument() Utility method used by document lazy loading
java.lang.String	lock()
java.lang.String	noaction()
java.lang.String	pasteAsLink() Links all selected documents to this document
java.lang.String	sendAsEmail()
java.lang.String	sendAsTicket()
void	setSelected(boolean selected)
java.lang.String	unlock()
java.lang.String	versions() Shows all versions of this document

Methods inherited from class com.logicaldoc.web.navigation.MenuBarBean

createMenuItem, createMenuItem, getActionFired, getBreadcrumb, getModel, getNavigation, getOrientation, getParam, primaryListener, selectItem, selectItem, setModel, setNavigation, setOrientation, setParam

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

GROUP_ROW_STYLE_CLASS

public static final java.lang.String GROUP_ROW_STYLE_CLASS

See Also:

Constant Field Values

CHILD_ROW_STYLE_CLASS

public static final java.lang.String CHILD_ROW_STYLE_CLASS

See Also:

Constant Field Values

document

protected com.logicaldoc.core.document.Document document

shortcut

protected com.logicaldoc.core.document.Document shortcut

docId

protected long docId

Constructor Detail

DocumentRecord

public DocumentRecord(long docId,
                      java.lang.String indentStyleClass,
                      java.lang.String rowStyleClass)

Creates a new DocumentRecord.

The created DocumentRecord has no image states defined.

Parameters:

menuId -

indentStyleClass -

rowStyleClass -

DocumentRecord

public DocumentRecord()

DocumentRecord

public DocumentRecord(com.logicaldoc.core.document.Document document)

Method Detail

getDocument

public com.logicaldoc.core.document.Document getDocument()

isDocumentFound

public boolean isDocumentFound()

getDocId

public long getDocId()

getCustomId

public java.lang.String getCustomId()

getCreationDate

public java.util.Date getCreationDate()

getTitle

public java.lang.String getTitle()

Gets the description of the record

Returns:

description of the record

getDisplayTitle

public java.lang.String getDisplayTitle()

getDisplayFilename

public java.lang.String getDisplayFilename()

getRowStyleClass

public java.lang.String getRowStyleClass()

Gets the style class name used to define all other columns in the document record row, except the first column.

Returns:

style class as defined in css file

isSelected

public boolean isSelected()

isCheckedOut

public boolean isCheckedOut()

isLocked

public boolean isLocked()

setSelected

public void setSelected(boolean selected)

getIcon

public java.lang.String getIcon()

getSourceDate

public java.util.Date getSourceDate()

getDate

public java.util.Date getDate()

equals

public boolean equals(java.lang.Object arg0)

Overrides:

equals in class java.lang.Object

getDocumentPath

public java.lang.String getDocumentPath()

createMenuItems

protected void createMenuItems()

Creates the context menu associated with this record

Overrides:

createMenuItems in class MenuBarBean

See Also:

MenuBarBean.createMenuItems()

noaction

public java.lang.String noaction()

edit

public java.lang.String edit()

isLinked

public boolean isLinked()

Checks if this document has links or is linked

checkout

public java.lang.String checkout()

Executes the checkout and the related document's download

checkin

public java.lang.String checkin()

Executes the checkin and the related document's download

versions

public java.lang.String versions()

Shows all versions of this document

links

public java.lang.String links()

Shows all document links

discussions

public java.lang.String discussions()

Shows the discussions for this document

history

public java.lang.String history()

Shows the history of this document

info

public java.lang.String info()

sendAsEmail

public java.lang.String sendAsEmail()

sendAsTicket

public java.lang.String sendAsTicket()

pasteAsLink

public java.lang.String pasteAsLink()

Links all selected documents to this document

unlock

public java.lang.String unlock()

lock

public java.lang.String lock()

getDownloadTextLink

public java.lang.String getDownloadTextLink()

getRssLink

public java.lang.String getRssLink()

loadDocument

protected void loadDocument()

Utility method used by document lazy loading

initCollections

public void initCollections()

Initializes document's collections

getCreation

public java.util.Date getCreation()

getLastModified

public java.util.Date getLastModified()

getExportName

public java.lang.String getExportName()

getExportStatus

public int getExportStatus()

getShortcut

public com.logicaldoc.core.document.Document getShortcut()

getSource

public java.lang.String getSource()