com.logicaldoc.web.document
Class DocumentEditForm

java.lang.Object
  com.logicaldoc.web.document.DocumentEditForm

public class DocumentEditForm
extends java.lang.Object

Base form for document editing

Since:

3.0

Author:

Marco Meschieri - Logical Objects

Field Summary

protected static org.apache.commons.logging.Log

log

Constructor Summary

DocumentEditForm()

Method Summary

void	changeTemplate(javax.faces.event.ValueChangeEvent event)
java.lang.String	checkin() Executes a document's checkin creating a new version
java.lang.String	closeDocumentPreview()
java.lang.String	getCoverage()
javax.faces.component.UIInput	getCoverageInput()
java.lang.String	getCustomId()
javax.faces.component.UIInput	getDateValueInput()
java.util.Date	getDocDate()
javax.faces.component.UIInput	getDoubleValueInput()
java.util.Collection<Attribute>	getExtendedAttributes()
int	getExtendedAttributesCount()
java.lang.String	getFilename()
javax.faces.component.UIInput	getIntValueInput()
java.lang.String	getLanguage()
java.lang.String	getObject()
javax.faces.component.UIInput	getObjectInput()
java.lang.String	getRecipient()
javax.faces.component.UIInput	getRecipientInput()
DocumentRecord	getRecord()
java.lang.String	getSource()
java.lang.String	getSourceAuthor()
javax.faces.component.UIInput	getSourceAuthorInput()
java.util.Date	getSourceDate()
javax.faces.component.UIInput	getSourceDateInput()
java.lang.String	getSourceId()
javax.faces.component.UIInput	getSourceIdInput()
javax.faces.component.UIInput	getSourceInput()
java.lang.String	getSourceType()
javax.faces.component.UIInput	getSourceTypeInput()
javax.faces.component.UIInput	getStringValueInput()
java.lang.String	getTags()
javax.faces.component.UIInput	getTagsInput()
java.lang.Long	getTemplate()
javax.faces.component.UIInput	getTemplateInput()
javax.faces.component.UIInput	getTemplateValueInput()
java.lang.String	getTitle()
java.lang.String	getVersionDesc()
void	init(DocumentRecord record)
boolean	isCheckOriginalFilename()
boolean	isDisplayPreviewPopup()
boolean	isImmediateIndexing()
boolean	isMajorUpdate()
boolean	isReadOnly()
protected boolean	isValid(java.lang.String page) Returns true if all the mandatory preferences in the given page are correctly defined by the user.
java.lang.String	openDocumentPreview()
void	reset()
java.lang.String	save() Saves data into a new Document.
void	setCheckOriginalFilename(boolean checkOriginalFilename)
void	setCoverage(java.lang.String cover)
void	setCoverageInput(javax.faces.component.UIInput coverageInput)
void	setCustomId(java.lang.String customId)
void	setDateValueInput(javax.faces.component.UIInput dateValueInput)
void	setDisplayPreviewPopup(boolean displayPreviewPopup)
void	setDocDate(java.util.Date docDate)
void	setDocumentNavigation(DocumentNavigation documentNavigation)
void	setDoubleValueInput(javax.faces.component.UIInput doubleValueInput)
void	setFilename(java.lang.String filename)
void	setImmediateIndexing(boolean immediateIndexing)
void	setIntValueInput(javax.faces.component.UIInput intValueInput)
void	setLanguage(java.lang.String lang)
void	setMajorUpdate(boolean majorUpdate)
void	setObject(java.lang.String object)
void	setObjectInput(javax.faces.component.UIInput objectInput)
void	setReadOnly(boolean readOnly)
void	setRecipient(java.lang.String recipient)
void	setRecipientInput(javax.faces.component.UIInput recipientInput)
void	setSource(java.lang.String src)
void	setSourceAuthor(java.lang.String author)
void	setSourceAuthorInput(javax.faces.component.UIInput sourceAuthorInput)
void	setSourceDate(java.util.Date date)
void	setSourceDateInput(javax.faces.component.UIInput sourceDateInput)
void	setSourceId(java.lang.String sourceId)
void	setSourceIdInput(javax.faces.component.UIInput sourceIdInput)
void	setSourceInput(javax.faces.component.UIInput sourceInput)
void	setSourceType(java.lang.String type)
void	setSourceTypeInput(javax.faces.component.UIInput sourceTypeInput)
void	setStringValueInput(javax.faces.component.UIInput stringValueInput)
void	setTags(java.lang.String words)
void	setTagsInput(javax.faces.component.UIInput tagsInput)
void	setTemplate(java.lang.Long template)
void	setTemplateInput(javax.faces.component.UIInput templateInput)
void	setTemplateValueInput(javax.faces.component.UIInput templateValueInput)
void	setTitle(java.lang.String title)
void	setVersionDesc(java.lang.String desc)
java.lang.String	toString()
java.lang.String	uncheckout()
java.lang.String	update() Updates data into a Document.

Methods inherited from class java.lang.Object

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

Field Detail

log

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

Constructor Detail

DocumentEditForm

public DocumentEditForm()

Method Detail

getStringValueInput

public javax.faces.component.UIInput getStringValueInput()

setStringValueInput

public void setStringValueInput(javax.faces.component.UIInput stringValueInput)

getIntValueInput

public javax.faces.component.UIInput getIntValueInput()

setIntValueInput

public void setIntValueInput(javax.faces.component.UIInput intValueInput)

getDoubleValueInput

public javax.faces.component.UIInput getDoubleValueInput()

setDoubleValueInput

public void setDoubleValueInput(javax.faces.component.UIInput doubleValueInput)

getDateValueInput

public javax.faces.component.UIInput getDateValueInput()

setDateValueInput

public void setDateValueInput(javax.faces.component.UIInput dateValueInput)

isImmediateIndexing

public boolean isImmediateIndexing()

setImmediateIndexing

public void setImmediateIndexing(boolean immediateIndexing)

isMajorUpdate

public boolean isMajorUpdate()

setMajorUpdate

public void setMajorUpdate(boolean majorUpdate)

isCheckOriginalFilename

public boolean isCheckOriginalFilename()

setCheckOriginalFilename

public void setCheckOriginalFilename(boolean checkOriginalFilename)

reset

public void reset()

init

public void init(DocumentRecord record)

getExtendedAttributesCount

public int getExtendedAttributesCount()

changeTemplate

public void changeTemplate(javax.faces.event.ValueChangeEvent event)

getExtendedAttributes

public java.util.Collection<Attribute> getExtendedAttributes()

getTemplate

public java.lang.Long getTemplate()

setTemplate

public void setTemplate(java.lang.Long template)

getTitle

public java.lang.String getTitle()

Returns:

Returns the title.

getSource

public java.lang.String getSource()

Returns:

Returns the source.

getSourceAuthor

public java.lang.String getSourceAuthor()

Returns:

Returns the sourceAuthor.

getSourceDate

public java.util.Date getSourceDate()

Returns:

Returns the sourceDate.

getSourceType

public java.lang.String getSourceType()

Returns:

Returns the sourceType.

getCoverage

public java.lang.String getCoverage()

Returns:

Returns the coverage.

getLanguage

public java.lang.String getLanguage()

Returns:

Returns the language.

getTags

public java.lang.String getTags()

Returns:

Returns the tags.

getVersionDesc

public java.lang.String getVersionDesc()

Returns:

Returns the versionDesc.

getCustomId

public java.lang.String getCustomId()

Returns:

Returns the customId.

setTitle

public void setTitle(java.lang.String title)

Parameters:

title - The title to set.

setSource

public void setSource(java.lang.String src)

Parameters:

source - The source to set.

setSourceAuthor

public void setSourceAuthor(java.lang.String author)

Parameters:

sourceAuthor - The sourceAuthor to set.

setSourceDate

public void setSourceDate(java.util.Date date)

Parameters:

sourceDate - The sourceDate to set.

setSourceType

public void setSourceType(java.lang.String type)

Parameters:

sourceType - The sourceType to set.

setCoverage

public void setCoverage(java.lang.String cover)

Parameters:

coverage - The coverage to set.

setLanguage

public void setLanguage(java.lang.String lang)

Parameters:

language - The language to set.

setTags

public void setTags(java.lang.String words)

Parameters:

tags - The tags to set.

getFilename

public java.lang.String getFilename()

Returns:

Returns the filename.

setFilename

public void setFilename(java.lang.String filename)

Parameters:

filename - The filename to set.

setVersionDesc

public void setVersionDesc(java.lang.String desc)

Parameters:

versionDesc - The versionDesc to set.

getDocDate

public java.util.Date getDocDate()

setDocDate

public void setDocDate(java.util.Date docDate)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

save

public java.lang.String save()

Saves data into a new Document. Saves the information provided in the document form. That also includes updating the search index for example. This method is invoked in the document's upload wizard

update

public java.lang.String update()

Updates data into a Document. Saves the information provided in the document form. That also includes updating the search index for example. This method is invoked for document's editing

isValid

protected boolean isValid(java.lang.String page)

Returns true if all the mandatory preferences in the given page are correctly defined by the user.

Parameters:

page - It can be 'insert' (document upload page) or 'edit' (document editing page)

uncheckout

public java.lang.String uncheckout()

checkin

public java.lang.String checkin()

Executes a document's checkin creating a new version

getRecord

public DocumentRecord getRecord()

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

setDocumentNavigation

public void setDocumentNavigation(DocumentNavigation documentNavigation)

getSourceId

public java.lang.String getSourceId()

setSourceId

public void setSourceId(java.lang.String sourceId)

getObject

public java.lang.String getObject()

setObject

public void setObject(java.lang.String object)

getSourceInput

public javax.faces.component.UIInput getSourceInput()

setSourceInput

public void setSourceInput(javax.faces.component.UIInput sourceInput)

getSourceAuthorInput

public javax.faces.component.UIInput getSourceAuthorInput()

setSourceAuthorInput

public void setSourceAuthorInput(javax.faces.component.UIInput sourceAuthorInput)

getSourceDateInput

public javax.faces.component.UIInput getSourceDateInput()

setSourceDateInput

public void setSourceDateInput(javax.faces.component.UIInput sourceDateInput)

getSourceTypeInput

public javax.faces.component.UIInput getSourceTypeInput()

setSourceTypeInput

public void setSourceTypeInput(javax.faces.component.UIInput sourceTypeInput)

getCoverageInput

public javax.faces.component.UIInput getCoverageInput()

setCoverageInput

public void setCoverageInput(javax.faces.component.UIInput coverageInput)

getTagsInput

public javax.faces.component.UIInput getTagsInput()

setTagsInput

public void setTagsInput(javax.faces.component.UIInput tagsInput)

getSourceIdInput

public javax.faces.component.UIInput getSourceIdInput()

setSourceIdInput

public void setSourceIdInput(javax.faces.component.UIInput sourceIdInput)

getObjectInput

public javax.faces.component.UIInput getObjectInput()

setObjectInput

public void setObjectInput(javax.faces.component.UIInput objectInput)

setCustomId

public void setCustomId(java.lang.String customId)

getRecipient

public java.lang.String getRecipient()

setRecipient

public void setRecipient(java.lang.String recipient)

getRecipientInput

public javax.faces.component.UIInput getRecipientInput()

setRecipientInput

public void setRecipientInput(javax.faces.component.UIInput recipientInput)

getTemplateInput

public javax.faces.component.UIInput getTemplateInput()

setTemplateInput

public void setTemplateInput(javax.faces.component.UIInput templateInput)

isDisplayPreviewPopup

public boolean isDisplayPreviewPopup()

setDisplayPreviewPopup

public void setDisplayPreviewPopup(boolean displayPreviewPopup)

openDocumentPreview

public java.lang.String openDocumentPreview()

closeDocumentPreview

public java.lang.String closeDocumentPreview()

getTemplateValueInput

public javax.faces.component.UIInput getTemplateValueInput()

setTemplateValueInput

public void setTemplateValueInput(javax.faces.component.UIInput templateValueInput)