fr.paris.lutece.plugins.document.business
public class Document extends Object implements fr.paris.lutece.portal.service.i18n.Localizable, fr.paris.lutece.portal.service.resource.IExtendableResource
Modifier and Type | Field and Description |
---|---|
static String |
CODE_DOCUMENT_TYPE_DOWNLOAD |
static String |
CODE_DOCUMENT_TYPE_IMAGE |
static String |
PROPERTY_RESOURCE_TYPE |
Constructor and Description |
---|
Document() |
Modifier and Type | Method and Description |
---|---|
List |
getActions()
Returns Actions List
|
DocumentAttribute |
getAttribute(String strAttributeCode)
Returns a document attribute by its code
|
List<DocumentAttribute> |
getAttributes()
Returns attributes List
|
List<Category> |
getCategories() |
String |
getCodeDocumentType()
Returns the CodeDocumentType
|
String |
getComment()
Returns the Comment
|
int |
getCreatorId()
Returns the IdCreator
|
Timestamp |
getDateCreation()
Returns the DateCreation
|
Timestamp |
getDateModification()
Returns the Date of the last Modification
|
Timestamp |
getDateValidityBegin()
Returns the begining Date of the validity period of the document
|
Timestamp |
getDateValidityEnd()
Returns the end Date of the validity period of the document
|
String |
getExtendableResourceDescription() |
String |
getExtendableResourceImageUrl() |
String |
getExtendableResourceName() |
String |
getExtendableResourceType() |
int |
getId()
Returns the IdDocument
|
String |
getIdExtendableResource() |
Locale |
getLocale()
Returns the Locale
|
int |
getMailingListId()
Returns the IdMailingList
|
int |
getPageTemplateDocumentId()
Returns the IdPageTemplateDocument
|
int |
getPublishedStatus()
Returns the PublishedSTatus
|
String |
getSpace()
Returns the Space
|
int |
getSpaceId()
Returns the IdSpace
|
String |
getState()
Returns the State
|
int |
getStateId()
Returns the IdState
|
String |
getStateKey()
Returns the State
|
String |
getSummary()
Returns the Summary
|
String |
getThumbnail()
Returns a Thumbnail url for the document based on a document attribute or
on the document type.
|
String |
getTitle()
Returns the Title
|
String |
getType()
Returns the Type
|
String |
getXml(javax.servlet.http.HttpServletRequest request,
int nIdPortlet)
Returns the xml of this document
|
String |
getXmlDocument(javax.servlet.http.HttpServletRequest request,
int nIdPortlet)
Returns the xml document of this link
|
String |
getXmlMetadata()
Returns the XmlMetadata
|
String |
getXmlValidatedContent()
Returns the XmlValidatedContent
|
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 |
setActions(List listActions)
Set the document Actions list
|
void |
setAttributes(List<DocumentAttribute> listAttributes)
Set the document attributes list
|
void |
setCategories(List<Category> listCategory) |
void |
setCodeDocumentType(String strCodeDocumentType)
Sets the CodeDocumentType
|
void |
setComment(String strComment)
Sets the Comment
|
void |
setCreatorId(int nIdCreator)
Sets the IdCreator
|
void |
setDateCreation(Timestamp dateCreation)
Sets the DateCreation
|
void |
setDateModification(Timestamp dateModification)
Sets the Date of the last Modification
|
void |
setDateValidityBegin(Timestamp dateValidityBegin)
Sets the begining Date of the validity period of the document
|
void |
setDateValidityEnd(Timestamp dateValidityEnd)
Sets the end Date of the validity period of the document
|
void |
setId(int nIdDocument)
Sets the IdDocument
|
void |
setLocale(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(String strSpace)
Sets the Space
|
void |
setSpaceId(int nIdSpace)
Sets the IdSpace
|
void |
setStateId(int nIdState)
Sets the IdState
|
void |
setStateKey(String strState)
Sets the State
|
void |
setSummary(String strSummary)
Sets the Summary
|
void |
setTitle(String strTitle)
Sets the Title
|
void |
setType(String strType)
Sets the Type
|
void |
setXmlMetadata(String strXmlMetadata)
Sets the XmlMetadata
|
void |
setXmlValidatedContent(String strXmlValidatedContent)
Sets the XmlValidatedContent
|
void |
setXmlWorkingContent(String strXmlWorkingContent)
Sets the XmlWorkingContent
|
public static final String CODE_DOCUMENT_TYPE_DOWNLOAD
public static final String CODE_DOCUMENT_TYPE_IMAGE
public static final String PROPERTY_RESOURCE_TYPE
public int getId()
public void setId(int nIdDocument)
nIdDocument
- The IdDocumentpublic Locale getLocale()
public void setLocale(Locale locale)
setLocale
in interface fr.paris.lutece.portal.service.i18n.Localizable
locale
- The Localepublic String getCodeDocumentType()
public void setCodeDocumentType(String strCodeDocumentType)
strCodeDocumentType
- The CodeDocumentTypepublic String getTitle()
public void setTitle(String strTitle)
strTitle
- The Titlepublic String getSummary()
public void setSummary(String strSummary)
strSummary
- The Summarypublic Timestamp getDateCreation()
public void setDateCreation(Timestamp dateCreation)
dateCreation
- The DateCreationpublic int getCreatorId()
public void setCreatorId(int nIdCreator)
nIdCreator
- The IdCreatorpublic Timestamp getDateModification()
public void setDateModification(Timestamp dateModification)
dateModification
- The Date of the last Modificationpublic Timestamp getDateValidityBegin()
public void setDateValidityBegin(Timestamp dateValidityBegin)
dateValidityBegin
- The begining Date of the validity period of the
documentpublic Timestamp getDateValidityEnd()
public void setDateValidityEnd(Timestamp dateValidityEnd)
dateValidityEnd
- The end Date of the validity period of the
documentpublic String getComment()
public void setComment(String strComment)
strComment
- The Commentpublic String getXmlWorkingContent()
public void setXmlWorkingContent(String strXmlWorkingContent)
strXmlWorkingContent
- The XmlWorkingContentpublic String getXmlValidatedContent()
public void setXmlValidatedContent(String strXmlValidatedContent)
strXmlValidatedContent
- The XmlValidatedContentpublic String getXmlMetadata()
public void setXmlMetadata(String strXmlMetadata)
strXmlMetadata
- The XmlMetadatapublic int getSpaceId()
public void setSpaceId(int nIdSpace)
nIdSpace
- The IdSpacepublic String getSpace()
public void setSpace(String strSpace)
strSpace
- The Spacepublic int getStateId()
public void setStateId(int nIdState)
nIdState
- The IdStatepublic String getStateKey()
public String getState()
public void setStateKey(String strState)
strState
- The Statepublic int getMailingListId()
public void setMailingListId(int nIdMailingList)
nIdMailingList
- The IdMailingListpublic int getPageTemplateDocumentId()
public void setPageTemplateDocumentId(int nIdPageTemplateDocument)
nIdPageTemplateDocument
- The IdPageTemplateDocumentpublic List<DocumentAttribute> getAttributes()
public void setAttributes(List<DocumentAttribute> listAttributes)
listAttributes
- The document attributes listpublic List getActions()
public void setActions(List listActions)
listActions
- The document Actions listpublic String getType()
public void setType(String strType)
strType
- The Typepublic void setCategories(List<Category> listCategory)
listCategory
- the _listCategory to setpublic void setPublishedStatus(int nPublishedStatus)
nPublishedStatus
- the nPublishedStatus to setpublic int getPublishedStatus()
public String getThumbnail()
public String getXml(javax.servlet.http.HttpServletRequest request, int nIdPortlet)
request
- The HTTP Servlet requestnIdPortlet
- the id of the portlet where the document is publishedpublic String getXmlDocument(javax.servlet.http.HttpServletRequest request, int nIdPortlet)
nIdPortlet
- the id of the portlet where the document is publishedrequest
- The HTTP servlet requestpublic DocumentAttribute getAttribute(String strAttributeCode)
strAttributeCode
- The Attribute Codepublic boolean isValid()
public boolean isOutOfDate()
public String getIdExtendableResource()
getIdExtendableResource
in interface fr.paris.lutece.portal.service.resource.IExtendableResource
public String getExtendableResourceType()
getExtendableResourceType
in interface fr.paris.lutece.portal.service.resource.IExtendableResource
public String getExtendableResourceName()
getExtendableResourceName
in interface fr.paris.lutece.portal.service.resource.IExtendableResource
public String getExtendableResourceDescription()
getExtendableResourceDescription
in interface fr.paris.lutece.portal.service.resource.IExtendableResource
public String getExtendableResourceImageUrl()
getExtendableResourceImageUrl
in interface fr.paris.lutece.portal.service.resource.IExtendableResource
Copyright © 2014 Mairie de Paris. All rights reserved.