|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.paris.lutece.plugins.document.business.Document
public class Document
A document of the CMS.
Field Summary | |
---|---|
static java.lang.String |
CODE_DOCUMENT_TYPE_DOWNLOAD
|
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 |
Field Detail |
---|
public static final java.lang.String CODE_DOCUMENT_TYPE_DOWNLOAD
Constructor Detail |
---|
public Document()
Method Detail |
---|
public int getId()
public void setId(int nIdDocument)
nIdDocument
- The IdDocumentpublic java.util.Locale getLocale()
public void setLocale(java.util.Locale locale)
setLocale
in interface fr.paris.lutece.portal.service.i18n.Localizable
locale
- The Localepublic java.lang.String getCodeDocumentType()
public void setCodeDocumentType(java.lang.String strCodeDocumentType)
strCodeDocumentType
- The CodeDocumentTypepublic java.lang.String getTitle()
public void setTitle(java.lang.String strTitle)
strTitle
- The Titlepublic java.lang.String getSummary()
public void setSummary(java.lang.String strSummary)
strSummary
- The Summarypublic java.sql.Timestamp getDateCreation()
public void setDateCreation(java.sql.Timestamp dateCreation)
dateCreation
- The DateCreationpublic int getCreatorId()
public void setCreatorId(int nIdCreator)
nIdCreator
- The IdCreatorpublic java.sql.Timestamp getDateModification()
public void setDateModification(java.sql.Timestamp dateModification)
dateModification
- The Date of the last Modificationpublic java.sql.Timestamp getDateValidityBegin()
public void setDateValidityBegin(java.sql.Timestamp dateValidityBegin)
dateValidityBegin
- The begining Date of the validity period of the documentpublic java.sql.Timestamp getDateValidityEnd()
public void setDateValidityEnd(java.sql.Timestamp dateValidityEnd)
dateValidityEnd
- The end Date of the validity period of the documentpublic java.lang.String getComment()
public void setComment(java.lang.String strComment)
strComment
- The Commentpublic java.lang.String getXmlWorkingContent()
public void setXmlWorkingContent(java.lang.String strXmlWorkingContent)
strXmlWorkingContent
- The XmlWorkingContentpublic java.lang.String getXmlValidatedContent()
public void setXmlValidatedContent(java.lang.String strXmlValidatedContent)
strXmlValidatedContent
- The XmlValidatedContentpublic java.lang.String getXmlMetadata()
public void setXmlMetadata(java.lang.String strXmlMetadata)
strXmlMetadata
- The XmlMetadatapublic int getSpaceId()
public void setSpaceId(int nIdSpace)
nIdSpace
- The IdSpacepublic java.lang.String getSpace()
public void setSpace(java.lang.String strSpace)
strSpace
- The Spacepublic int getStateId()
public void setStateId(int nIdState)
nIdState
- The IdStatepublic java.lang.String getStateKey()
public java.lang.String getState()
public void setStateKey(java.lang.String strState)
strState
- The Statepublic void setAcceptSiteComments(int nAcceptSiteComments)
nAcceptSiteComments
- The nAcceptCommentpublic int getAcceptSiteComments()
public void setIsModeratedComment(int nIsModeratedComment)
nIsModeratedComment
- The nIsModeratedCommentpublic int getIsModeratedComment()
public void setIsEmailNotifiedComment(int nIsEmailNotifiedComment)
nIsEmailNotifiedComment
- The nIsEmailNotifiedCommentpublic int getIsEmailNotifiedComment()
public int getMailingListId()
public void setMailingListId(int nIdMailingList)
nIdMailingList
- The IdMailingListpublic int getPageTemplateDocumentId()
public void setPageTemplateDocumentId(int nIdPageTemplateDocument)
nIdPageTemplateDocument
- The IdPageTemplateDocumentpublic java.util.List<DocumentAttribute> getAttributes()
public void setAttributes(java.util.List<DocumentAttribute> listAttributes)
listAttributes
- The document attributes listpublic java.util.List getActions()
public void setActions(java.util.List listActions)
listActions
- The document Actions listpublic java.lang.String getType()
public void setType(java.lang.String strType)
strType
- The Typepublic java.util.List<Category> getCategories()
public void setCategories(java.util.List<Category> listCategory)
listCategory
- the _listCategory to setpublic void setPublishedStatus(int nPublishedStatus)
nPublishedStatus
- the nPublishedStatus to setpublic int getPublishedStatus()
public java.lang.String getThumbnail()
public java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
request
- The HTTP Servlet request
public java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
request
- The HTTP servlet request
public DocumentAttribute getAttribute(java.lang.String strAttributeCode)
strAttributeCode
- The Attribute Code
public boolean isValid()
public boolean isOutOfDate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |