atg.svc.repository.service
Class UIService

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.svc.repository.service.BaseService
              atg.svc.repository.service.FrameworkBaseService
                  atg.svc.repository.service.UIService

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

Direct Known Subclasses:

SecurityUIService, SelfServiceUIService

public class UIService
extends FrameworkBaseService

Business methods for editing/reading/saving UI state.

Field Summary

static int	CELL_ITEM_TYPE
static java.lang.String	CHAT_TAB_ID
static java.lang.String	CLASS_VERSION
static java.lang.String	COMMERCE_TAB_ID
static int	CONTENT_ITEM_TYPE
static java.lang.String	CONTRIBUTE_TAB_ID
static java.lang.String	CUSTOMERS_TAB_ID
static int	FRAMEWORK_ITEM_TYPE
static int	PANEL_ITEM_TYPE
static int	PANEL_STACK_ITEM_TYPE
static int	PANEL_TARGET_ELEMENT_ITEM_TYPE
static java.lang.String	REPORT_TAB_ID
static java.lang.String	RESEARCH_TAB_ID
static java.lang.String	RESPOND_TAB_ID
static int	SKIN_ITEM_TYPE
static java.lang.String	SUPER_ADMIN_ROLE_ID
static int	TAB_ITEM_TYPE
static java.lang.String	TASKS_TAB_ID
static int	TEMPLATE_ITEM_TYPE
static java.lang.String	TICKETS_TAB_ID
static java.lang.String	USER_OPTION_HOME_TAB

Fields inherited from class atg.svc.repository.service.FrameworkBaseService

DEFAULT_REPOSITORY_HOMES_NAME, DEFAULT_VERSIONED_REPOSITORY_HOMES_NAME

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

UIService()

Method Summary

void	copyBaseAttributes(atg.svc.framework.repository.beans.FrameworkObject pSourceObject, atg.svc.framework.repository.beans.FrameworkObject pTargetObject) Copies attributes shared by all framework objects from source to target.
void	copyCellDefinitionAttributes(atg.svc.framework.repository.beans.CellDefinition pSourceObject, atg.svc.framework.repository.beans.CellDefinition pTargetObject) Copies attributes from source to target.
void	copyContentDefinitionAttributes(atg.svc.framework.repository.beans.ContentDefinition pSourceObject, atg.svc.framework.repository.beans.ContentDefinition pTargetObject) Copies attributes from source to target.
void	copyFrameworkDefinitionAttributes(atg.svc.framework.repository.beans.FrameworkDefinition pSourceObject, atg.svc.framework.repository.beans.FrameworkDefinition pTargetObject) Copies attributes from source to target.
void	copyPanelDefinitionAttributes(atg.svc.framework.repository.beans.PanelDefinition pSourceObject, atg.svc.framework.repository.beans.PanelDefinition pTargetObject) Copies attributes from source to target.
void	copyPanelStackDefinitionAttributes(atg.svc.framework.repository.beans.PanelStackDefinition pSourceObject, atg.svc.framework.repository.beans.PanelStackDefinition pTargetObject, boolean pSkipPanelStackId) Copies attributes from source to target.
void	copySegment(java.lang.String pApplicationId, java.lang.String pSourceSegmentName, java.lang.String pTargetSegmentName) Copies all of the framework objects belonging to the target segment to equivalent objects in the destination segment.
void	copySkinDefinitionAttributes(atg.svc.framework.repository.beans.SkinDefinition pSourceObject, atg.svc.framework.repository.beans.SkinDefinition pTargetObject) Copies attributes from source to target.
void	copyTabDefinitionAttributes(atg.svc.framework.repository.beans.TabDefinition pSourceObject, atg.svc.framework.repository.beans.TabDefinition pTargetObject) Copies attributes from source to target.
void	copyTemplateDefinitionAttributes(atg.svc.framework.repository.beans.TemplateDefinition pSourceObject, atg.svc.framework.repository.beans.TemplateDefinition pTargetObject) Copies attributes from source to target.
void	deleteSegment(java.lang.String pApplicationId, java.lang.String pSegmentName) Deletes all of the framework objects belonging to the specified segment.
java.lang.String	getApplicationId()
atg.svc.framework.repository.beans.CellConfig	getCellConfig(java.lang.String pCellId) Gets the cell configuration for the specified user.
java.lang.String	getChatTabId()
atg.svc.configuration.FrameworkComponents	getComponentService()
protected javax.ejb.EJBLocalObject	getConfig(int pItemType, java.lang.String pItemId) Get configuration for bean.
atg.svc.framework.repository.beans.ContentConfig	getContentConfig(java.lang.String pContentId) Gets the content configuration for the specified user.
java.lang.String	getContributeTabId()
protected java.lang.String	getCurrentUserProfileRepositoryId() Gets the repository id of the current user.
java.lang.String	getCustomersTabId()
atg.svc.framework.repository.beans.FrameworkConfig	getFrameworkConfig(java.lang.String pFrameworkId) Gets the framework configuration for the user.
java.lang.String	getFrameworkId()
boolean	getHasRight(java.lang.String pAccessRight) Determines if the current user has the specified UI right
atg.svc.configuration.ModuleDependencyManager	getModuleDependencyManager()
atg.svc.framework.repository.beans.CellInstance	getNewCellInstance(java.lang.String pCellId) Creates a cell instance bean and fills in the default values.
atg.svc.framework.repository.beans.CellInstance	getNewCellInstance(java.lang.String pCellId, atg.svc.framework.repository.beans.CellDefinition pCellDefinition)
protected javax.ejb.EJBLocalObject	getNewConfig(int pItemType, java.lang.String pUserId, java.lang.String pItemId) Creates a new configuration bean.
atg.svc.framework.repository.beans.ContentInstance	getNewContentInstance(java.lang.String pContentId) Creates a content instance bean and fills in the default values.
atg.svc.framework.repository.beans.FrameworkInstance	getNewFrameworkInstance() Creates a framework instance bean and fills in the default values.
atg.svc.framework.repository.beans.FrameworkInstance	getNewFrameworkInstance(java.lang.String pFrameworkId) Creates a framework instance bean and fills in the default values.
protected javax.ejb.EJBLocalObject	getNewInstance(int pItemType, java.lang.String pInstanceId)
atg.svc.framework.repository.beans.PanelInstance	getNewPanelInstance(java.lang.String pPanelId) Creates a panel instance bean and fills in the default values.
atg.svc.framework.repository.beans.PanelInstance	getNewPanelInstance(java.lang.String pPanelId, atg.svc.framework.repository.beans.PanelDefinition pPanelDefinition)
atg.svc.framework.repository.beans.PanelStackInstance	getNewPanelStackInstance(java.lang.String pPanelStackId) Creates a panel stack instance bean and fills in the default values.
atg.svc.framework.repository.beans.PanelStackInstance	getNewPanelStackInstance(java.lang.String pPanelStackId, atg.svc.framework.repository.beans.PanelStackDefinition pPanelStackDefinition)
atg.svc.framework.repository.beans.PanelTargetElement	getNewPanelTargetElementInstance(java.lang.String pPanelId)
atg.svc.framework.repository.beans.PanelTargetElement	getNewPanelTargetElementInstance(java.lang.String pPanelStackId, java.lang.String pPanelId)
atg.svc.framework.repository.beans.PanelTargetElement	getNewPanelTargetElementInstance(java.lang.String pPanelStackId, java.lang.String pPanelId, int pCount) Creates a panel target element bean and fills in the default values.
atg.svc.framework.repository.beans.SkinInstance	getNewSkinInstance(java.lang.String pSkinId) Creates a skin instance bean and fills in the default values.
atg.svc.framework.repository.beans.TabInstance	getNewTabInstance(java.lang.String pTabId) Creates a tab instance bean and fills in the default values.
atg.svc.framework.repository.beans.TabInstance	getNewTabInstance(java.lang.String pTabId, atg.svc.framework.repository.beans.TabDefinition pTabDefinition)
protected java.lang.String	getNewTargetElementId() Generates and returns a new target element identifier.
atg.svc.framework.repository.beans.TemplateInstance	getNewTemplateInstance(java.lang.String pTemplateId) Creates a template instance bean and fills in the default values.
atg.svc.framework.repository.beans.PanelConfig	getPanelConfig(java.lang.String pPanelId) Gets the panel configuration for the specified user.
atg.svc.framework.repository.beans.PanelStackConfig	getPanelStackConfig(java.lang.String pPanelStackId) Gets the panel stack configuration for the specified user.
java.lang.String	getReportTabId()
java.lang.String	getResearchTabId()
java.lang.String	getRespondTabId()
atg.security.GenericSecurityDomain	getSecurityDomain()
atg.nucleus.GenericService	getSecurityService()
SegmentedOptionService	getSegmentedOptionService()
atg.svc.framework.repository.beans.SkinConfig	getSkinConfig(java.lang.String pSkinId) Gets the skin configuration for the specified user.
atg.svc.framework.repository.beans.TabConfig	getTabConfig(java.lang.String pTabId) Gets the tab configuration for the specified user.
java.lang.String	getTasksTabId()
atg.svc.framework.repository.beans.TemplateConfig	getTemplateConfig(java.lang.String pTemplateId) Gets the template configuration for the specified user.
java.lang.String	getTicketsTabId()
UserOptionsService	getUserOptionsService()
java.lang.String	getUserTabId() Performs all the necessary user-related considerations and conversions to determine the initial user tab to render First, look at the user options.
boolean	getUseSegments()
java.lang.Boolean	hasRight(java.lang.String pAccessRight) Determines if the current user has the specified UI right
protected void	initCommonProperties(atg.svc.framework.repository.beans.ConfigurationObject configBean, atg.svc.framework.repository.beans.FrameworkObject frameworkBean, atg.svc.framework.repository.beans.InstanceObject instanceBean) Creates a new bean instance.
void	panelLogDebug(atg.svc.framework.repository.beans.PanelDefinition pPanelDefinition, java.lang.String pPanelId)
void	restoreCellDefaultBySegment(java.lang.String pApplicationId, java.lang.String pSegmentName, java.lang.String pCellId) Restores specified item to default values.
void	restoreContentDefaultBySegment(java.lang.String pApplicationId, java.lang.String pSegmentName, java.lang.String pContentId) Restores specified item to default values.
void	restoreFrameworkDefaultBySegment(java.lang.String pApplicationId, java.lang.String pSegmentName, java.lang.String pFrameworkId) Restores specified item to default values.
protected void	restoreItemDefault(java.lang.String pApplicationId, java.lang.String pSegmentName, int pItemType, java.lang.String pItemId) Restores default values for all framework objects in the application with default values specified
void	restorePanelDefaultBySegment(java.lang.String pApplicationId, java.lang.String pSegmentName, java.lang.String pPanelId) Restores specified item to default values.
void	restorePanelStackDefaultBySegment(java.lang.String pApplicationId, java.lang.String pSegmentName, java.lang.String pPanelStackId) Restores specified item to default values.
void	restoreSkinDefaultBySegment(java.lang.String pApplicationId, java.lang.String pSegmentName, java.lang.String pSkinId) Restores specified item to default values.
void	restoreTabDefaultBySegment(java.lang.String pApplicationId, java.lang.String pSegmentName, java.lang.String pTabId) Restores specified item to default values.
void	restoreTemplateDefaultBySegment(java.lang.String pApplicationId, java.lang.String pSegmentName, java.lang.String pTemplateId) Restores specified item to default values.
void	saveCellConfigFromInstance(atg.svc.framework.repository.beans.CellInstance pCellInstance) Saves cell configuration based on the state of a cell instance.
protected void	saveConfigFromInstance(int pItemType, javax.ejb.EJBLocalObject beanInstance) Saves bean configuration.
void	saveContentConfigFromInstance(atg.svc.framework.repository.beans.ContentInstance pContentInstance) Saves content configuration based on the state of a content instance.
void	saveFrameworkConfigFromInstance(atg.svc.framework.repository.beans.FrameworkInstance pFrameworkInstance) Saves framework configuration based on the state of a framework instance.
void	savePanelConfigFromInstance(atg.svc.framework.repository.beans.PanelInstance pPanelInstance) Saves panel configuration based on the state of a panel instance.
void	savePanelStackConfigFromInstance(atg.svc.framework.repository.beans.PanelStackInstance pPanelStackInstance) Saves panel stack configuration based on the state of a panel stack instance.
void	saveSkinConfigFromInstance(atg.svc.framework.repository.beans.SkinInstance pSkinInstance) Saves skin configuration based on the state of a skin instance.
void	saveTabConfigFromInstance(atg.svc.framework.repository.beans.TabInstance pTabInstance) Saves tab configuration based on the state of a tab instance.
void	saveTemplateConfigFromInstance(atg.svc.framework.repository.beans.TemplateInstance pTemplateInstance) Saves template configuration based on the state of a template instance.
void	setApplicationId(java.lang.String pApplicationId)
void	setComponentService(atg.svc.configuration.FrameworkComponents pComponentService)
void	setFrameworkId(java.lang.String pFrameworkId)
void	setModuleDependencyManager(atg.svc.configuration.ModuleDependencyManager pModuleDependencyManager)
void	setSecurityDomain(atg.security.GenericSecurityDomain pSecurityDomain)
void	setSecurityService(atg.nucleus.GenericService pSecurityService)
void	setSegmentedOptionService(SegmentedOptionService pSegmentedOptionService)
void	setUserOptionsService(UserOptionsService pUserOptionsService)
void	setUseSegments(boolean pUseSegments)
void	tabLogDebug(atg.svc.framework.repository.beans.TabDefinition pTabDefinition, java.lang.String pTabId)

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

getServiceFrameworkBeanHomes, getServiceFrameworkBeanHomesName, getServiceFrameworkRepositoryHomes, getServiceFrameworkRepositoryHomesName, setServiceFrameworkBeanHomesName, setServiceFrameworkRepositoryHomesName

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

See Also:

Constant Field Values

SUPER_ADMIN_ROLE_ID

public static final java.lang.String SUPER_ADMIN_ROLE_ID

See Also:

Constant Field Values

USER_OPTION_HOME_TAB

public static final java.lang.String USER_OPTION_HOME_TAB

See Also:

Constant Field Values

CONTRIBUTE_TAB_ID

public static final java.lang.String CONTRIBUTE_TAB_ID

See Also:

Constant Field Values

CUSTOMERS_TAB_ID

public static final java.lang.String CUSTOMERS_TAB_ID

See Also:

Constant Field Values

REPORT_TAB_ID

public static final java.lang.String REPORT_TAB_ID

See Also:

Constant Field Values

RESEARCH_TAB_ID

public static final java.lang.String RESEARCH_TAB_ID

See Also:

Constant Field Values

RESPOND_TAB_ID

public static final java.lang.String RESPOND_TAB_ID

See Also:

Constant Field Values

TASKS_TAB_ID

public static final java.lang.String TASKS_TAB_ID

See Also:

Constant Field Values

TICKETS_TAB_ID

public static final java.lang.String TICKETS_TAB_ID

See Also:

Constant Field Values

CHAT_TAB_ID

public static final java.lang.String CHAT_TAB_ID

See Also:

Constant Field Values

COMMERCE_TAB_ID

public static final java.lang.String COMMERCE_TAB_ID

See Also:

Constant Field Values

CELL_ITEM_TYPE

public static final int CELL_ITEM_TYPE

See Also:

Constant Field Values

CONTENT_ITEM_TYPE

public static final int CONTENT_ITEM_TYPE

See Also:

Constant Field Values

FRAMEWORK_ITEM_TYPE

public static final int FRAMEWORK_ITEM_TYPE

See Also:

Constant Field Values

PANEL_ITEM_TYPE

public static final int PANEL_ITEM_TYPE

See Also:

Constant Field Values

PANEL_STACK_ITEM_TYPE

public static final int PANEL_STACK_ITEM_TYPE

See Also:

Constant Field Values

PANEL_TARGET_ELEMENT_ITEM_TYPE

public static final int PANEL_TARGET_ELEMENT_ITEM_TYPE

See Also:

Constant Field Values

SKIN_ITEM_TYPE

public static final int SKIN_ITEM_TYPE

See Also:

Constant Field Values

TAB_ITEM_TYPE

public static final int TAB_ITEM_TYPE

See Also:

Constant Field Values

TEMPLATE_ITEM_TYPE

public static final int TEMPLATE_ITEM_TYPE

See Also:

Constant Field Values

Constructor Detail

UIService

public UIService()

Method Detail

getContributeTabId

public java.lang.String getContributeTabId()

Returns:

Contribute tab ID

getCustomersTabId

public java.lang.String getCustomersTabId()

Returns:

Customers tab ID

getReportTabId

public java.lang.String getReportTabId()

Returns:

Report tab ID

getResearchTabId

public java.lang.String getResearchTabId()

Returns:

Research tab ID

getRespondTabId

public java.lang.String getRespondTabId()

Returns:

Respond tab ID

getTasksTabId

public java.lang.String getTasksTabId()

Returns:

Tasks tab ID

getTicketsTabId

public java.lang.String getTicketsTabId()

Returns:

Tickets tab ID

getChatTabId

public java.lang.String getChatTabId()

Returns:

Chat tab ID

getApplicationId

public java.lang.String getApplicationId()

Returns:

The application ID for the framework.

setApplicationId

public void setApplicationId(java.lang.String pApplicationId)

Parameters:

pApplicationId - The application ID for the framework.

getFrameworkId

public java.lang.String getFrameworkId()

Returns:

The default framework identifier.

setFrameworkId

public void setFrameworkId(java.lang.String pFrameworkId)

Parameters:

pFrameworkId - The default framework identifier.

getUseSegments

public boolean getUseSegments()

Returns:

Flag indicating whether framework object configurations are saved by segment intead of user.

setUseSegments

public void setUseSegments(boolean pUseSegments)

Parameters:

pUseSegments - Flag indicating whether framework object configurations are saved by segment intead of user.

getComponentService

public atg.svc.configuration.FrameworkComponents getComponentService()

setComponentService

public void setComponentService(atg.svc.configuration.FrameworkComponents pComponentService)

getModuleDependencyManager

public atg.svc.configuration.ModuleDependencyManager getModuleDependencyManager()

setModuleDependencyManager

public void setModuleDependencyManager(atg.svc.configuration.ModuleDependencyManager pModuleDependencyManager)

getSecurityDomain

public atg.security.GenericSecurityDomain getSecurityDomain()

setSecurityDomain

public void setSecurityDomain(atg.security.GenericSecurityDomain pSecurityDomain)

getSecurityService

public atg.nucleus.GenericService getSecurityService()

setSecurityService

public void setSecurityService(atg.nucleus.GenericService pSecurityService)

getSegmentedOptionService

public SegmentedOptionService getSegmentedOptionService()

setSegmentedOptionService

public void setSegmentedOptionService(SegmentedOptionService pSegmentedOptionService)

getUserOptionsService

public UserOptionsService getUserOptionsService()

setUserOptionsService

public void setUserOptionsService(UserOptionsService pUserOptionsService)

getHasRight

public boolean getHasRight(java.lang.String pAccessRight)

Determines if the current user has the specified UI right

Parameters:

pAccessRight - the name of a UI right

Returns:

Whether the current user has the specified UI right

hasRight

public java.lang.Boolean hasRight(java.lang.String pAccessRight)

Determines if the current user has the specified UI right

Parameters:

pAccessRight - the name of a UI right

Returns:

Whether the current user has the specified UI right

copySegment

public void copySegment(java.lang.String pApplicationId,
                        java.lang.String pSourceSegmentName,
                        java.lang.String pTargetSegmentName)
                 throws ObjectNotFoundException,
                        PersistenceException

Copies all of the framework objects belonging to the target segment to equivalent objects in the destination segment.

Parameters:

pApplicationId - the app identifier

pSourceSegmentName - the name of the segment to copy from

pTargetSegmentName - the name of the segment to copy to

Throws:

ObjectNotFoundException

PersistenceException

copyBaseAttributes

public void copyBaseAttributes(atg.svc.framework.repository.beans.FrameworkObject pSourceObject,
                               atg.svc.framework.repository.beans.FrameworkObject pTargetObject)

Copies attributes shared by all framework objects from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

copyCellDefinitionAttributes

public void copyCellDefinitionAttributes(atg.svc.framework.repository.beans.CellDefinition pSourceObject,
                                         atg.svc.framework.repository.beans.CellDefinition pTargetObject)

Copies attributes from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

copyContentDefinitionAttributes

public void copyContentDefinitionAttributes(atg.svc.framework.repository.beans.ContentDefinition pSourceObject,
                                            atg.svc.framework.repository.beans.ContentDefinition pTargetObject)

Copies attributes from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

copyFrameworkDefinitionAttributes

public void copyFrameworkDefinitionAttributes(atg.svc.framework.repository.beans.FrameworkDefinition pSourceObject,
                                              atg.svc.framework.repository.beans.FrameworkDefinition pTargetObject)

Copies attributes from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

copyPanelDefinitionAttributes

public void copyPanelDefinitionAttributes(atg.svc.framework.repository.beans.PanelDefinition pSourceObject,
                                          atg.svc.framework.repository.beans.PanelDefinition pTargetObject)

Copies attributes from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

copyPanelStackDefinitionAttributes

public void copyPanelStackDefinitionAttributes(atg.svc.framework.repository.beans.PanelStackDefinition pSourceObject,
                                               atg.svc.framework.repository.beans.PanelStackDefinition pTargetObject,
                                               boolean pSkipPanelStackId)

Copies attributes from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

pSkipPanelStackId - is to skip PanelStackId

copySkinDefinitionAttributes

public void copySkinDefinitionAttributes(atg.svc.framework.repository.beans.SkinDefinition pSourceObject,
                                         atg.svc.framework.repository.beans.SkinDefinition pTargetObject)

Copies attributes from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

copyTabDefinitionAttributes

public void copyTabDefinitionAttributes(atg.svc.framework.repository.beans.TabDefinition pSourceObject,
                                        atg.svc.framework.repository.beans.TabDefinition pTargetObject)

Copies attributes from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

copyTemplateDefinitionAttributes

public void copyTemplateDefinitionAttributes(atg.svc.framework.repository.beans.TemplateDefinition pSourceObject,
                                             atg.svc.framework.repository.beans.TemplateDefinition pTargetObject)

Copies attributes from source to target.

Parameters:

pSourceObject - Object from which to copy attributes

pTargetObject - Object to which to copy attributes

deleteSegment

public void deleteSegment(java.lang.String pApplicationId,
                          java.lang.String pSegmentName)
                   throws ObjectNotFoundException,
                          PersistenceException

Deletes all of the framework objects belonging to the specified segment.

Parameters:

pApplicationId - the app identifier

pSegmentName - the name of the segment to delete

Throws:

ObjectNotFoundException

PersistenceException

restoreFrameworkDefaultBySegment

public void restoreFrameworkDefaultBySegment(java.lang.String pApplicationId,
                                             java.lang.String pSegmentName,
                                             java.lang.String pFrameworkId)
                                      throws ObjectNotFoundException,
                                             PersistenceException

Restores specified item to default values.

Parameters:

pApplicationId - Application identifier

pFrameworkId - Item identifier

Throws:

ObjectNotFoundException

PersistenceException

getFrameworkConfig

public atg.svc.framework.repository.beans.FrameworkConfig getFrameworkConfig(java.lang.String pFrameworkId)
                                                                      throws ObjectNotFoundException

Gets the framework configuration for the user.

Parameters:

pFrameworkId -

Returns:

The specified user framework configuration.

Throws:

ObjectNotFoundException

getNewFrameworkInstance

public atg.svc.framework.repository.beans.FrameworkInstance getNewFrameworkInstance()
                                                                             throws ObjectNotFoundException

Creates a framework instance bean and fills in the default values.

Returns:

A FrameworkInstance beanImpl.

Throws:

ObjectNotFoundException

getNewFrameworkInstance

public atg.svc.framework.repository.beans.FrameworkInstance getNewFrameworkInstance(java.lang.String pFrameworkId)
                                                                             throws ObjectNotFoundException

Creates a framework instance bean and fills in the default values.

Parameters:

pFrameworkId -

Returns:

A FrameworkInstance beanImpl.

Throws:

ObjectNotFoundException

saveFrameworkConfigFromInstance

public void saveFrameworkConfigFromInstance(atg.svc.framework.repository.beans.FrameworkInstance pFrameworkInstance)
                                     throws ObjectNotFoundException,
                                            PersistenceException

Saves framework configuration based on the state of a framework instance.

Parameters:

pFrameworkInstance - The framework instance bean to save.

Throws:

ObjectNotFoundException

PersistenceException

restoreContentDefaultBySegment

public void restoreContentDefaultBySegment(java.lang.String pApplicationId,
                                           java.lang.String pSegmentName,
                                           java.lang.String pContentId)
                                    throws ObjectNotFoundException,
                                           PersistenceException

Restores specified item to default values.

Parameters:

pApplicationId - Application identifier

pContentId - Item identifier

Throws:

ObjectNotFoundException

PersistenceException

getContentConfig

public atg.svc.framework.repository.beans.ContentConfig getContentConfig(java.lang.String pContentId)
                                                                  throws ObjectNotFoundException

Gets the content configuration for the specified user.

Parameters:

pContentId - A valid content identifier.

Returns:

The specified content configuration for the user.

Throws:

ObjectNotFoundException

getNewContentInstance

public atg.svc.framework.repository.beans.ContentInstance getNewContentInstance(java.lang.String pContentId)
                                                                         throws ObjectNotFoundException

Creates a content instance bean and fills in the default values.

Parameters:

pContentId - The content id.

Returns:

A ContentInstance beanImpl.

Throws:

ObjectNotFoundException

saveContentConfigFromInstance

public void saveContentConfigFromInstance(atg.svc.framework.repository.beans.ContentInstance pContentInstance)
                                   throws ObjectNotFoundException,
                                          PersistenceException

Saves content configuration based on the state of a content instance.

Parameters:

pContentInstance - The content instance bean to save.

Throws:

ObjectNotFoundException

PersistenceException

restoreSkinDefaultBySegment

public void restoreSkinDefaultBySegment(java.lang.String pApplicationId,
                                        java.lang.String pSegmentName,
                                        java.lang.String pSkinId)
                                 throws ObjectNotFoundException,
                                        PersistenceException

Restores specified item to default values.

Parameters:

pApplicationId - Application identifier

pSkinId - Item identifier

Throws:

ObjectNotFoundException

PersistenceException

getSkinConfig

public atg.svc.framework.repository.beans.SkinConfig getSkinConfig(java.lang.String pSkinId)
                                                            throws ObjectNotFoundException

Gets the skin configuration for the specified user.

Parameters:

pSkinId - A valid skin identifier.

Returns:

The specified skin configuration for the user.

Throws:

ObjectNotFoundException

getNewSkinInstance

public atg.svc.framework.repository.beans.SkinInstance getNewSkinInstance(java.lang.String pSkinId)
                                                                   throws ObjectNotFoundException

Creates a skin instance bean and fills in the default values.

Parameters:

pSkinId - The skin id.

Returns:

A SkinInstance beanImpl.

Throws:

ObjectNotFoundException

saveSkinConfigFromInstance

public void saveSkinConfigFromInstance(atg.svc.framework.repository.beans.SkinInstance pSkinInstance)
                                throws ObjectNotFoundException,
                                       PersistenceException

Saves skin configuration based on the state of a skin instance.

Parameters:

pSkinInstance - The skin instance bean to save.

Throws:

ObjectNotFoundException

PersistenceException

restoreTabDefaultBySegment

public void restoreTabDefaultBySegment(java.lang.String pApplicationId,
                                       java.lang.String pSegmentName,
                                       java.lang.String pTabId)
                                throws ObjectNotFoundException,
                                       PersistenceException

Restores specified item to default values.

Parameters:

pApplicationId - Application identifier

pTabId - Item identifier

Throws:

ObjectNotFoundException

PersistenceException

getTabConfig

public atg.svc.framework.repository.beans.TabConfig getTabConfig(java.lang.String pTabId)
                                                          throws ObjectNotFoundException

Gets the tab configuration for the specified user.

Parameters:

pTabId - A valid tab identifier.

Returns:

The specified tab configuration for the user.

Throws:

ObjectNotFoundException

getNewTabInstance

public atg.svc.framework.repository.beans.TabInstance getNewTabInstance(java.lang.String pTabId)
                                                                 throws ObjectNotFoundException

Creates a tab instance bean and fills in the default values.

Parameters:

pTabId - The tab id.

Returns:

A TabInstance beanImpl.

Throws:

ObjectNotFoundException

getNewTabInstance

public atg.svc.framework.repository.beans.TabInstance getNewTabInstance(java.lang.String pTabId,
                                                                        atg.svc.framework.repository.beans.TabDefinition pTabDefinition)
                                                                 throws ObjectNotFoundException

Throws:

ObjectNotFoundException

tabLogDebug

public void tabLogDebug(atg.svc.framework.repository.beans.TabDefinition pTabDefinition,
                        java.lang.String pTabId)

saveTabConfigFromInstance

public void saveTabConfigFromInstance(atg.svc.framework.repository.beans.TabInstance pTabInstance)
                               throws ObjectNotFoundException,
                                      PersistenceException

Saves tab configuration based on the state of a tab instance.

Parameters:

pTabInstance - The tab instance bean to save.

Throws:

ObjectNotFoundException

PersistenceException

restoreCellDefaultBySegment

public void restoreCellDefaultBySegment(java.lang.String pApplicationId,
                                        java.lang.String pSegmentName,
                                        java.lang.String pCellId)
                                 throws ObjectNotFoundException,
                                        PersistenceException

Restores specified item to default values.

Parameters:

pApplicationId - Application identifier

pCellId - Item identifier

Throws:

ObjectNotFoundException

PersistenceException

getCellConfig

public atg.svc.framework.repository.beans.CellConfig getCellConfig(java.lang.String pCellId)
                                                            throws ObjectNotFoundException

Gets the cell configuration for the specified user.

Parameters:

pCellId - A valid cell identifier.

Returns:

The specified cell configuration for the user.

Throws:

ObjectNotFoundException

getNewCellInstance

public atg.svc.framework.repository.beans.CellInstance getNewCellInstance(java.lang.String pCellId)
                                                                   throws ObjectNotFoundException

Creates a cell instance bean and fills in the default values.

Parameters:

pCellId - The cell id.

Returns:

A CellInstance beanImpl.

Throws:

ObjectNotFoundException

getNewCellInstance

public atg.svc.framework.repository.beans.CellInstance getNewCellInstance(java.lang.String pCellId,
                                                                          atg.svc.framework.repository.beans.CellDefinition pCellDefinition)
                                                                   throws ObjectNotFoundException

Throws:

ObjectNotFoundException

saveCellConfigFromInstance

public void saveCellConfigFromInstance(atg.svc.framework.repository.beans.CellInstance pCellInstance)
                                throws ObjectNotFoundException,
                                       PersistenceException

Saves cell configuration based on the state of a cell instance.

Parameters:

pCellInstance - The cell instance bean to save.

Throws:

ObjectNotFoundException

PersistenceException

restorePanelStackDefaultBySegment

public void restorePanelStackDefaultBySegment(java.lang.String pApplicationId,
                                              java.lang.String pSegmentName,
                                              java.lang.String pPanelStackId)
                                       throws ObjectNotFoundException,
                                              PersistenceException

Restores specified item to default values.

Parameters:

pApplicationId - Application identifier

pPanelStackId - Item identifier

Throws:

ObjectNotFoundException

PersistenceException

getPanelStackConfig

public atg.svc.framework.repository.beans.PanelStackConfig getPanelStackConfig(java.lang.String pPanelStackId)
                                                                        throws ObjectNotFoundException

Gets the panel stack configuration for the specified user.

Parameters:

pPanelStackId - A valid panel stack identifier.

Returns:

The specified panel stack configuration for the user.

Throws:

ObjectNotFoundException

getNewPanelStackInstance

public atg.svc.framework.repository.beans.PanelStackInstance getNewPanelStackInstance(java.lang.String pPanelStackId)
                                                                               throws ObjectNotFoundException

Creates a panel stack instance bean and fills in the default values.

Parameters:

pPanelStackId - The panel stack id.

Returns:

A PanelStackInstance beanImpl.

Throws:

ObjectNotFoundException

getNewPanelStackInstance

public atg.svc.framework.repository.beans.PanelStackInstance getNewPanelStackInstance(java.lang.String pPanelStackId,
                                                                                      atg.svc.framework.repository.beans.PanelStackDefinition pPanelStackDefinition)
                                                                               throws ObjectNotFoundException

Throws:

ObjectNotFoundException

savePanelStackConfigFromInstance

public void savePanelStackConfigFromInstance(atg.svc.framework.repository.beans.PanelStackInstance pPanelStackInstance)
                                      throws ObjectNotFoundException,
                                             PersistenceException

Saves panel stack configuration based on the state of a panel stack instance.

Parameters:

pPanelStackInstance - The panel stack instance bean to save.

Throws:

ObjectNotFoundException

PersistenceException

restorePanelDefaultBySegment

public void restorePanelDefaultBySegment(java.lang.String pApplicationId,
                                         java.lang.String pSegmentName,
                                         java.lang.String pPanelId)
                                  throws ObjectNotFoundException,
                                         PersistenceException

Restores specified item to default values.

Parameters:

pApplicationId - Application identifier

pPanelId - Item identifier

Throws:

ObjectNotFoundException

PersistenceException

getPanelConfig

public atg.svc.framework.repository.beans.PanelConfig getPanelConfig(java.lang.String pPanelId)
                                                              throws ObjectNotFoundException

Gets the panel configuration for the specified user.

Parameters:

pPanelId - A valid panel identifier.

Returns:

The specified panel configuration for the user.

Throws:

ObjectNotFoundException

getNewPanelInstance

public atg.svc.framework.repository.beans.PanelInstance getNewPanelInstance(java.lang.String pPanelId)
                                                                     throws ObjectNotFoundException

Creates a panel instance bean and fills in the default values.

Parameters:

pPanelId - The panel id.

Returns:

A PanelInstance beanImpl.

Throws:

ObjectNotFoundException

getNewPanelInstance

public atg.svc.framework.repository.beans.PanelInstance getNewPanelInstance(java.lang.String pPanelId,
                                                                            atg.svc.framework.repository.beans.PanelDefinition pPanelDefinition)
                                                                     throws ObjectNotFoundException

Throws:

ObjectNotFoundException

savePanelConfigFromInstance

public void savePanelConfigFromInstance(atg.svc.framework.repository.beans.PanelInstance pPanelInstance)
                                 throws ObjectNotFoundException,
                                        PersistenceException

Saves panel configuration based on the state of a panel instance.

Parameters:

pPanelInstance - The panel instance bean to save.

Throws:

ObjectNotFoundException

PersistenceException

panelLogDebug

public void panelLogDebug(atg.svc.framework.repository.beans.PanelDefinition pPanelDefinition,
                          java.lang.String pPanelId)

getNewPanelTargetElementInstance

public atg.svc.framework.repository.beans.PanelTargetElement getNewPanelTargetElementInstance(java.lang.String pPanelStackId,
                                                                                              java.lang.String pPanelId,
                                                                                              int pCount)
                                                                                       throws ObjectNotFoundException

Creates a panel target element bean and fills in the default values.

Returns:

A PanelTargetElement beanImpl.

Throws:

ObjectNotFoundException

getNewPanelTargetElementInstance

public atg.svc.framework.repository.beans.PanelTargetElement getNewPanelTargetElementInstance(java.lang.String pPanelId)
                                                                                       throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getNewPanelTargetElementInstance

public atg.svc.framework.repository.beans.PanelTargetElement getNewPanelTargetElementInstance(java.lang.String pPanelStackId,
                                                                                              java.lang.String pPanelId)
                                                                                       throws ObjectNotFoundException

Throws:

ObjectNotFoundException

restoreTemplateDefaultBySegment

public void restoreTemplateDefaultBySegment(java.lang.String pApplicationId,
                                            java.lang.String pSegmentName,
                                            java.lang.String pTemplateId)
                                     throws ObjectNotFoundException,
                                            PersistenceException

Restores specified item to default values.

Parameters:

pApplicationId - Application identifier

pTemplateId - Item identifier

Throws:

ObjectNotFoundException

PersistenceException

getTemplateConfig

public atg.svc.framework.repository.beans.TemplateConfig getTemplateConfig(java.lang.String pTemplateId)
                                                                    throws ObjectNotFoundException

Gets the template configuration for the specified user.

Parameters:

pTemplateId - A valid template identifier.

Returns:

The specified template configuration for the user.

Throws:

ObjectNotFoundException

getNewTemplateInstance

public atg.svc.framework.repository.beans.TemplateInstance getNewTemplateInstance(java.lang.String pTemplateId)
                                                                           throws ObjectNotFoundException

Creates a template instance bean and fills in the default values.

Parameters:

pTemplateId - The template id.

Returns:

A TemplateInstance beanImpl.

Throws:

ObjectNotFoundException

saveTemplateConfigFromInstance

public void saveTemplateConfigFromInstance(atg.svc.framework.repository.beans.TemplateInstance pTemplateInstance)
                                    throws ObjectNotFoundException,
                                           PersistenceException

Saves template configuration based on the state of a template instance.

Parameters:

pTemplateInstance - The template instance bean to save.

Throws:

ObjectNotFoundException

PersistenceException

getConfig

protected javax.ejb.EJBLocalObject getConfig(int pItemType,
                                             java.lang.String pItemId)
                                      throws ObjectNotFoundException

Get configuration for bean.

Parameters:

pItemType - Item type to put in map

Returns:

Bean configuration.

Throws:

ObjectNotFoundException

getNewConfig

protected javax.ejb.EJBLocalObject getNewConfig(int pItemType,
                                                java.lang.String pUserId,
                                                java.lang.String pItemId)
                                         throws ObjectNotFoundException

Creates a new configuration bean.

Parameters:

pItemType - Item type to put in map

Returns:

A new configuration bean.

Throws:

ObjectNotFoundException

initCommonProperties

protected void initCommonProperties(atg.svc.framework.repository.beans.ConfigurationObject configBean,
                                    atg.svc.framework.repository.beans.FrameworkObject frameworkBean,
                                    atg.svc.framework.repository.beans.InstanceObject instanceBean)

Creates a new bean instance.

Parameters:

pItemType - Item type to put in map

getNewInstance

protected javax.ejb.EJBLocalObject getNewInstance(int pItemType,
                                                  java.lang.String pInstanceId)
                                           throws ObjectNotFoundException

Throws:

ObjectNotFoundException

saveConfigFromInstance

protected void saveConfigFromInstance(int pItemType,
                                      javax.ejb.EJBLocalObject beanInstance)
                               throws ObjectNotFoundException,
                                      PersistenceException

Saves bean configuration.

Parameters:

pItemType - Item type to put in map

Throws:

ObjectNotFoundException

PersistenceException

restoreItemDefault

protected void restoreItemDefault(java.lang.String pApplicationId,
                                  java.lang.String pSegmentName,
                                  int pItemType,
                                  java.lang.String pItemId)
                           throws ObjectNotFoundException,
                                  PersistenceException

Restores default values for all framework objects in the application with default values specified

Parameters:

pApplicationId - the app identifier

pSegmentName - the segment identifier

pItemType - the item type

pItemId - the item identifier for which to restore defaults

Throws:

ObjectNotFoundException

PersistenceException

getUserTabId

public java.lang.String getUserTabId()
                              throws ObjectNotFoundException

Performs all the necessary user-related considerations and conversions to determine the initial user tab to render First, look at the user options. User option integer is converted to the required string for the UI. Then, consider security to return the first tab that user is authorized to access

Returns:

the tab ID as a string

Throws:

ObjectNotFoundException

getNewTargetElementId

protected java.lang.String getNewTargetElementId()

Generates and returns a new target element identifier.

Returns:

The new target element ID.

getCurrentUserProfileRepositoryId

protected java.lang.String getCurrentUserProfileRepositoryId()

Gets the repository id of the current user.

Returns:

The repository id of the current user.