| Modifier and Type | Method and Description | 
|---|---|
| static Document | DocumentHome. create(Document document)Creation of an instance of document | 
| static Document | DocumentHome. findByPrimaryKey(int nKey)Returns an instance of a document whose identifier is specified in
 parameter | 
| static Document | DocumentHome. findByPrimaryKeyWithoutBinaries(int nKey)Returns an instance of a document whose identifier is specified in
 parameter | 
| Document | DocumentDAO. load(int nDocumentId)Load the data of Document from the table | 
| Document | IDocumentDAO. load(int nDocumentId)Load the data of Document from the table | 
| static Document | DocumentHome. loadLastModifiedAttributes(int nDocumentId)Load document type and date last modification for HTTP GET conditional
 request ("If-Modified-Since") | 
| Document | DocumentDAO. loadLastModifiedAttributes(int nIdDocument)Load document type and date last modification for HTTP GET conditional
 request ("If-Modified-Since") | 
| Document | IDocumentDAO. loadLastModifiedAttributes(int nDocumentId)Load document type and date last modification for HTTP GET conditional request ("If-Modified-Since") | 
| static Document | DocumentHome. loadLastModifiedDocumentFromUser(String strUserName)Load the data of last Document the user worked in from the table | 
| Document | DocumentDAO. loadLastModifiedDocumentFromUser(String strUserName)Load the data of last Document the user worked in from the table | 
| Document | IDocumentDAO. loadLastModifiedDocumentFromUser(String strUserName)Load the data of last Document the user worked in from the table | 
| static Document | DocumentHome. loadLastPublishedDocument()Load the data of last Document the user worked in from the table | 
| Document | DocumentDAO. loadLastPublishedDocument()Load the data of last Document the user worked in from the table | 
| Document | IDocumentDAO. loadLastPublishedDocument()Load the data of last Document the user worked in from the table | 
| Document | DocumentDAO. loadWithoutBinaries(int nDocumentId)Load the data of Document from the table | 
| Document | IDocumentDAO. loadWithoutBinaries(int nDocumentId)Returns an instance of a document whose identifier is specified in parameter | 
| static Document | DocumentHome. update(Document document,
      boolean bUpdateContent)Update of the document which is specified in parameter | 
| Modifier and Type | Method and Description | 
|---|---|
| static List<Document> | DocumentHome. findAll()Get the list of every documents | 
| static List<Document> | DocumentHome. findByFilter(DocumentFilter filter,
            Locale locale)Returns a collection of documents objects | 
| static List<Document> | DocumentHome. findByRelatedCategories(Document document,
                       Locale locale)Returns a collection of documents objects
 If more than one category is specified on filter,
 the result will corresponding to the document wich matched with one
 category at least. | 
| static List<Document> | DocumentHome. findBySpaceKey(int nSpaceId)Returns documents by space id | 
| List<Document> | DocumentDAO. loadFromSpaceId(int nSpaceId)Load from space id. | 
| List<Document> | IDocumentDAO. loadFromSpaceId(int nSpaceId)Returns documents by space id | 
| List<Document> | DocumentDAO. selectAll()Deprecated.   | 
| List<Document> | IDocumentDAO. selectAll()Gets all documents | 
| List<Document> | DocumentDAO. selectByFilter(DocumentFilter filter)Load the list of documents | 
| List<Document> | IDocumentDAO. selectByFilter(DocumentFilter filter)Load the list of documents | 
| List<Document> | DocumentDAO. selectByRelatedCategories(Document document)Load the list of documents in relation with categories of specified
 document | 
| List<Document> | IDocumentDAO. selectByRelatedCategories(Document document)Load the list of published documents in relation with categories of specified document | 
| Modifier and Type | Method and Description | 
|---|---|
| static Document | DocumentHome. create(Document document)Creation of an instance of document | 
| static List<Document> | DocumentHome. findByRelatedCategories(Document document,
                       Locale locale)Returns a collection of documents objects
 If more than one category is specified on filter,
 the result will corresponding to the document wich matched with one
 category at least. | 
| void | DocumentDAO. insert(Document document)Insert a new record in the table. | 
| void | IDocumentDAO. insert(Document document)Insert a new record in the table. | 
| static void | DocumentHome. loadAttributes(Document document)Load document attributes | 
| void | DocumentDAO. loadAttributes(Document document)Load the attributes of Document from the table | 
| void | IDocumentDAO. loadAttributes(Document document)Load document attributes | 
| static void | DocumentHome. loadAttributesWithoutBinaries(Document document,
                             boolean bValidated)Load document attributes | 
| void | DocumentDAO. loadAttributesWithoutBinaries(Document document,
                             boolean bValidated)Load the attributes of Document from the table | 
| void | IDocumentDAO. loadAttributesWithoutBinaries(Document document,
                             boolean bValidated)Load document attributes | 
| List<Document> | DocumentDAO. selectByRelatedCategories(Document document)Load the list of documents in relation with categories of specified
 document | 
| List<Document> | IDocumentDAO. selectByRelatedCategories(Document document)Load the list of published documents in relation with categories of specified document | 
| void | DocumentDAO. store(Document document,
     boolean bUpdateContent)Update the record in the table | 
| void | IDocumentDAO. store(Document document,
     boolean bUpdateContent)Update the record in the table | 
| static Document | DocumentHome. update(Document document,
      boolean bUpdateContent)Update of the document which is specified in parameter | 
| Modifier and Type | Method and Description | 
|---|---|
| static List<DocumentAction> | DocumentActionHome. getActionsList(Document document,
              Locale locale)Returns the list of allowed actions for the current document | 
| List<DocumentAction> | IDocumentActionDAO. selectActions(Document document)Load the list of actions for a document | 
| List<DocumentAction> | DocumentActionDAO. selectActions(Document document)Load the list of actions for a document | 
| Modifier and Type | Method and Description | 
|---|---|
| Document | DocumentEvent. getDocument()Returns the Document | 
| Modifier and Type | Method and Description | 
|---|---|
| void | DocumentService. archiveDocument(Document document,
               fr.paris.lutece.portal.business.user.AdminUser user,
               int nStateId)Archive a document | 
| void | DocumentService. changeDocumentState(Document document,
                   fr.paris.lutece.portal.business.user.AdminUser user,
                   int nStateId)Change the state of the document | 
| void | DocumentService. createDocument(Document document,
              fr.paris.lutece.portal.business.user.AdminUser user)Create a new document | 
| void | DocumentService. getActions(Document document,
          Locale locale,
          fr.paris.lutece.portal.business.user.AdminUser user)Add to the document all permitted actions according to the current user
 and
 using the current locale | 
| List<DocumentAction> | IDocumentActionsService. getActions(Document document,
          Locale locale,
          fr.paris.lutece.portal.business.user.AdminUser user)Add to the document all permitted actions according to the current user
 and
 using the current locale | 
| String | AttributeManager. getAttributeXmlValue(Document document,
                    DocumentAttribute attribute)Get the XML data corresponding to the attribute to build the docuemnt XML
 content | 
| String | DocumentService. getDocumentData(fr.paris.lutece.portal.web.upload.MultipartHttpServletRequest mRequest,
               Document document,
               Locale locale)Return the data of a document object | 
| String | DocumentService. getModifyForm(Document document,
             Locale locale,
             String strBaseUrl)Build an HTML form for the document modification for a given document | 
| String | AttributeManager. getModifyFormHtml(DocumentAttribute attribute,
                 Document document,
                 Locale locale,
                 String strBaseUrl)Gets the part of an HTML form to modify attribute data | 
| void | DocumentService. getPublishedStatus(Document document)Get the published status of a document | 
| void | DocumentService. modifyDocument(Document document,
              fr.paris.lutece.portal.business.user.AdminUser user)Modify a the content of a document | 
| void | DocumentService. moveDocument(Document document,
            fr.paris.lutece.portal.business.user.AdminUser user,
            int nNewSpace)Move a document from a space to another | 
| void | DocumentService. validateDocument(Document document,
                fr.paris.lutece.portal.business.user.AdminUser user,
                int nStateId)Validate a document | 
| Constructor and Description | 
|---|
| DocumentEvent(Document document,
             fr.paris.lutece.portal.business.user.AdminUser user,
             int nType)Creates a new instance of DocumentEvent | 
| Modifier and Type | Method and Description | 
|---|---|
| String | DefaultManager. getAttributeXmlValue(Document document,
                    DocumentAttribute attribute)Get the XML data corresponding to the attribute to build the docuemnt XML
 content | 
| String | InternalLinkManager. getAttributeXmlValue(Document document,
                    DocumentAttribute attribute)Get the XML data corresponding to the attribute to build the document XML content | 
| String | FileManager. getAttributeXmlValue(Document document,
                    DocumentAttribute attribute)Get the XML data corresponding to the attribute to build the document XML
 content | 
| String | UrlManager. getAttributeXmlValue(Document document,
                    DocumentAttribute attribute)Get the XML data corresponding to the attribute to build the document XML content | 
| String | RichTextManager. getAttributeXmlValue(Document document,
                    DocumentAttribute attribute)Get the XML data corresponding to the attribute to build the document XML content | 
| String | DefaultManager. getModifyFormHtml(DocumentAttribute attribute,
                 Document document,
                 Locale locale,
                 String strBaseUrl)Gets the part of an HTML form to modify attribute data | 
| Modifier and Type | Method and Description | 
|---|---|
| Document | PublishingService. getFirstValidPublishedDocument(int nPortletId)Get the first valid document published in a portlet or null if there are none | 
| Modifier and Type | Method and Description | 
|---|---|
| Collection<Document> | PublishingService. getAssignedDocumentsByPortletId(int nPortletId)Returns a  CollectionofDocumentobjects from aPortletidentifierDocumentcan be assigned or published. | 
| Collection<Document> | PublishingService. getPublishedDocumentsByPortletId(int nPortletId)Loads the list of the documents whose type is the same as the one specified in parameter
 Return published documents from a specified portlet | 
| Collection<Document> | PublishingService. getPublishedDocumentsSinceDate(Date datePublishing,
                              DocumentFilter documentFilter,
                              Locale locale)Loads the list of the documents whose filter and date publication is specified
 Return published documents since the publication date. | 
| Modifier and Type | Method and Description | 
|---|---|
| static org.apache.lucene.document.Document | DocumentIndexer. getDocument(Document document,
           String strUrl,
           String strRole,
           String strPortletDocumentId)Builds a document which will be used by Lucene during the indexing of the
 pages of the site with the following
 fields : summary, uid, url, contents, title and description. | 
Copyright © 2020 City of Paris. All rights reserved.