atg.svc.repository.service
Class FrameworkProfileService

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.svc.repository.service.BaseService
              extended by atg.svc.repository.service.FrameworkProfileService
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
Direct Known Subclasses:
ProfileService

@Service(requiredProperties={"recentTicketsService","profileTools","externalProfileTools"})
public class FrameworkProfileService
extends BaseService

The Framework profile service.


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
FrameworkProfileService()
           
 
Method Summary
 atg.userprofiling.ProfileTools getExternalProfileTools()
           
 atg.repository.RepositoryItem getExternalUserById(java.lang.String pUserId)
          Gets an external user of the given type with the given id.
 atg.userprofiling.ProfileTools getProfileTools()
           
 java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTickets()
          Returns the Collection of the Recent Tickets of the currently logged in users.
 java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTickets(java.lang.String pProfile)
          Returns the Collection of the Recent Tickets of specified users.
 java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTickets(java.lang.String pProfile, atg.svc.repository.beans.RecentTicketsType pRecentTicketsType)
          Returns the Collection of the Recent Tickets of specified users.
 java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTickets(java.lang.String pProfile, java.lang.String pRecentTicketsType)
          Returns the Collection of the Recent Tickets of specified users.
 RecentTicketsService getRecentTicketsService()
           
 java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTicketsViewed()
          Returns the Collection of the Recent Tickets -viewed the currently logged in users.
 java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTicketsWorked()
          Returns the Collection of the Recent Tickets - Worked the currently logged in users.
 atg.repository.RepositoryItem getUserById(java.lang.String pUserId)
          Gets a user of the given type with the given id.
 void setExternalProfileTools(atg.userprofiling.ProfileTools pExternalProfileTools)
           
 void setProfileTools(atg.userprofiling.ProfileTools pProfileTools)
           
 void setRecentTicketsService(RecentTicketsService pRecentTicketsService)
           
 
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

FrameworkProfileService

public FrameworkProfileService()
Method Detail

getRecentTicketsService

public RecentTicketsService getRecentTicketsService()

setRecentTicketsService

public void setRecentTicketsService(RecentTicketsService pRecentTicketsService)

getProfileTools

public atg.userprofiling.ProfileTools getProfileTools()

setProfileTools

public void setProfileTools(atg.userprofiling.ProfileTools pProfileTools)

getExternalProfileTools

public atg.userprofiling.ProfileTools getExternalProfileTools()

setExternalProfileTools

public void setExternalProfileTools(atg.userprofiling.ProfileTools pExternalProfileTools)

getRecentTickets

public java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTickets()
Returns the Collection of the Recent Tickets of the currently logged in users.

Returns:
Collection

getRecentTickets

public java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTickets(java.lang.String pProfile)
Returns the Collection of the Recent Tickets of specified users.

Parameters:
pProfile - user profile to retrieve Recent Tickets
Returns:
Collection

getRecentTickets

public java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTickets(java.lang.String pProfile,
                                                                                     atg.svc.repository.beans.RecentTicketsType pRecentTicketsType)
Returns the Collection of the Recent Tickets of specified users.

Parameters:
pProfile - user profile to retrieve Recent Tickets
pRecentTicketsType - - "viewed" or "worked"
Returns:
Collection

getRecentTickets

public java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTickets(java.lang.String pProfile,
                                                                                     java.lang.String pRecentTicketsType)
Returns the Collection of the Recent Tickets of specified users.

Parameters:
pProfile - user profile to retrieve Recent Tickets
pRecentTicketsType - - "viewed" or "worked"
Returns:
Collection

getRecentTicketsViewed

public java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTicketsViewed()
Returns the Collection of the Recent Tickets -viewed the currently logged in users.

Returns:
Collection

getRecentTicketsWorked

public java.util.Collection<atg.svc.repository.beans.RecentTickets> getRecentTicketsWorked()
Returns the Collection of the Recent Tickets - Worked the currently logged in users.

Returns:
Collection

getUserById

public atg.repository.RepositoryItem getUserById(java.lang.String pUserId)
                                          throws ObjectNotFoundException
Gets a user of the given type with the given id.

Parameters:
pUserId - The repository id of the user
Returns:
The user repository item
Throws:
ObjectNotFoundException - If no user is found with the given type and id

getExternalUserById

public atg.repository.RepositoryItem getExternalUserById(java.lang.String pUserId)
                                                  throws ObjectNotFoundException
Gets an external user of the given type with the given id.

Parameters:
pUserId - The repository id of the user
Returns:
The user repository item
Throws:
ObjectNotFoundException - If no user is found with the given type and id