atg.svc.repository.service
Class LogicalOrganizationService

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.LogicalOrganizationService
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 LogicalOrganizationService
extends BaseService

Base service for business logic classes that use the logical organization repository (/atg/userprofiling/LogicalOrganizationRepository).


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
LogicalOrganizationService()
           
 
Method Summary
 atg.svc.userprofiling.logicalorganization.SolutionInternalAudience createSolutionInternalAudience()
          Creates a SolutionInternalAudience object that wraps the solutionInternalAudience repository item.
 atg.svc.userprofiling.logicalorganization.SolutionOwningGroup createSolutionOwningGroup()
          Creates a SolutionOwningGroup object that wraps the solutionOwningGroup repository item.
 java.util.Collection findAllSolutionInternalAudiences()
          Finds all SolutionInternalAudience items in the repository.
 java.util.Collection findAllSolutionLogicalOrganizations()
          Gets all SolutionLogicalOrganizations (the super-type of SolutionOwningGroup and SolutionInternalAudience) in the repository.
 java.util.Collection findAllSolutionLogicalOrganizationsByOrganizationId(java.lang.String pOrganizationId)
          Gets all SolutionLogicalOrganizations (the super-type of SolutionOwningGroup and SolutionInternalAudience) in the repository with the given physical organization id.
 java.util.Collection findAllSolutionOwningGroups()
          Finds all SolutionOwningGroup items in the repository.
 atg.svc.userprofiling.logicalorganization.SolutionInternalAudience findSolutionInternalAudienceByOrganizationId(java.lang.String pOrganizationId)
          Finds a SolutionInternalAudience given the physical organization id.
 atg.svc.userprofiling.logicalorganization.SolutionOwningGroup findSolutionOwningGroupById(java.lang.String pId)
          Finds a SolutionOwningGroup given the repository id.
 atg.svc.userprofiling.logicalorganization.SolutionOwningGroup findSolutionOwningGroupByOrganizationId(java.lang.String pOrganizationId)
          Finds a SolutionOwningGroup given the physical organization id.
 java.util.List getInternalAudienceListById(java.lang.String[] pIds)
          Gets a set of internal audience objects given an array of repository ids.
 atg.svc.userprofiling.logicalorganization.LogicalOrganizationHomes getLogicalOrganizationRepositoryHomes()
          Gets the factory for the repository homes for the LogicalOrganizationRepository.
 java.lang.String getLogicalOrganizationRepositoryHomesName()
          Gets the name of the repository homes for the LogicalOrganizationRepository.
 atg.svc.userprofiling.logicalorganization.SolutionInternalAudience getSolutionInternalAudienceById(java.lang.String pId)
          Gets a SolutionInternalAudience given the repository id.
 atg.svc.userprofiling.logicalorganization.SolutionInternalAudience getSolutionInternalAudienceByOrganization(java.lang.String pOrgId, java.lang.String pOrgName)
          Finds a SolutionInternalAudience given the organization id.
 atg.svc.userprofiling.logicalorganization.SolutionOwningGroup getSolutionOwningGroupByOrganization(java.lang.String pOrgId, java.lang.String pOrgName)
          Finds a SolutionOwningGroup given the organization id.
 void removeSolutionInternalAudience(java.lang.String pId)
          Removes a SolutionInternalAudience given the repository id.
 void removeSolutionLogicalOrganizationsByOrganizationId(java.lang.String pOrganizationId)
          Removes all SolutionLogicalOrganizations with the given physical organization id.
 void removeSolutionOwningGroup(java.lang.String pId)
          Removes a SolutionOwningGroup given the repository id.
 void saveSolutionInternalAudience(atg.svc.userprofiling.logicalorganization.SolutionInternalAudience pSolutionInternalAudience)
          Saves the SolutionInternalAudience to the repository.
 void saveSolutionOwningGroup(atg.svc.userprofiling.logicalorganization.SolutionOwningGroup pSolutionOwningGroup)
          Saves the SolutionOwningGroup to the repository.
 void setLogicalOrganizationRepositoryHomesName(java.lang.String pLogicalOrganizationRepositoryHomesName)
          Sets the name of the repository homes for the LogicalOrganizationRepository.
 
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

LogicalOrganizationService

public LogicalOrganizationService()
Method Detail

getLogicalOrganizationRepositoryHomesName

public java.lang.String getLogicalOrganizationRepositoryHomesName()
Gets the name of the repository homes for the LogicalOrganizationRepository.

Returns:
The name of the repository homes for the LogicalOrganizationRepository.

setLogicalOrganizationRepositoryHomesName

public void setLogicalOrganizationRepositoryHomesName(java.lang.String pLogicalOrganizationRepositoryHomesName)
Sets the name of the repository homes for the LogicalOrganizationRepository.

Parameters:
pLogicalOrganizationRepositoryHomesName - The name of the repository homes for the LogicalOrganizationRepository.

createSolutionOwningGroup

public atg.svc.userprofiling.logicalorganization.SolutionOwningGroup createSolutionOwningGroup()
                                                                                        throws javax.ejb.CreateException
Creates a SolutionOwningGroup object that wraps the solutionOwningGroup repository item.

Returns:
A SolutionOwningGroup repository object. The object is not committed until saveSolutionOwningGroup is called.
Throws:
javax.ejb.CreateException - If the create operation fails.

findSolutionOwningGroupById

public atg.svc.userprofiling.logicalorganization.SolutionOwningGroup findSolutionOwningGroupById(java.lang.String pId)
                                                                                          throws ObjectNotFoundException
Finds a SolutionOwningGroup given the repository id.

Parameters:
pId - The repository id of the SolutionOwningGroup to find.
Returns:
A SolutionOwningGroup object.
Throws:
ObjectNotFoundException - If the SolutionOwningGroup is not found by id.

findSolutionOwningGroupByOrganizationId

public atg.svc.userprofiling.logicalorganization.SolutionOwningGroup findSolutionOwningGroupByOrganizationId(java.lang.String pOrganizationId)
                                                                                                      throws ObjectNotFoundException
Finds a SolutionOwningGroup given the physical organization id.

Parameters:
pOrganizationId - The physical organization id of the SolutionOwningGroup to find.
Returns:
A SolutionOwningGroup object.
Throws:
ObjectNotFoundException - If the SolutionOwningGroup is not found by id.

findAllSolutionOwningGroups

public java.util.Collection findAllSolutionOwningGroups()
Finds all SolutionOwningGroup items in the repository.

Returns:
A Collection of SolutionOwningGroup items.
Throws:
atg.core.exception.ContainerRuntimeException - If the finder execution fails.

getSolutionOwningGroupByOrganization

public atg.svc.userprofiling.logicalorganization.SolutionOwningGroup getSolutionOwningGroupByOrganization(java.lang.String pOrgId,
                                                                                                          java.lang.String pOrgName)
                                                                                                   throws javax.ejb.CreateException,
                                                                                                          PersistenceException
Finds a SolutionOwningGroup given the organization id. If not SolutionOwningGroup exists with the given id, the given id and organization name are used to create and commit a new SolutionOwningGroup to the repository.

Parameters:
pOrgId - The physical organization id.
pOrgName - The physical organization name to set if none is found by id.
Returns:
The found SolutionOwningGroup or the newly committed one created from the input params.
Throws:
javax.ejb.CreateException - If the create operation fails.
PersistenceException - If the save operation fails.

removeSolutionOwningGroup

public void removeSolutionOwningGroup(java.lang.String pId)
                               throws ObjectNotFoundException,
                                      PersistenceException
Removes a SolutionOwningGroup given the repository id.

Parameters:
pId - The repository id of the SolutionOwningGroup to remove.
Throws:
ObjectNotFoundException - If the SolutionOwningGroup is not found.
PersistenceException - If the remove fails.

saveSolutionOwningGroup

public void saveSolutionOwningGroup(atg.svc.userprofiling.logicalorganization.SolutionOwningGroup pSolutionOwningGroup)
                             throws PersistenceException
Saves the SolutionOwningGroup to the repository.

Parameters:
pSolutionOwningGroup - The SolutionOwningGroup to save.
Throws:
PersistenceException - If the save operation fails.

createSolutionInternalAudience

public atg.svc.userprofiling.logicalorganization.SolutionInternalAudience createSolutionInternalAudience()
                                                                                                  throws javax.ejb.CreateException
Creates a SolutionInternalAudience object that wraps the solutionInternalAudience repository item.

Returns:
A SolutionInternalAudience repository object. The object is not committed until saveSolutionInternalAudience is called.
Throws:
javax.ejb.CreateException - If the create operation fails.

getSolutionInternalAudienceById

public atg.svc.userprofiling.logicalorganization.SolutionInternalAudience getSolutionInternalAudienceById(java.lang.String pId)
                                                                                                   throws ObjectNotFoundException
Gets a SolutionInternalAudience given the repository id.

Parameters:
pId - The repository id of the SolutionInternalAudience to find.
Returns:
A SolutionInternalAudience object.
Throws:
ObjectNotFoundException - If the SolutionInternalAudience is not found by id.

getSolutionInternalAudienceByOrganization

public atg.svc.userprofiling.logicalorganization.SolutionInternalAudience getSolutionInternalAudienceByOrganization(java.lang.String pOrgId,
                                                                                                                    java.lang.String pOrgName)
                                                                                                             throws javax.ejb.CreateException,
                                                                                                                    PersistenceException
Finds a SolutionInternalAudience given the organization id. If not SolutionInternalAudience exists with the given id, the given id and organization name are used to create and commit a new SolutionInternalAudience to the repository.

Parameters:
pOrgId - The physical organization id.
pOrgName - The physical organization name to set if none is found by id.
Returns:
The found SolutionInternalAudience or the newly committed one created from the input params.
Throws:
javax.ejb.CreateException - If the create operation fails.
PersistenceException - If the save operation fails.

findSolutionInternalAudienceByOrganizationId

public atg.svc.userprofiling.logicalorganization.SolutionInternalAudience findSolutionInternalAudienceByOrganizationId(java.lang.String pOrganizationId)
                                                                                                                throws ObjectNotFoundException
Finds a SolutionInternalAudience given the physical organization id.

Parameters:
pOrganizationId - The physical organization id of the SolutionInternalAudience to find.
Returns:
A SolutionInternalAudience object.
Throws:
ObjectNotFoundException - If the SolutionInternalAudience is not found by id.

findAllSolutionInternalAudiences

public java.util.Collection findAllSolutionInternalAudiences()
Finds all SolutionInternalAudience items in the repository.

Returns:
A Collection of SolutionInternalAudience.
Throws:
atg.core.exception.ContainerRuntimeException - If the finder execution fails.

getInternalAudienceListById

public java.util.List getInternalAudienceListById(java.lang.String[] pIds)
                                           throws ObjectNotFoundException
Gets a set of internal audience objects given an array of repository ids.

Parameters:
pIds - The array of repository ids.
Returns:
The Set of SolutionInternalAudience objects or an empty set if the pIds parameter is null or empty.
Throws:
ObjectNotFoundException - If a SolutionInternalAudience cannot be found by a given id.

removeSolutionInternalAudience

public void removeSolutionInternalAudience(java.lang.String pId)
                                    throws ObjectNotFoundException,
                                           PersistenceException
Removes a SolutionInternalAudience given the repository id.

Parameters:
pId - The repository id of the SolutionInternalAudience to remove.
Throws:
ObjectNotFoundException - If the SolutionInternalAudience is not found.
PersistenceException - If the remove fails.

saveSolutionInternalAudience

public void saveSolutionInternalAudience(atg.svc.userprofiling.logicalorganization.SolutionInternalAudience pSolutionInternalAudience)
                                  throws PersistenceException
Saves the SolutionInternalAudience to the repository.

Parameters:
pSolutionInternalAudience - The SolutionInternalAudience to save.
Throws:
PersistenceException - If the save operation fails.

findAllSolutionLogicalOrganizations

public java.util.Collection findAllSolutionLogicalOrganizations()
Gets all SolutionLogicalOrganizations (the super-type of SolutionOwningGroup and SolutionInternalAudience) in the repository.

Returns:
A Collection of SolutionLogicalOrganization items.
Throws:
atg.core.exception.ContainerRuntimeException - If the finder execution fails.

findAllSolutionLogicalOrganizationsByOrganizationId

public java.util.Collection findAllSolutionLogicalOrganizationsByOrganizationId(java.lang.String pOrganizationId)
Gets all SolutionLogicalOrganizations (the super-type of SolutionOwningGroup and SolutionInternalAudience) in the repository with the given physical organization id.

Returns:
A Collection of SolutionLogicalOrganization items.
Throws:
atg.core.exception.ContainerRuntimeException - If the finder execution fails.

removeSolutionLogicalOrganizationsByOrganizationId

public void removeSolutionLogicalOrganizationsByOrganizationId(java.lang.String pOrganizationId)
                                                        throws PersistenceException
Removes all SolutionLogicalOrganizations with the given physical organization id.

Parameters:
pOrganizationId - The organization id of the SolutionLogicalOrganizations to remove.
Throws:
PersistenceException - If the remove fails.
atg.core.exception.ContainerRuntimeException - If the finder to get the SolutionLogicalOrganizations fails.

getLogicalOrganizationRepositoryHomes

public atg.svc.userprofiling.logicalorganization.LogicalOrganizationHomes getLogicalOrganizationRepositoryHomes()
Gets the factory for the repository homes for the LogicalOrganizationRepository.

Returns:
The factory for the repository homes for the LogicalOrganizationRepository.