|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.paris.lutece.plugins.document.service.publishing.PublishingService
public class PublishingService
Publishing service
Method Summary | |
---|---|
void |
assign(int nDocumentId,
int nPortletId)
Assign Document to a Portlet |
void |
changeDocumentOrder(int nDocumentId,
int nPortletId,
int nNewOrder)
Change the Document order in a Portlet |
java.util.Collection<Document> |
getAssignedDocumentsByPortletId(int nPortletId)
Returns a Collection of Document objects from a Portlet identifier
Document can be assigned or published. |
DocumentPublication |
getDocumentPublication(int nPortletId,
int nDocumentId)
Return a DocumentPublication from a Portlet identifier and Document identifier |
static PublishingService |
getInstance()
Get the unique instance of the service |
int |
getMaxDocumentOrderByPortletId(int nPortletId)
Get the max document order from a Portlet id |
java.util.Collection<fr.paris.lutece.portal.business.portlet.Portlet> |
getPortletsByDocumentId(java.lang.String strDocumentId)
Loads the list of the portlets whoes contain Document specified by id |
java.util.Collection<Document> |
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 |
java.util.Collection<Document> |
getPublishedDocumentsSinceDate(java.util.Date datePublishing,
DocumentFilter documentFilter,
java.util.Locale locale)
Loads the list of the documents whose filter and date publication is specified Return published documents since the publication date. |
java.util.Collection<fr.paris.lutece.portal.business.portlet.Portlet> |
getPublishedPortlets()
Loads the list of portlets who contain published documents |
boolean |
isAssigned(int nDocumentId)
Check if the specified Document is assigned (unpublished or published) into at least one Portlet |
boolean |
isAssigned(int nDocumentId,
int nPortletId)
Check if the specified Document is assigned (unpublished or published) into the specified Portlet |
boolean |
isPublished(int nDocumentId)
Check if the specified Document is published into the specified Portlet |
boolean |
isPublished(int nDocumentId,
int nPortletId)
Check if the specified Document is published into the specified Portlet |
void |
publish(int nDocumentId,
int nPortletId)
Publishing documents assigned to a portlet at the begin of the list |
void |
unAssign(int nDocumentId,
int nPortletId)
unAssign Document to a Portlet |
void |
unPublish(int nDocumentId,
int nPortletId)
UnPublishing documents assigned to a portlet |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static PublishingService getInstance()
public void assign(int nDocumentId, int nPortletId)
Document
to a Portlet
nDocumentId
- The Document
identifiernPortletId
- The Portlet
identifierpublic void publish(int nDocumentId, int nPortletId)
document
- the DocumentListPortlet objectnPortletId
- the portlet identifierpublic void unPublish(int nDocumentId, int nPortletId)
nDocumentId
- the DocumentListPortlet identifiernPortletId
- the portlet identifierpublic void unAssign(int nDocumentId, int nPortletId)
Document
to a Portlet
nDocumentId
- The Document
identifiernPortletId
- The Portlet
identifierpublic void changeDocumentOrder(int nDocumentId, int nPortletId, int nNewOrder)
Document
order in a Portlet
nDocumentId
- the Document
identifiernPortletId
- the Portlet
identifiernNewOrder
- The new place in the listpublic boolean isPublished(int nDocumentId, int nPortletId)
Document
is published into the specified Portlet
nDocumentId
- The Document
identifiernPortletId
- The Portlet
identifier
Document
is published, false else (unpublished or not assigned)public boolean isPublished(int nDocumentId)
Document
is published into the specified Portlet
nDocumentId
- The Document
identifiernPortletId
- The Portlet
identifier
Document
is published, false else (unpublished or not assigned)public boolean isAssigned(int nDocumentId)
Document
is assigned (unpublished or published) into at least one Portlet
nDocumentId
- The Document
identifier
Document
is assigned (published or unpublished), false else (not assigned)public boolean isAssigned(int nDocumentId, int nPortletId)
Document
is assigned (unpublished or published) into the specified Portlet
nDocumentId
- The Document
identifiernPortletId
- The Portlet
identifier
Document
is assigned (published or unpublished), false else (not assigned)public DocumentPublication getDocumentPublication(int nPortletId, int nDocumentId)
DocumentPublication
from a Portlet
identifier and Document
identifier
nPortletId
- the Portlet
identifiernDocumentId
- the Document
identifier
DocumentPublication
or null if no object matchpublic java.util.Collection<Document> getAssignedDocumentsByPortletId(int nPortletId)
Collection
of Document
objects from a Portlet
identifier
Document
can be assigned or published.
nPortletId
- the Portlet
identifier
Collection
of Document
objectspublic java.util.Collection<Document> getPublishedDocumentsByPortletId(int nPortletId)
nPortletId
- the portlet identifier
public java.util.Collection<Document> getPublishedDocumentsSinceDate(java.util.Date datePublishing, DocumentFilter documentFilter, java.util.Locale locale)
datePublishing
- The start publication datedocumentFilter
- The filter for the published documents. The filter can be null or empty. The array of Ids will not be taked in account.locale
- The locale is used to get the list of documents with the findByFilter method
public java.util.Collection<fr.paris.lutece.portal.business.portlet.Portlet> getPortletsByDocumentId(java.lang.String strDocumentId)
strDocumentId
- the document identifier
Collection
of the portletspublic java.util.Collection<fr.paris.lutece.portal.business.portlet.Portlet> getPublishedPortlets()
Collection
of the portletspublic int getMaxDocumentOrderByPortletId(int nPortletId)
Portlet
id
nPortletId
- the Portlet
identifer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |