atg.svc.repository.service
Class FavoritesService

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.svc.repository.service.BaseService
              atg.svc.repository.service.SharedService
                  atg.svc.repository.service.FavoritesService

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

public class FavoritesService
extends SharedService

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

FavoritesService()

Method Summary

atg.svc.repository.beans.Favorites	createFavorites() Creates a new transient Favorites repository bean.
void	deleteFavorite(java.lang.String pFavoritesId) Delete the specified favorites from repository.
atg.svc.repository.beans.Favorites	edit(java.lang.String pFavoritesId) Gets an editable version of a favorite given the repository id of the favorite .
java.util.Collection	getFavorites() Returns a list of favorites visible to the current user.
java.util.Collection	getFavorites(java.lang.String pProfileId) Returns a list of favorite visible to the user.
atg.svc.repository.beans.Favorites	getFavoritesById(java.lang.String pFavoritesId) Finds a Favorites by it's repository id.
java.util.Collection	getFavoritesByIdAndType(java.lang.String pProfileId, atg.svc.repository.beans.FavoritesType pType) Returns a list favorite of the specified type that are visible for the given user.
java.util.Collection	getFavoritesByIdAndType(java.lang.String pProfileId, java.lang.String pType) Returns a list favorite of the specified type that are visible for the given user.
java.util.Collection	getFavoritesBySolutionId(java.lang.String pSolutionId) Gets the collection of Favorites for the given solution id.
java.util.Collection	getFavoritesByType(atg.svc.repository.beans.FavoritesType pType) Returns a list of favorite of type 'PDFDocument' or 'document' or 'solution' that are visible to the current user.
java.util.Collection	getFavoritesByType(java.lang.String pType) Returns a list of favorite of type 'PDFDocument' or 'document' or 'solution' that are visible to the current user.
java.util.Collection	getFavoritesDocument() Returns a list of favorite of type 'document' that are visible to the current user.
java.util.Collection	getFavoritesDocument(java.lang.String pProfileId) Returns a list of favorite of type 'document' that are visible to the specified user.
java.util.Collection	getFavoritesPDFDocument() Returns a list of favorite of type 'PDFDocument' that are visible to the current user.
java.util.Collection	getFavoritesPDFDocument(java.lang.String pProfileId) Returns a list of favorite of type 'PDFDocument' that are visible to the specifed user.
java.util.Collection	getFavoritesSolution() Returns a list of favorite of type 'solution' that are visible to the current user.
java.util.Collection	getFavoritesSolution(java.lang.String pProfileId) Returns a list of favorite of type 'solution' that are visible specified user.
int	getMaxDisplayedTitleLength() Gets the maximum length to display the title.
ProfileService	getProfileService()
UserOptionsService	getUserOptionsService()
boolean	isRecordAlreadyExists(atg.svc.repository.beans.Favorites pFavorites) Checks if record already created for the specified solution id, context id , group id and URL
void	saveFavorites(atg.svc.repository.beans.Favorites pFavorites) If the user already has saved the maximum number of favorites, removes oldest favorites.
void	setMaxDisplayedTitleLength(int pMaxDisplayedTitleLength) Sets the maximum length to display the title.
void	setProfileService(ProfileService pProfileService)
void	setUserOptionsService(UserOptionsService pUserOptionsService)

Methods inherited from class atg.svc.repository.service.SharedService

getServiceSharedBeanHomes, getServiceSharedBeanHomesName, getServiceSharedRepositoryHomes, getServiceSharedRepositoryHomesName, setServiceSharedBeanHomesName, setServiceSharedRepositoryHomesName

Methods inherited from class atg.svc.repository.service.BaseService

getRepositoryService, getToday, setRepositoryService

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

FavoritesService

public FavoritesService()

Method Detail

getUserOptionsService

public UserOptionsService getUserOptionsService()

setUserOptionsService

public void setUserOptionsService(UserOptionsService pUserOptionsService)

getProfileService

public ProfileService getProfileService()

setProfileService

public void setProfileService(ProfileService pProfileService)

getMaxDisplayedTitleLength

public int getMaxDisplayedTitleLength()

Gets the maximum length to display the title.

Returns:

The maximum length to display the title.

setMaxDisplayedTitleLength

public void setMaxDisplayedTitleLength(int pMaxDisplayedTitleLength)

Sets the maximum length to display the title.

Parameters:

pMaxDisplayedTitleLength - The maximum length to display the title.

createFavorites

public atg.svc.repository.beans.Favorites createFavorites()
                                                   throws javax.ejb.CreateException

Creates a new transient Favorites repository bean. Pouplates the user currently logged in user. After calling the appropriate setters, pass this object into the saveFavorites method to persist it to the db.

Returns:

transient Favorites r2j bean.

Throws:

javax.ejb.CreateException

edit

public atg.svc.repository.beans.Favorites edit(java.lang.String pFavoritesId)
                                        throws ObjectNotFoundException

Gets an editable version of a favorite given the repository id of the favorite .

Parameters:

pFavoritesId - Id of the favorite

Returns:

A Favorites ReposImpl.

Throws:

ObjectNotFoundException

getFavoritesById

public atg.svc.repository.beans.Favorites getFavoritesById(java.lang.String pFavoritesId)
                                                    throws ObjectNotFoundException

Finds a Favorites by it's repository id.

Parameters:

pFavoritesId - The repository id.

Returns:

The Favorites ReposImpl

Throws:

ObjectNotFoundException - If the id is not found.

saveFavorites

public void saveFavorites(atg.svc.repository.beans.Favorites pFavorites)
                   throws javax.ejb.CreateException,
                          ObjectNotFoundException,
                          PersistenceException,
                          TransactionException,
                          javax.ejb.FinderException,
                          DuplicateRecordException

If the user already has saved the maximum number of favorites, removes oldest favorites.

Parameters:

pFavorites - that should added for the user

Throws:

javax.ejb.CreateException - If the create fails.

ObjectNotFoundException - If the save fails.

PersistenceException - If the save fails.

TransactionException

javax.ejb.FinderException

DuplicateRecordException

isRecordAlreadyExists

public boolean isRecordAlreadyExists(atg.svc.repository.beans.Favorites pFavorites)

Checks if record already created for the specified solution id, context id , group id and URL

Parameters:

pFavorites -

deleteFavorite

public void deleteFavorite(java.lang.String pFavoritesId)
                    throws ObjectNotFoundException,
                           PersistenceException

Delete the specified favorites from repository.

Parameters:

pFavoritesId - - favorite id.

Throws:

ObjectNotFoundException

PersistenceException

getFavorites

public java.util.Collection getFavorites()

Returns a list of favorites visible to the current user. The list is ordered alphabetically by favorite name.

Returns:

A list of favorites visible to the user

getFavorites

public java.util.Collection getFavorites(java.lang.String pProfileId)

Returns a list of favorite visible to the user. The list is ordered alphabetically by favorite id.

Parameters:

pProfileId - profile id of the user we're looking up.

Returns:

A list of favorites visible to the user

getFavoritesSolution

public java.util.Collection getFavoritesSolution()

Returns a list of favorite of type 'solution' that are visible to the current user.

Returns:

A list of the user's favorites solutions

getFavoritesSolution

public java.util.Collection getFavoritesSolution(java.lang.String pProfileId)

Returns a list of favorite of type 'solution' that are visible specified user.

Parameters:

pProfileId - profile id of the user we're looking up.

Returns:

A list of the user's favorites solutions

getFavoritesDocument

public java.util.Collection getFavoritesDocument()

Returns a list of favorite of type 'document' that are visible to the current user.

Returns:

A list of the user's favorites Documents

getFavoritesDocument

public java.util.Collection getFavoritesDocument(java.lang.String pProfileId)

Returns a list of favorite of type 'document' that are visible to the specified user.

Parameters:

pProfileId - profile id of the user we're looking up.

Returns:

A list of the user's favorites Documents

getFavoritesPDFDocument

public java.util.Collection getFavoritesPDFDocument()

Returns a list of favorite of type 'PDFDocument' that are visible to the current user.

Returns:

A list of the user's favorites PDF Documents

getFavoritesPDFDocument

public java.util.Collection getFavoritesPDFDocument(java.lang.String pProfileId)

Returns a list of favorite of type 'PDFDocument' that are visible to the specifed user.

Parameters:

pProfileId - profile id of the user we're looking up.

Returns:

A list of the user's favorites PDF Documents

getFavoritesByType

public java.util.Collection getFavoritesByType(atg.svc.repository.beans.FavoritesType pType)

Returns a list of favorite of type 'PDFDocument' or 'document' or 'solution' that are visible to the current user.

Parameters:

pType - - favorite type.'PDFDocument' or 'document' or 'solution'

Returns:

A list of the user's favorites PDF Documents

getFavoritesByType

public java.util.Collection getFavoritesByType(java.lang.String pType)

Returns a list of favorite of type 'PDFDocument' or 'document' or 'solution' that are visible to the current user.

Parameters:

pType - - favorite type.'PDFDocument' or 'document' or 'solution'

Returns:

A list of the user's favorites PDF Documents

getFavoritesByIdAndType

public java.util.Collection getFavoritesByIdAndType(java.lang.String pProfileId,
                                                    atg.svc.repository.beans.FavoritesType pType)

Returns a list favorite of the specified type that are visible for the given user.

Parameters:

pProfileId - profile id of the user we're looking up.

pType - type "solution" or "document" or 'PDFDocument'

Returns:

A list of the user's favorite

getFavoritesByIdAndType

public java.util.Collection getFavoritesByIdAndType(java.lang.String pProfileId,
                                                    java.lang.String pType)

Returns a list favorite of the specified type that are visible for the given user.

Parameters:

pProfileId - profile id of the user we're looking up.

pType - type "solution" or "document" or 'PDFDocument'

Returns:

A list of the user's favorites

getFavoritesBySolutionId

public java.util.Collection getFavoritesBySolutionId(java.lang.String pSolutionId)
                                              throws javax.ejb.FinderException

Gets the collection of Favorites for the given solution id.

Parameters:

pSolutionId - The id of the solution.

Returns:

The Collection of Favorites objects.

Throws:

javax.ejb.FinderException - If the finder fails.