fr.paris.lutece.plugins.document.business
Class Document

java.lang.Object
  extended by fr.paris.lutece.plugins.document.business.Document
All Implemented Interfaces:
fr.paris.lutece.portal.service.i18n.Localizable

public class Document
extends java.lang.Object
implements fr.paris.lutece.portal.service.i18n.Localizable

A document of the CMS.


Constructor Summary
Document()
           
 
Method Summary
 int getAcceptSiteComments()
          Returns the nAcceptComment
 java.util.List getActions()
          Returns Actions List
 DocumentAttribute getAttribute(java.lang.String strAttributeCode)
          Returns a document attribute by its code
 java.util.List<DocumentAttribute> getAttributes()
          Returns attributes List
 java.util.List<Category> getCategories()
           
 java.lang.String getCodeDocumentType()
          Returns the CodeDocumentType
 java.lang.String getComment()
          Returns the Comment
 int getCreatorId()
          Returns the IdCreator
 java.sql.Timestamp getDateCreation()
          Returns the DateCreation
 java.sql.Timestamp getDateModification()
          Returns the Date of the last Modification
 java.sql.Timestamp getDateValidityBegin()
          Returns the begining Date of the validity period of the document
 java.sql.Timestamp getDateValidityEnd()
          Returns the end Date of the validity period of the document
 int getId()
          Returns the IdDocument
 int getIsEmailNotifiedComment()
          Returns the nIsEmailNotifiedComment
 int getIsModeratedComment()
          Returns the nIsModeratedComment
 java.util.Locale getLocale()
          Returns the Locale
 int getMailingListId()
          Returns the IdMailingList
 int getPageTemplateDocumentId()
          Returns the IdPageTemplateDocument
 int getPublishedStatus()
          Returns the PublishedSTatus
 java.lang.String getSpace()
          Returns the Space
 int getSpaceId()
          Returns the IdSpace
 java.lang.String getState()
          Returns the State
 int getStateId()
          Returns the IdState
 java.lang.String getStateKey()
          Returns the State
 java.lang.String getSummary()
          Returns the Summary
 java.lang.String getThumbnail()
          Returns a Thumbnail url for the document based on a document attribute or on the document type.
 java.lang.String getTitle()
          Returns the Title
 java.lang.String getType()
          Returns the Type
 java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
          Returns the xml of this document
 java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
          Returns the xml document of this link
 java.lang.String getXmlMetadata()
          Returns the XmlMetadata
 java.lang.String getXmlValidatedContent()
          Returns the XmlValidatedContent
 java.lang.String getXmlWorkingContent()
          Returns the XmlWorkingContent
 boolean isOutOfDate()
          Control that an document is out of date, i.e. dateValidityEnd has expired :
 boolean isValid()
          Control that an document is valid, i.e. that its period of validity defined by its dateValidityBegin and its dateValidityEnd is valid : an document is valid if the current date > = dateValidityBegin and if current date < = dateValidityEnd If the two dates are null, the test of validity will return true if one of the dates is null, the result of the test will be that carried out on the non null date
 void setAcceptSiteComments(int nAcceptSiteComments)
          Sets the nAcceptComment
 void setActions(java.util.List listActions)
          Set the document Actions list
 void setAttributes(java.util.List<DocumentAttribute> listAttributes)
          Set the document attributes list
 void setCategories(java.util.List<Category> listCategory)
           
 void setCodeDocumentType(java.lang.String strCodeDocumentType)
          Sets the CodeDocumentType
 void setComment(java.lang.String strComment)
          Sets the Comment
 void setCreatorId(int nIdCreator)
          Sets the IdCreator
 void setDateCreation(java.sql.Timestamp dateCreation)
          Sets the DateCreation
 void setDateModification(java.sql.Timestamp dateModification)
          Sets the Date of the last Modification
 void setDateValidityBegin(java.sql.Timestamp dateValidityBegin)
          Sets the begining Date of the validity period of the document
 void setDateValidityEnd(java.sql.Timestamp dateValidityEnd)
          Sets the end Date of the validity period of the document
 void setId(int nIdDocument)
          Sets the IdDocument
 void setIsEmailNotifiedComment(int nIsEmailNotifiedComment)
          Sets the nIsEmailNotifiedComment
 void setIsModeratedComment(int nIsModeratedComment)
          Sets the nIsModeratedComment
 void setLocale(java.util.Locale locale)
          Sets the Locale
 void setMailingListId(int nIdMailingList)
          Sets the IdMailingList
 void setPageTemplateDocumentId(int nIdPageTemplateDocument)
          Sets the IdPageTemplateDocument
 void setPublishedStatus(int nPublishedStatus)
           
 void setSpace(java.lang.String strSpace)
          Sets the Space
 void setSpaceId(int nIdSpace)
          Sets the IdSpace
 void setStateId(int nIdState)
          Sets the IdState
 void setStateKey(java.lang.String strState)
          Sets the State
 void setSummary(java.lang.String strSummary)
          Sets the Summary
 void setTitle(java.lang.String strTitle)
          Sets the Title
 void setType(java.lang.String strType)
          Sets the Type
 void setXmlMetadata(java.lang.String strXmlMetadata)
          Sets the XmlMetadata
 void setXmlValidatedContent(java.lang.String strXmlValidatedContent)
          Sets the XmlValidatedContent
 void setXmlWorkingContent(java.lang.String strXmlWorkingContent)
          Sets the XmlWorkingContent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Document

public Document()
Method Detail

getId

public int getId()
Returns the IdDocument

Returns:
The IdDocument

setId

public void setId(int nIdDocument)
Sets the IdDocument

Parameters:
nIdDocument - The IdDocument

getLocale

public java.util.Locale getLocale()
Returns the Locale

Returns:
The Locale

setLocale

public void setLocale(java.util.Locale locale)
Sets the Locale

Specified by:
setLocale in interface fr.paris.lutece.portal.service.i18n.Localizable
Parameters:
locale - The Locale

getCodeDocumentType

public java.lang.String getCodeDocumentType()
Returns the CodeDocumentType

Returns:
The CodeDocumentType

setCodeDocumentType

public void setCodeDocumentType(java.lang.String strCodeDocumentType)
Sets the CodeDocumentType

Parameters:
strCodeDocumentType - The CodeDocumentType

getTitle

public java.lang.String getTitle()
Returns the Title

Returns:
The Title

setTitle

public void setTitle(java.lang.String strTitle)
Sets the Title

Parameters:
strTitle - The Title

getSummary

public java.lang.String getSummary()
Returns the Summary

Returns:
The Summary

setSummary

public void setSummary(java.lang.String strSummary)
Sets the Summary

Parameters:
strSummary - The Summary

getDateCreation

public java.sql.Timestamp getDateCreation()
Returns the DateCreation

Returns:
The DateCreation

setDateCreation

public void setDateCreation(java.sql.Timestamp dateCreation)
Sets the DateCreation

Parameters:
dateCreation - The DateCreation

getCreatorId

public int getCreatorId()
Returns the IdCreator

Returns:
The IdCreator

setCreatorId

public void setCreatorId(int nIdCreator)
Sets the IdCreator

Parameters:
nIdCreator - The IdCreator

getDateModification

public java.sql.Timestamp getDateModification()
Returns the Date of the last Modification

Returns:
The Date of the last Modification

setDateModification

public void setDateModification(java.sql.Timestamp dateModification)
Sets the Date of the last Modification

Parameters:
dateModification - The Date of the last Modification

getDateValidityBegin

public java.sql.Timestamp getDateValidityBegin()
Returns the begining Date of the validity period of the document

Returns:
The begining Date of the validity period of the document

setDateValidityBegin

public void setDateValidityBegin(java.sql.Timestamp dateValidityBegin)
Sets the begining Date of the validity period of the document

Parameters:
dateValidityBegin - The begining Date of the validity period of the document

getDateValidityEnd

public java.sql.Timestamp getDateValidityEnd()
Returns the end Date of the validity period of the document

Returns:
The end Date of the validity period of the document

setDateValidityEnd

public void setDateValidityEnd(java.sql.Timestamp dateValidityEnd)
Sets the end Date of the validity period of the document

Parameters:
dateValidityEnd - The end Date of the validity period of the document

getComment

public java.lang.String getComment()
Returns the Comment

Returns:
The Comment

setComment

public void setComment(java.lang.String strComment)
Sets the Comment

Parameters:
strComment - The Comment

getXmlWorkingContent

public java.lang.String getXmlWorkingContent()
Returns the XmlWorkingContent

Returns:
The XmlWorkingContent

setXmlWorkingContent

public void setXmlWorkingContent(java.lang.String strXmlWorkingContent)
Sets the XmlWorkingContent

Parameters:
strXmlWorkingContent - The XmlWorkingContent

getXmlValidatedContent

public java.lang.String getXmlValidatedContent()
Returns the XmlValidatedContent

Returns:
The XmlValidatedContent

setXmlValidatedContent

public void setXmlValidatedContent(java.lang.String strXmlValidatedContent)
Sets the XmlValidatedContent

Parameters:
strXmlValidatedContent - The XmlValidatedContent

getXmlMetadata

public java.lang.String getXmlMetadata()
Returns the XmlMetadata

Returns:
The XmlMetadata

setXmlMetadata

public void setXmlMetadata(java.lang.String strXmlMetadata)
Sets the XmlMetadata

Parameters:
strXmlMetadata - The XmlMetadata

getSpaceId

public int getSpaceId()
Returns the IdSpace

Returns:
The IdSpace

setSpaceId

public void setSpaceId(int nIdSpace)
Sets the IdSpace

Parameters:
nIdSpace - The IdSpace

getSpace

public java.lang.String getSpace()
Returns the Space

Returns:
The Space

setSpace

public void setSpace(java.lang.String strSpace)
Sets the Space

Parameters:
strSpace - The Space

getStateId

public int getStateId()
Returns the IdState

Returns:
The IdState

setStateId

public void setStateId(int nIdState)
Sets the IdState

Parameters:
nIdState - The IdState

getStateKey

public java.lang.String getStateKey()
Returns the State

Returns:
The State

getState

public java.lang.String getState()
Returns the State

Returns:
The State

setStateKey

public void setStateKey(java.lang.String strState)
Sets the State

Parameters:
strState - The State

setAcceptSiteComments

public void setAcceptSiteComments(int nAcceptSiteComments)
Sets the nAcceptComment

Parameters:
nAcceptSiteComments - The nAcceptComment

getAcceptSiteComments

public int getAcceptSiteComments()
Returns the nAcceptComment

Returns:
The nAcceptComment

setIsModeratedComment

public void setIsModeratedComment(int nIsModeratedComment)
Sets the nIsModeratedComment

Parameters:
nIsModeratedComment - The nIsModeratedComment

getIsModeratedComment

public int getIsModeratedComment()
Returns the nIsModeratedComment

Returns:
The nIsModeratedComment

setIsEmailNotifiedComment

public void setIsEmailNotifiedComment(int nIsEmailNotifiedComment)
Sets the nIsEmailNotifiedComment

Parameters:
nIsEmailNotifiedComment - The nIsEmailNotifiedComment

getIsEmailNotifiedComment

public int getIsEmailNotifiedComment()
Returns the nIsEmailNotifiedComment

Returns:
The nIsEmailNotifiedComment

getMailingListId

public int getMailingListId()
Returns the IdMailingList

Returns:
The IdMailingList

setMailingListId

public void setMailingListId(int nIdMailingList)
Sets the IdMailingList

Parameters:
nIdMailingList - The IdMailingList

getPageTemplateDocumentId

public int getPageTemplateDocumentId()
Returns the IdPageTemplateDocument

Returns:
The IdPageTemplateDocument

setPageTemplateDocumentId

public void setPageTemplateDocumentId(int nIdPageTemplateDocument)
Sets the IdPageTemplateDocument

Parameters:
nIdPageTemplateDocument - The IdPageTemplateDocument

getAttributes

public java.util.List<DocumentAttribute> getAttributes()
Returns attributes List

Returns:
The document attributes list

setAttributes

public void setAttributes(java.util.List<DocumentAttribute> listAttributes)
Set the document attributes list

Parameters:
listAttributes - The document attributes list

getActions

public java.util.List getActions()
Returns Actions List

Returns:
The document Actions list

setActions

public void setActions(java.util.List listActions)
Set the document Actions list

Parameters:
listActions - The document Actions list

getType

public java.lang.String getType()
Returns the Type

Returns:
The Type

setType

public void setType(java.lang.String strType)
Sets the Type

Parameters:
strType - The Type

getCategories

public java.util.List<Category> getCategories()
Returns:
the _listCategory

setCategories

public void setCategories(java.util.List<Category> listCategory)
Parameters:
listCategory - the _listCategory to set

setPublishedStatus

public void setPublishedStatus(int nPublishedStatus)
Parameters:
nPublishedStatus - the nPublishedStatus to set

getPublishedStatus

public int getPublishedStatus()
Returns the PublishedSTatus

Returns:
The PublishedSTatus

getThumbnail

public java.lang.String getThumbnail()
Returns a Thumbnail url for the document based on a document attribute or on the document type.

Returns:
A Thumbnail url

getXml

public java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
Returns the xml of this document

Parameters:
request - The HTTP Servlet request
Returns:
the link xml

getXmlDocument

public java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
Returns the xml document of this link

Parameters:
request - The HTTP servlet request
Returns:
the link xml document

getAttribute

public DocumentAttribute getAttribute(java.lang.String strAttributeCode)
Returns a document attribute by its code

Parameters:
strAttributeCode - The Attribute Code
Returns:
the attribute object corresponding to the code

isValid

public boolean isValid()
Control that an document is valid, i.e. that its period of validity defined by its dateValidityBegin and its dateValidityEnd is valid : an document is valid if the current date > = dateValidityBegin and if current date < = dateValidityEnd If the two dates are null, the test of validity will return true if one of the dates is null, the result of the test will be that carried out on the non null date

Returns:
true if the document is valid, false otherwise

isOutOfDate

public boolean isOutOfDate()
Control that an document is out of date, i.e. dateValidityEnd has expired :

Returns:
true if the document is out of date, false otherwise


Copyright © 2009 Mairie de Paris. All Rights Reserved.