|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectatg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.svc.repository.service.BaseService
atg.svc.repository.service.KnowledgeBaseService
atg.svc.repository.service.OrganizationValueService
@Service(requiredProperties={"segmentService","profileService","solutionSecurityUtils","serviceRepository"}) public class OrganizationValueService
OrganizationValueService Business API for OrganizationValue objects
Nested Class Summary | |
---|---|
protected class |
OrganizationValueService.ComparatorOrganizationValueByDisplayName
Helper class comparator used to sort collection of OrganizationValues to return to UI |
protected class |
OrganizationValueService.ComparatorOrganizationValueByOrganizationId
Helper class comparator used to sort collection of OrganizationValues to return to UI |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
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 | |
---|---|
OrganizationValueService()
|
Method Summary | |
---|---|
void |
clearCachedAllInternalAudiences()
|
void |
clearCachedAllOwningGroups()
|
void |
deleteOrganizationValues(java.lang.String pOrgId)
Deletes all organization values that wrap the given organization id. |
void |
doStartService()
|
protected atg.svc.repository.beans.OrganizationValue |
findInternalAudienceByOrganizationId(java.lang.String pOrganizationId)
Finds and returns internal audience by organizationId. |
atg.svc.repository.beans.OrganizationValue |
findOrganizationValue(atg.svc.repository.beans.OrganizationValueType pType,
java.lang.String pOrgId)
Finds an OrganizationValue given its type and organization id. |
protected atg.svc.repository.beans.OrganizationValue |
findOwningGroupByOrganizationId(java.lang.String pOrganizationId)
Finds and returns owning group by organizationId. |
java.util.List<atg.svc.repository.beans.OrganizationValue> |
getAllInternalAudience()
Gets all internal audience OrganizationValue objects. |
java.util.List<atg.svc.repository.beans.OrganizationValue> |
getAllInternalAudienceByDisplayName()
Gets all owning group OrganizationValue items and sorts them by display name. |
java.util.List<atg.svc.repository.beans.OrganizationValue> |
getAllOrganizationValues()
Gets all OrganizationValue objects. |
java.util.List<atg.svc.repository.beans.OrganizationValue> |
getAllOwningGroups()
Gets all owning groups OrganizationValue objects. |
java.util.List<atg.svc.repository.beans.OrganizationValue> |
getAllOwningGroupsByDisplayName()
} Gets all owning group OrganizationValue items and sorts them by display name. |
protected java.util.List<atg.svc.repository.beans.OrganizationValue> |
getCachedAllInternalAudiences()
Caches the sorted list of all internal audiences in global scope so we don't have to build it over and over again. |
protected java.util.List<atg.svc.repository.beans.OrganizationValue> |
getCachedAllOwningGroups()
Caches the sorted list of all owning groups in global scope so we don't have to build it over and over again. |
java.util.Collection |
getCurrentUserOtherOwningGroups()
This method is implemented in Service.Agent. |
java.util.Collection |
getCurrentUserOwningGroups()
This method is implemented in Service.Agent. |
atg.svc.repository.beans.OrganizationValue |
getDefaultOwningGroup()
This method is implemented in Service.Agent. |
atg.svc.repository.beans.OrganizationValue |
getDefaultOwningGroup(atg.repository.RepositoryItem pUser)
This method is implemented in Service.Agent. |
atg.repository.RepositoryItemDescriptor |
getOrganizationItemDescriptor()
|
atg.svc.repository.beans.OrganizationValue |
getOrganizationValueById(java.lang.String pOrgValueId)
Gets an OrgnizationValue given its repository id. |
java.lang.String |
getOrganizationValueDisplayName(atg.svc.repository.beans.OrganizationValue pOrganizationValue)
Gets the display name of the OrganizationValue. |
atg.svc.repository.beans.OrganizationValue |
getOrganizationValueFromOrganization(atg.svc.repository.beans.OrganizationValueType pType,
java.lang.String pOrgId,
java.lang.String pOrgName)
Gets an organization value given the type and organization id. |
atg.repository.RepositoryItemDescriptor |
getOrganizationValueItemDescriptor()
|
java.util.List<atg.svc.repository.beans.OrganizationValue> |
getOrganizationValueListById(java.lang.String[] pOrgValueIds)
Gets a list of OrgnizationValue objects given a list of repository ids. |
java.util.Collection |
getOrganizationValuesByOrganizationId(java.lang.String pOrgValueId)
Gets collection of Organization Values by Organization id |
ProfileService |
getProfileService()
Reference for Profile Service |
atg.svc.repository.service.SegmentService |
getSegmentService()
Reference for Segment Service |
atg.repository.Repository |
getServiceRepository()
The repository that we use to listen for solution property changes. |
atg.svc.repository.service.util.SolutionSecurityUtils |
getSolutionSecurityUtils()
Reference for Solution Security Utils |
atg.userdirectory.UserDirectory |
getUserDirectory()
Reference for Directory Service |
boolean |
isAgentModule()
True if this is the Agent or admmin module, false if this is the SelfService module |
boolean |
isEnableMonitoring()
Whether to monitor for organization changes so cache can be invalidated. |
boolean |
isOrganizationExistsForOrganizationValue(atg.svc.repository.beans.OrganizationValue pOrganizationValue)
Method checks if Organization exists for provided OrganizationValue |
boolean |
isOrganizationValueVisibleForCurrentUser(atg.svc.repository.beans.OrganizationValue pOrganizationValue)
Returns true if the OrganizationValue is visible for the current user. |
void |
performAction()
Registers this class as a PostStartupAction so that the population of the organization and internal audience classes is safely deferred until after all other components start, especially the initialization of r2j which this code relies on. |
void |
propertiesChanged(atg.repository.PropertiesChangedEvent pEvent)
Remove an organization from the OrganizationNameCache when an internal organization item is modified or deleted. |
void |
setAgentModule(boolean pAgentModule)
|
protected void |
setCachedAllInternalAudiences(java.util.List<atg.svc.repository.beans.OrganizationValue> pCachedAllInternalAudiences)
|
protected void |
setCachedAllOwningGroups(java.util.List<atg.svc.repository.beans.OrganizationValue> pCachedAllOwningGroups)
|
void |
setEnableMonitoring(boolean pEnableMonitoring)
|
void |
setProfileService(ProfileService pProfileService)
|
void |
setSegmentService(atg.svc.repository.service.SegmentService pSegmentService)
|
void |
setServiceRepository(atg.repository.Repository pServiceRepository)
|
void |
setSolutionSecurityUtils(atg.svc.repository.service.util.SolutionSecurityUtils pSolutionSecurityUtils)
|
void |
setUserDirectory(atg.userdirectory.UserDirectory pUserDirectory)
|
void |
startMonitoring()
Registers this class as a PropertiesChangedListener listening for property changes to solutions |
void |
validateOrganizationValueIsUnique(atg.svc.repository.beans.OrganizationValueType pType,
java.lang.String pOrgId,
java.lang.String pOrgName)
This method is implemented in Service.admin. |
Methods inherited from class atg.svc.repository.service.KnowledgeBaseService |
---|
getKnowledgeHomesFactory, getServiceSegmentBeanHomes, getServiceSegmentRepositoryHomes, getSolutionBeanHomes, getSolutionRepositoryHomes, setKnowledgeHomesFactory |
Methods inherited from class atg.svc.repository.service.BaseService |
---|
getRepositoryService, getToday, setRepositoryService |
Methods inherited from class atg.nucleus.GenericService |
---|
addLogListener, createAdminServlet, 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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public OrganizationValueService()
Method Detail |
---|
public atg.userdirectory.UserDirectory getUserDirectory()
public void setUserDirectory(atg.userdirectory.UserDirectory pUserDirectory)
public atg.svc.repository.service.SegmentService getSegmentService()
public void setSegmentService(atg.svc.repository.service.SegmentService pSegmentService)
public ProfileService getProfileService()
public void setProfileService(ProfileService pProfileService)
public atg.svc.repository.service.util.SolutionSecurityUtils getSolutionSecurityUtils()
public void setSolutionSecurityUtils(atg.svc.repository.service.util.SolutionSecurityUtils pSolutionSecurityUtils)
public atg.repository.Repository getServiceRepository()
public void setServiceRepository(atg.repository.Repository pServiceRepository)
public boolean isAgentModule()
public void setAgentModule(boolean pAgentModule)
public boolean isEnableMonitoring()
public void setEnableMonitoring(boolean pEnableMonitoring)
protected java.util.List<atg.svc.repository.beans.OrganizationValue> getCachedAllOwningGroups()
protected void setCachedAllOwningGroups(java.util.List<atg.svc.repository.beans.OrganizationValue> pCachedAllOwningGroups)
public void clearCachedAllOwningGroups()
protected java.util.List<atg.svc.repository.beans.OrganizationValue> getCachedAllInternalAudiences()
protected void setCachedAllInternalAudiences(java.util.List<atg.svc.repository.beans.OrganizationValue> pCachedAllInternalAudiences)
public void clearCachedAllInternalAudiences()
protected atg.svc.repository.beans.OrganizationValue findOwningGroupByOrganizationId(java.lang.String pOrganizationId) throws SvcException
pOrganizationId
- repository item to process
SvcException
protected atg.svc.repository.beans.OrganizationValue findInternalAudienceByOrganizationId(java.lang.String pOrganizationId) throws SvcException
pOrganizationId
- repository item to process
SvcException
public atg.repository.RepositoryItemDescriptor getOrganizationItemDescriptor() throws atg.repository.RepositoryException
atg.repository.RepositoryException
- if Organization item isn't definedpublic atg.repository.RepositoryItemDescriptor getOrganizationValueItemDescriptor() throws atg.repository.RepositoryException
atg.repository.RepositoryException
- if OrganizationValue item isn't definedpublic atg.svc.repository.beans.OrganizationValue getOrganizationValueById(java.lang.String pOrgValueId) throws ObjectNotFoundException, SvcException
pOrgValueId
- The id of the OrganizationValue.
ObjectNotFoundException
SvcException
public java.util.Collection getOrganizationValuesByOrganizationId(java.lang.String pOrgValueId) throws javax.ejb.FinderException
pOrgValueId
- id of physical organization
javax.ejb.FinderException
public java.util.List<atg.svc.repository.beans.OrganizationValue> getOrganizationValueListById(java.lang.String[] pOrgValueIds) throws ObjectNotFoundException, SvcException
pOrgValueIds
- The array of OrganizationValue ids.
ObjectNotFoundException
- If an OrganizationValue is not found.
SvcException
public java.util.List<atg.svc.repository.beans.OrganizationValue> getAllOrganizationValues() throws SvcException
SvcException
public atg.svc.repository.beans.OrganizationValue getOrganizationValueFromOrganization(atg.svc.repository.beans.OrganizationValueType pType, java.lang.String pOrgId, java.lang.String pOrgName) throws SvcException, DuplicateRecordException
pType
- The organization value type to get or createpOrgId
- The repository id of the organization the organization value is wrapping.pOrgName
- The name of the organization.
PersistenceException
- If a PersistenceException is thrown on the save if a new OrganizationValue is created.
DuplicateRecordException
- Thrown if the organization value exists in an active project that has not been completed. See getOrganizationValueFromOrganization(OrganizationValueType, String, String)
SvcException
public atg.svc.repository.beans.OrganizationValue findOrganizationValue(atg.svc.repository.beans.OrganizationValueType pType, java.lang.String pOrgId) throws ObjectNotFoundException, SvcException
pType
- The OrganizationValueTypepOrgId
- The organization id
ObjectNotFoundException
- If the OrganizationValue was not found.
SvcException
public void validateOrganizationValueIsUnique(atg.svc.repository.beans.OrganizationValueType pType, java.lang.String pOrgId, java.lang.String pOrgName) throws SvcException
SvcException
atg.svc.repository.service.AgentOrganizationValueService.
public atg.svc.repository.beans.OrganizationValue getDefaultOwningGroup() throws SvcException, javax.ejb.FinderException
SvcException
javax.ejb.FinderException
atg.svc.repository.service.AgentOrganizationValueService.
public atg.svc.repository.beans.OrganizationValue getDefaultOwningGroup(atg.repository.RepositoryItem pUser) throws SvcException, javax.ejb.FinderException
SvcException
javax.ejb.FinderException
atg.svc.repository.service.AgentOrganizationValueService.
public java.util.Collection getCurrentUserOwningGroups() throws SvcException
SvcException
atg.svc.repository.service.AgentOrganizationValueService.
public java.util.Collection getCurrentUserOtherOwningGroups() throws SvcException
SvcException
atg.svc.repository.service.AgentOrganizationValueService.
public java.util.List<atg.svc.repository.beans.OrganizationValue> getAllOwningGroupsByDisplayName() throws SvcException
SvcException
public java.util.List<atg.svc.repository.beans.OrganizationValue> getAllOwningGroups() throws SvcException
SvcException
public java.util.List<atg.svc.repository.beans.OrganizationValue> getAllInternalAudience() throws SvcException
SvcException
public java.util.List<atg.svc.repository.beans.OrganizationValue> getAllInternalAudienceByDisplayName() throws SvcException
SvcException
public void deleteOrganizationValues(java.lang.String pOrgId) throws ObjectNotFoundException, PersistenceException
pOrgId
- The organizationId to find the OrganizationValue objects by.
ObjectNotFoundException
- If an underlying method throws ObjectNotFoundException
PersistenceException
- If the delete fails.public boolean isOrganizationValueVisibleForCurrentUser(atg.svc.repository.beans.OrganizationValue pOrganizationValue)
pOrganizationValue
- The OrganizationValue to check.
public java.lang.String getOrganizationValueDisplayName(atg.svc.repository.beans.OrganizationValue pOrganizationValue)
pOrganizationValue
- The OrganizationValue to compute the display name for.
public boolean isOrganizationExistsForOrganizationValue(atg.svc.repository.beans.OrganizationValue pOrganizationValue)
pOrganizationValue
- organization value to test
public void propertiesChanged(atg.repository.PropertiesChangedEvent pEvent)
propertiesChanged
in interface atg.repository.PropertiesChangedListener
PropertiesChangedListener.propertiesChanged(atg.repository.PropertiesChangedEvent)
public void startMonitoring()
public void performAction()
performAction
in interface atg.nucleus.PostStartupAction
public void doStartService() throws atg.nucleus.ServiceException
doStartService
in class atg.nucleus.GenericService
atg.nucleus.ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |