Package lumis.content.core

Class ContentManager

java.lang.Object

lumis.content.core.ContentManager

All Implemented Interfaces:

IContentManager, IContentManagerSPI

public class ContentManager
extends java.lang.Object
implements IContentManagerSPI

Content manager implementation.

Since:

4.2.0

Version:

$Revision: 25342 $ $Date: 2022-11-03 18:25:43 -0300 (Thu, 03 Nov 2022) $

Constructor Summary

Constructors

Constructor	Description
ContentManager()

Method Summary

Modifier and Type	Method	Description
void	addContent(Content content)	Adds a content to persistence.
void	deleteContent(Content content)	Deletes a content from persistence.
ContentVersion	getActiveVersionByItemId(java.lang.String itemId)	Returns the active version of the ContentLocale that the ContentVersion with the given item id belongs to.
java.lang.String	getActiveVersionItemIdByItemId(java.lang.String itemId)	Try to find the item id of the active version of the ContentLocale that the ContentVersion with the given item id belongs to.
Content	getContent(java.lang.String contentId)	Returns a persistent content instance.
Content	getContentByItemId(java.lang.String itemId)	Returns the content related with the specified business data.
ContentLocale	getContentLocale(java.lang.String contentLocaleId)	Returns the a content locale by its identifier.
ContentVersion	getContentVersion(java.lang.String contentVersionId)	Returns the a content version by its identifier.
ContentVersion	getContentVersionByItemId(java.lang.String itemId)	Returns the a content version that refers the given itemId.
ContentVersion	getPublishedContentVersion(java.lang.String contentId, java.lang.String serviceInstanceId)	Returns the published version more appropriated to the current user for the specified content and service instance.
ContentVersion	getPublishedContentVersion(java.lang.String contentId, java.lang.String serviceInstanceId, boolean ignorePublishedTo)	Returns the published version more appropriated to the current user for the specified content and service instance.
void	lock(java.lang.String contentLocaleId, LockType lockType)	Locks contentlocale acording to lockType.
void	releaseLock(java.lang.String contentLocaleId)	Releases the lock for the contentLocale.
void	scheduleReindex(Content content)	Schedules the re-indexing of a content after the current transaction commits.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentManager

public ContentManager()

Method Detail

addContent

public void addContent(Content content)
                throws PortalException

Description copied from interface: IContentManager

Adds a content to persistence.

Specified by:

addContent in interface IContentManager

Parameters:

content - the transient content instance to be persisted.

Throws:

PortalException

deleteContent

public void deleteContent(Content content)
                   throws PortalException

Description copied from interface: IContentManager

Deletes a content from persistence.

Specified by:

deleteContent in interface IContentManager

Parameters:

content - the persistent content instance to be deleted.

Throws:

PortalException

getContent

public Content getContent(java.lang.String contentId)
                   throws PortalException

Description copied from interface: IContentManager

Returns a persistent content instance.

Specified by:

getContent in interface IContentManager

Parameters:

contentId - the content's identifier.

Returns:

a persistent content instance.

Throws:

PortalObjectNotFoundException - if no content with such id was found.

PortalException

getContentByItemId

public Content getContentByItemId(java.lang.String itemId)
                           throws PortalException

Description copied from interface: IContentManager

Returns the content related with the specified business data.

Specified by:

getContentByItemId in interface IContentManager

Parameters:

itemId - the business data identifier.

Returns:

a persistent content instance.

Throws:

PortalObjectNotFoundException - if no content for such itemId was found.

PortalException

scheduleReindex

public void scheduleReindex(Content content)
                     throws PortalException

Description copied from interface: IContentManager

Schedules the re-indexing of a content after the current transaction commits.

Re-indexing of contents occurs automatically when a content's metadata is affected, so this method normally is not needed to be used directly. But this may be used in case of a customized change of content's data that doesn't trigger the re-indexing automatically.

Specified by:

scheduleReindex in interface IContentManager

Parameters:

content - the content.

Throws:

PortalException

getContentLocale

public ContentLocale getContentLocale(java.lang.String contentLocaleId)
                               throws PortalException

Description copied from interface: IContentManager

Returns the a content locale by its identifier.

Specified by:

getContentLocale in interface IContentManager

Parameters:

contentLocaleId - the content locale identifier.

Returns:

the content locale.

Throws:

PortalObjectNotFoundException - if no content locale with the given identifier was found.

PortalException

getContentVersionByItemId

public ContentVersion getContentVersionByItemId(java.lang.String itemId)
                                         throws PortalException

Description copied from interface: IContentManager

Returns the a content version that refers the given itemId.

Specified by:

getContentVersionByItemId in interface IContentManager

Parameters:

itemId - the item identifier.

Returns:

the content version.

Throws:

PortalObjectNotFoundException - if no such content version was found.

PortalException

getContentVersion

public ContentVersion getContentVersion(java.lang.String contentVersionId)
                                 throws PortalException

Description copied from interface: IContentManager

Returns the a content version by its identifier.

Specified by:

getContentVersion in interface IContentManager

Parameters:

contentVersionId - the content version identifier.

Returns:

the content version.

Throws:

PortalObjectNotFoundException - if no content version with the given identifier was found.

PortalException

getPublishedContentVersion

public ContentVersion getPublishedContentVersion(java.lang.String contentId,
                                                 java.lang.String serviceInstanceId)
                                          throws PortalException

Description copied from interface: IContentManager

Returns the published version more appropriated to the current user for the specified content and service instance.

Specified by:

getPublishedContentVersion in interface IContentManager

Parameters:

contentId - the content identifier.

serviceInstanceId - the service instance identifier where the version is published to. This is an optional argument, if null, the publication to service instance is not used to filter the version query.

Returns:

the content version.

Throws:

PortalObjectNotFoundException - if no version published to the user and service instance, in the appropriated locale, was found.

PortalException

getPublishedContentVersion

public ContentVersion getPublishedContentVersion(java.lang.String contentId,
                                                 java.lang.String serviceInstanceId,
                                                 boolean ignorePublishedTo)
                                          throws PortalException

Description copied from interface: IContentManagerSPI

Returns the published version more appropriated to the current user for the specified content and service instance.

Specified by:

getPublishedContentVersion in interface IContentManagerSPI

Parameters:

contentId - the content identifier.

serviceInstanceId - the service instance identifier where the version is published to. This is an optional argument, if null, the publication to service instance is not used to filter the version query.

ignorePublishedTo - indicates whether the publish to principals information should be ignored.

Returns:

the content version.

Throws:

PortalObjectNotFoundException - if no version published to the user and service instance, in the appropriated locale, was found.

PortalException

lock

public void lock(java.lang.String contentLocaleId,
                 LockType lockType)
          throws ContentLocaleAlreadyLockedException,
                 PortalException

Description copied from interface: IContentManager

Locks contentlocale acording to lockType. If lock metadata is not available for the content, this method does nothing and does not throw exception regarding metadata not configured for this content. It creates a new transaction to execute the update.

Specified by:

lock in interface IContentManager

Parameters:

contentLocaleId - the id of the content-locale to change its lock.

lockType - defines what type of lock that the content-locale should have. See LockType.

Throws:

ContentLocaleAlreadyLockedException - when there already is a lock on the content-locale and the person trying to lock is not the current lock owner.

AccessDeniedException - if the current user does not have permission to lock the content locale.

PortalException

releaseLock

public void releaseLock(java.lang.String contentLocaleId)
                 throws PortalException

Description copied from interface: IContentManager

Releases the lock for the contentLocale. If lock metadata is not available for the content, this method does nothing and does not throw exception regarding metadata not configured this content.. It creates a new transaction to execute the update.

Specified by:

releaseLock in interface IContentManager

Parameters:

contentLocaleId - the id of the content-locale to release its lock.

Throws:

AccessDeniedException - if the current user does not have permission to release the lock on the content locale.

PortalException

getActiveVersionItemIdByItemId

public java.lang.String getActiveVersionItemIdByItemId(java.lang.String itemId)
                                                throws NoActiveVersionPossibleMappingException,
                                                       PortalException

Try to find the item id of the active version of the ContentLocale that the ContentVersion with the given item id belongs to.

Parameters:

itemId - the item id.

Returns:

a mapped item id.

Throws:

NoActiveVersionPossibleMappingException - if no mapping could be done.

PortalException - if any other problem occur.

Since:

6.0.0

getActiveVersionByItemId

public ContentVersion getActiveVersionByItemId(java.lang.String itemId)
                                        throws NoActiveVersionPossibleMappingException,
                                               PortalException

Returns the active version of the ContentLocale that the ContentVersion with the given item id belongs to.

Parameters:

itemId - the item id.

Returns:

the active version.

Throws:

NoActiveVersionPossibleMappingException - if no mapping could be done.

PortalException - if any other problem occur.

Since:

10.4.0