fr.paris.lutece.plugins.document.business.publication

Class DocumentPublicationHome

java.lang.Object

fr.paris.lutece.plugins.document.business.publication.DocumentPublicationHome

public class DocumentPublicationHome
extends Object

This class provides instances management methods for DocumentPublication objects

Constructor Summary

Constructors

Constructor and Description
DocumentPublicationHome()

Method Summary

Modifier and Type	Method and Description
static void	create(DocumentPublication documentPublication) Create the documentsPublication object
static Collection<DocumentPublication>	findByDocumentId(int nDocumentId) Find the list of DocumentPublication objects specified by the document id
static Collection<DocumentPublication>	findByDocumentIdAndStatus(int nDocumentId, int nStatus) Find the list of DocumentPublication objects specified by the document id and the status
static Collection<DocumentPublication>	findByPortletId(int nPortletId) Find the list of DocumentPublication objects specified by the portlet id
static Collection<DocumentPublication>	findByPortletIdAndStatus(int nPortletId, int nStatus) Find the list of DocumentPublication objects specified by the portlet id and the status
static DocumentPublication	findByPrimaryKey(int nPortletId, int nDocumentId) Find the DocumentPublication object specified by the portlet id and document id
static int	findMaxDocumentOrderByPortletId(int nPortletId) Find the max document order from a Portlet id
static Collection<DocumentPublication>	findSinceDatePublishingAndStatus(Date datePublishing, int nStatus) Find the list of DocumentPublication objects specified the status and published at or after the specified date
static void	remove(int nPortletId, int nDocumentId) Remove the DocumentPublication object specified by portlet id and document id
static void	removeFromDocumentId(int nDocumentId) Remove all DocumentPublication objects specified by document id
static void	removeFromPortletId(int nPortletId) Remove all DocumentPublication objects specified by portlet id
static void	update(DocumentPublication documentPublication) Update the DocumentPublication object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentPublicationHome

public DocumentPublicationHome()

Method Detail

create

public static void create(DocumentPublication documentPublication)

Create the documentsPublication object

Parameters:

documentPublication - The document Publication object

update

public static void update(DocumentPublication documentPublication)

Update the DocumentPublication object

Parameters:

documentPublication - The DocumentPublication object

remove

public static void remove(int nPortletId,
                          int nDocumentId)

Remove the DocumentPublication object specified by portlet id and document id

Parameters:

nPortletId - the portlet identifier

nDocumentId - the document identifier

removeFromPortletId

public static void removeFromPortletId(int nPortletId)

Remove all DocumentPublication objects specified by portlet id

Parameters:

nPortletId - the portlet identifier

removeFromDocumentId

public static void removeFromDocumentId(int nDocumentId)

Remove all DocumentPublication objects specified by document id

Parameters:

nDocumentId - the document identifier

findByPrimaryKey

public static DocumentPublication findByPrimaryKey(int nPortletId,
                                                   int nDocumentId)

Find the DocumentPublication object specified by the portlet id and document id

Parameters:

nPortletId - The portlet identifier

nDocumentId - The document identifier

Returns:

The DocumentPublication object or null if the object does not exists

findByPortletId

public static Collection<DocumentPublication> findByPortletId(int nPortletId)

Find the list of DocumentPublication objects specified by the portlet id

Parameters:

nPortletId - The portlet identifier

Returns:

The DocumentPublication objects Collection ordered by documentOrder ascending. The list is empty if no objects found.

findByDocumentId

public static Collection<DocumentPublication> findByDocumentId(int nDocumentId)

Find the list of DocumentPublication objects specified by the document id

Parameters:

nDocumentId - The document identifier

Returns:

The DocumentPublication objects Collection ordered by documentOrder ascending. The list is empty if no objects found.

findByPortletIdAndStatus

public static Collection<DocumentPublication> findByPortletIdAndStatus(int nPortletId,
                                                                       int nStatus)

Find the list of DocumentPublication objects specified by the portlet id and the status

Parameters:

nPortletId - The portlet identifier

nStatus - The status

Returns:

The DocumentPublication objects Collection ordered by documentOrder ascending. The list is empty if no objects found.

findByDocumentIdAndStatus

public static Collection<DocumentPublication> findByDocumentIdAndStatus(int nDocumentId,
                                                                        int nStatus)

Find the list of DocumentPublication objects specified by the document id and the status

Parameters:

nDocumentId - The document identifier

nStatus - The status

Returns:

The DocumentPublication objects Collection ordered by documentOrder ascending. The list is empty if no objects found.

findSinceDatePublishingAndStatus

public static Collection<DocumentPublication> findSinceDatePublishingAndStatus(Date datePublishing,
                                                                               int nStatus)

Find the list of DocumentPublication objects specified the status and published at or after the specified date

Parameters:

datePublishing - The publication date

nStatus - The status

Returns:

The DocumentPublication objects Collection ordered by documentOrder ascending. The list is empty if no objects found.

findMaxDocumentOrderByPortletId

public static int findMaxDocumentOrderByPortletId(int nPortletId)

Find the max document order from a Portlet id

Parameters:

nPortletId - the Portlet identifer

Returns:

The max document order