atg.svc.repository.service
Class FavoriteQueryService

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

All Implemented Interfaces:

atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, 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

@Service(requiredProperties={"optionService","sessionService","queryService","uIService"})
public class FavoriteQueryService
extends SharedService

Business methods for KnowledgeSession objects. A Session is a problem solving session and it captures a history of the following events; search, browse, view answer

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

FavoriteQueryService()

Method Summary

atg.svc.repository.beans.FavoriteQuery	createFavoriteQuery() Creates a new transient FavoriteQuery repository bean.
atg.svc.repository.beans.FavoriteQuery	createFavoriteQuery(java.lang.String pQueryId) Creates a new transient FavoriteQuery repository bean.
void	deleteFavoriteQuery(java.lang.String pFavoriteQueryId)
atg.svc.repository.beans.FavoriteQuery	edit(java.lang.String pFavoriteQueryId) Gets an editable version of a favorite query given the repository id of the favorite query.
java.lang.String	getAllowedToManagePublicQueriesAccessRight()
java.lang.String	getAllowedToViewPublicQueriesAccessRight()
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getFavoriteQueries() Returns a list of personal and public favorite queries visible to the current user.
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getFavoriteQueries(java.lang.String pProfileId) Returns a list of personal and public favorite queries visible to the user.
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getFavoriteQueriesByType(java.lang.String pType) Returns a list of personal and public favorite queries of the specified type that are visible to the current user.
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getFavoriteQueriesByType(java.lang.String pProfileId, java.lang.String pType) Returns a list of personal and public favorite queries of the specified type that are visible for the given user.
atg.svc.repository.beans.FavoriteQuery	getFavoriteQueryById(java.lang.String pFavoriteQueryId) Finds a FavoriteQuery by it's repository id.
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getFavoriteReviewQueries() Returns a list of the personal and public favorite queries of type 'review' that are visible to the current user.
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getFavoriteSolutionQueries() Returns a list of the personal and public favorite queries of type 'solution' that are visible to the current user.
atg.svc.repository.service.OptionService	getOptionService()
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getPersonalFavoriteQueries() A list of the user's favorite personal queries - may include queries that the user has been pushed to groups.
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getPersonalFavoriteQueries(java.lang.String pProfileId)
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getPersonalFavoriteQueriesByType(java.lang.String pType)
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getPersonalFavoriteQueriesByType(java.lang.String pProfileId, java.lang.String pType)
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getPublicFavoriteQueries()
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getPublicFavoriteQueries(java.lang.String pProfileId)
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getPublicFavoriteQueriesByType(java.lang.String pType)
java.util.Collection<atg.svc.repository.beans.FavoriteQuery>	getPublicFavoriteQueriesByType(java.lang.String pProfileId, java.lang.String pType)
QueryService	getQueryService()
SessionService	getSessionService()
UIService	getUiService()
boolean	isAllowedToManagePublicQueries()
boolean	isAllowedToViewPublicQueries()
void	saveFavoriteQuery(atg.svc.repository.beans.FavoriteQuery pFavoriteQuery) Adds a query to a user's list of favorite searches.
void	setAllowedToManagePublicQueriesAccessRight(java.lang.String pAllowedToManagePublicQueriesAccessRight)
void	setAllowedToViewPublicQueriesAccessRight(java.lang.String pAllowedToViewPublicQueriesAccessRight)
void	setOptionService(atg.svc.repository.service.OptionService pOptionService)
void	setQueryService(QueryService pQueryService)
void	setSessionService(SessionService pSessionService)
void	setUiService(UIService pUiService)

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, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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

FavoriteQueryService

public FavoriteQueryService()

Method Detail

getOptionService

public atg.svc.repository.service.OptionService getOptionService()

setOptionService

public void setOptionService(atg.svc.repository.service.OptionService pOptionService)

getSessionService

public SessionService getSessionService()

setSessionService

public void setSessionService(SessionService pSessionService)

getQueryService

public QueryService getQueryService()

setQueryService

public void setQueryService(QueryService pQueryService)

getAllowedToViewPublicQueriesAccessRight

public java.lang.String getAllowedToViewPublicQueriesAccessRight()

setAllowedToViewPublicQueriesAccessRight

public void setAllowedToViewPublicQueriesAccessRight(java.lang.String pAllowedToViewPublicQueriesAccessRight)

getAllowedToManagePublicQueriesAccessRight

public java.lang.String getAllowedToManagePublicQueriesAccessRight()

setAllowedToManagePublicQueriesAccessRight

public void setAllowedToManagePublicQueriesAccessRight(java.lang.String pAllowedToManagePublicQueriesAccessRight)

getUiService

public UIService getUiService()

setUiService

public void setUiService(UIService pUiService)

isAllowedToViewPublicQueries

public boolean isAllowedToViewPublicQueries()

isAllowedToManagePublicQueries

public boolean isAllowedToManagePublicQueries()

createFavoriteQuery

public atg.svc.repository.beans.FavoriteQuery createFavoriteQuery()
                                                           throws javax.ejb.CreateException

Creates a new transient FavoriteQuery repository bean. Pouplates the user and timestamp with the currently logged in user and timestamp. After calling the appropriate setters, pass this object into the saveFavoriteQuery method to persist it to the db.

Returns:

transient FavoriteQuery r2j bean.

Throws:

javax.ejb.CreateException

createFavoriteQuery

public atg.svc.repository.beans.FavoriteQuery createFavoriteQuery(java.lang.String pQueryId)
                                                           throws javax.ejb.CreateException,
                                                                  ObjectNotFoundException

Creates a new transient FavoriteQuery repository bean. Pouplates the user and timestamp with the currently logged in user and timestamp. Populates the query with information from the input KnowledgeQuery. After calling the appropriate setters, pass this object into the saveFavoriteQuery method to persist it to the db.

Parameters:

pQueryId - The repository id of a KnowledgeQuery that we want to copy. Generally comes from a query in the KnowledgeSession.

Returns:

transient FavoriteQuery r2j bean.

Throws:

javax.ejb.CreateException

ObjectNotFoundException

edit

public atg.svc.repository.beans.FavoriteQuery edit(java.lang.String pFavoriteQueryId)
                                            throws ObjectNotFoundException

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

Parameters:

pFavoriteQueryId - Id of the favorite query

Returns:

A FavoriteQuery ReposImpl.

Throws:

ObjectNotFoundException

getFavoriteQueryById

public atg.svc.repository.beans.FavoriteQuery getFavoriteQueryById(java.lang.String pFavoriteQueryId)
                                                            throws ObjectNotFoundException

Finds a FavoriteQuery by it's repository id.

Parameters:

pFavoriteQueryId - The repository id.

Returns:

The FavoriteQuery ReposImpl

Throws:

ObjectNotFoundException - If the id is not found.

saveFavoriteQuery

public void saveFavoriteQuery(atg.svc.repository.beans.FavoriteQuery pFavoriteQuery)
                       throws javax.ejb.CreateException,
                              ObjectNotFoundException,
                              PersistenceException,
                              TransactionException,
                              javax.ejb.FinderException

Adds a query to a user's list of favorite searches. If the user already has saved the maximum number of searches, removes oldest search.

Parameters:

pFavoriteQuery - Query to add.

Throws:

javax.ejb.CreateException - If the create fails.

ObjectNotFoundException - If the save fails.

PersistenceException - If the save fails.

TransactionException

javax.ejb.FinderException

deleteFavoriteQuery

public void deleteFavoriteQuery(java.lang.String pFavoriteQueryId)
                         throws ObjectNotFoundException,
                                PersistenceException

Throws:

ObjectNotFoundException

PersistenceException

getFavoriteQueries

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getFavoriteQueries()

Returns a list of personal and public favorite queries visible to the current user. The list is ordered alphabetically by favorite query name.

Returns:

A list of the personal and public favorite queries visible to the user

getFavoriteQueries

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getFavoriteQueries(java.lang.String pProfileId)

Returns a list of personal and public favorite queries visible to the user. The list is ordered alphabetically by favorite query name.

Parameters:

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

Returns:

A list of the personal and public favorite queries visible to the user

getPersonalFavoriteQueries

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getPersonalFavoriteQueries()

A list of the user's favorite personal queries - may include queries that the user has been pushed to groups.

Returns:

A list of the personal favorite queries for the current user listed alphabetically

getPersonalFavoriteQueries

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getPersonalFavoriteQueries(java.lang.String pProfileId)

Parameters:

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

Returns:

A list of the user's personal favorite queries listed alphabetically

getPublicFavoriteQueries

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getPublicFavoriteQueries()

Returns:

A list of the public favorite queries visible to the current user. The list is ordered alphabetically by favorite query name.

getPublicFavoriteQueries

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getPublicFavoriteQueries(java.lang.String pProfileId)

Parameters:

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

Returns:

A list of the user's personal favorite queries listed from newest to oldest

getFavoriteSolutionQueries

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getFavoriteSolutionQueries()

Returns a list of the personal and public favorite queries of type 'solution' that are visible to the current user. The list is ordered alphabetically by favorite query name.

Returns:

A list of the user's personal and public favorite solution queries

getFavoriteReviewQueries

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getFavoriteReviewQueries()

Returns a list of the personal and public favorite queries of type 'review' that are visible to the current user. The list is ordered alphabetically by favorite query name.

Returns:

A list of the user's personal and public favorite review queries

getFavoriteQueriesByType

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getFavoriteQueriesByType(java.lang.String pType)

Returns a list of personal and public favorite queries of the specified type that are visible to the current user. The list is ordered alphabetically by favorite query name.

Parameters:

pType - query type "solution" or "review"

Returns:

A list of the user's personal and public favorite queries

getFavoriteQueriesByType

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getFavoriteQueriesByType(java.lang.String pProfileId,
                                                                                             java.lang.String pType)

Returns a list of personal and public favorite queries of the specified type that are visible for the given user. The list is ordered alphabetically by favorite query name.

Parameters:

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

pType - query type "solution" or "review"

Returns:

A list of the user's favorite queries listed from newest to oldest

getPersonalFavoriteQueriesByType

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getPersonalFavoriteQueriesByType(java.lang.String pType)

Parameters:

pType - query type "solution" or "review"

Returns:

A list of the personal favorite queries for the current user listed alphabetically

getPersonalFavoriteQueriesByType

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getPersonalFavoriteQueriesByType(java.lang.String pProfileId,
                                                                                                     java.lang.String pType)

Parameters:

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

pType - query type "solution" or "review"

Returns:

A list of the user's personal favorite queries listed alphabetically

getPublicFavoriteQueriesByType

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getPublicFavoriteQueriesByType(java.lang.String pType)

Parameters:

pType - query type "solution" or "review"

Returns:

A list of the public favorite queries visible to the current user. The list is ordered alphabetically by favorite query name.

getPublicFavoriteQueriesByType

public java.util.Collection<atg.svc.repository.beans.FavoriteQuery> getPublicFavoriteQueriesByType(java.lang.String pProfileId,
                                                                                                   java.lang.String pType)

Parameters:

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

pType - query type "solution" or "review"

Returns:

A list of the user's personal favorite queries listed alphabetically