atg.svc.repository.beans
Interface PanelStackDefinition

All Superinterfaces:

javax.ejb.EJBLocalObject, FrameworkObject

All Known Implementing Classes:

_PanelStackDefinition_BeanImpl, _PanelStackDefinition_Impl, _PanelStackDefinition_ReposImpl

public interface PanelStackDefinition
extends javax.ejb.EJBLocalObject, FrameworkObject

Class PanelStackDefinition

• Home: PanelStackDefinitionHome
• Flags:
• Attributes:

  Attribute Name	Attribute Value
  atg.repository.query.SupportedQueries	and, comparison, constant, inFolders, includesAny, includes, includesItem, isNull, matchId, not, or, patternMatch, property, propertyOf, unconstrained, patternMatch, textSearch

Property Summaries

Property Name	Property Type	Property Description	Flags
appId	String		R, W, Cch, Qry, Req
contentIds	Map		R, W, Cch, CoM, Mv, Qry
default	FrameworkObject		R, W, Cch, Qry
descriptionKey	String		R, W, Cch, Qry
enabledYn	boolean		R, W, Cch, Qry, Req
errorPanelId	String		R, W, Cch, Qry
header	String		R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
imageUrl	String		R, W, Cch, Qry
nameKey	String		R, W, Cch, Qry
objectType	FrameworkObjectObjectType		R, W, Cch, Qry, Req
optionNames	Map		R, W, Cch, CoM, Mv, Qry
panelBackgroundTabStyle	String		R, W, Cch, Qry
panelIds	List		R, W, Cch, CoM, Mv, Qry
panelSelectedTabStyle	String		R, W, Cch, Qry
panelStackId	String		R, W, Cch, Qry, Req
panelTitlebarTabbedStyle	String		R, W, Cch, Qry
panelTitlebarUntabbedStyle	String		R, W, Cch, Qry
resourceBundle	String		R, W, Cch, Qry
segmentName	String		R, W, Cch, Qry
tabAffinityYn	boolean		R, W, Cch, Qry, Req
templateIds	Map		R, W, Cch, CoM, Mv, Qry
titleKey	String		R, W, Cch, Qry, Req

Flags Key:R=readable, W=writable, CsD=cascadeDelete, CsI=cascadeInsert, CsU=cascadeUpdate, Cch=cacheable, CoM=collectionOrMap, Drv=derived, Id=idProperty, Mv=multivalued, Qry=queryable, Req=required, Exp=expert, Hdn=hidden, Prf=preferred

Property Details

Property appId: String

• Getter: FrameworkObject.getAppId()
• Setter: FrameworkObject.setAppId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: appid

Property contentIds: Map

• Getter: FrameworkObject.getContentIds()
• Setter: FrameworkObject.setContentIds(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: contentids

Property default: FrameworkObject

• Getter: FrameworkObject.getDefault()
• Setter: FrameworkObject.setDefault(atg.svc.repository.beans.FrameworkObject)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: default

Property descriptionKey: String

• Getter: FrameworkObject.getDescriptionKey()
• Setter: FrameworkObject.setDescriptionKey(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: descriptionkey

Property enabledYn: boolean

• Getter: FrameworkObject.isEnabledYn()
• Setter: FrameworkObject.setEnabledYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: true
• Type Name: boolean
• Sort String: enabledyn

Property errorPanelId: String

• Getter: getErrorPanelId()
• Setter: setErrorPanelId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: errorpanelid

Property header: String

• Getter: getHeader()
• Setter: setHeader(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: header

Property id: String

• Getter: getId()
• Setter: setId(java.lang.String)
• Flags: readable, writable, cacheable, idProperty, queryable, required
• Type Name: string
• Sort String: id

Property imageUrl: String

• Getter: FrameworkObject.getImageUrl()
• Setter: FrameworkObject.setImageUrl(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: imageurl

Property nameKey: String

• Getter: FrameworkObject.getNameKey()
• Setter: FrameworkObject.setNameKey(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: namekey

Property objectType: FrameworkObjectObjectType

• Getter: FrameworkObject.getObjectType()
• Setter: FrameworkObject.setObjectType(atg.svc.repository.beans.FrameworkObjectObjectType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: objecttype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property optionNames: Map

• Getter: FrameworkObject.getOptionNames()
• Setter: FrameworkObject.setOptionNames(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: optionnames

Property panelBackgroundTabStyle: String

• Getter: getPanelBackgroundTabStyle()
• Setter: setPanelBackgroundTabStyle(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: panelbackgroundtabstyle

Property panelIds: List

• Getter: getPanelIds()
• Setter: setPanelIds(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: panelids

Property panelSelectedTabStyle: String

• Getter: getPanelSelectedTabStyle()
• Setter: setPanelSelectedTabStyle(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: panelselectedtabstyle

Property panelStackId: String

• Getter: getPanelStackId()
• Setter: setPanelStackId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: panelstackid

Property panelTitlebarTabbedStyle: String

• Getter: getPanelTitlebarTabbedStyle()
• Setter: setPanelTitlebarTabbedStyle(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: paneltitlebartabbedstyle

Property panelTitlebarUntabbedStyle: String

• Getter: getPanelTitlebarUntabbedStyle()
• Setter: setPanelTitlebarUntabbedStyle(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: paneltitlebaruntabbedstyle

Property resourceBundle: String

• Getter: FrameworkObject.getResourceBundle()
• Setter: FrameworkObject.setResourceBundle(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: resourcebundle

Property segmentName: String

• Getter: FrameworkObject.getSegmentName()
• Setter: FrameworkObject.setSegmentName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: segmentname

Property tabAffinityYn: boolean

• Getter: isTabAffinityYn()
• Setter: setTabAffinityYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: true
• Type Name: boolean
• Sort String: tabaffinityyn

Property templateIds: Map

• Getter: FrameworkObject.getTemplateIds()
• Setter: FrameworkObject.setTemplateIds(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: templateids

Property titleKey: String

• Getter: getTitleKey()
• Setter: setTitleKey(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: titlekey

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(PanelStackDefinition destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getErrorPanelId() Getter for property errorPanelId
java.lang.String	getHeader() Getter for property header
java.lang.String	getId() Getter for property id
java.lang.String	getPanelBackgroundTabStyle() Getter for property panelBackgroundTabStyle
java.util.List	getPanelIds() Getter for property panelIds
java.util.List	getPanels()
java.lang.String	getPanelSelectedTabStyle() Getter for property panelSelectedTabStyle
java.lang.String	getPanelStackId() Getter for property panelStackId
java.lang.String	getPanelTitlebarTabbedStyle() Getter for property panelTitlebarTabbedStyle
java.lang.String	getPanelTitlebarUntabbedStyle() Getter for property panelTitlebarUntabbedStyle
java.lang.String	getTitleKey() Getter for property titleKey
boolean	isRemoved() Returns true if the underlying object has been removed.
boolean	isTabAffinityYn() Getter for property tabAffinityYn
void	prepareInstanceForWrite() This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write.
void	setErrorPanelId(java.lang.String value) Setter for property errorPanelId .
void	setHeader(java.lang.String value) Setter for property header .
void	setId(java.lang.String value) Setter for property id .
void	setPanelBackgroundTabStyle(java.lang.String value) Setter for property panelBackgroundTabStyle .
void	setPanelIds(java.util.List value) Setter for property panelIds .
void	setPanelSelectedTabStyle(java.lang.String value) Setter for property panelSelectedTabStyle .
void	setPanelStackId(java.lang.String value) Setter for property panelStackId .
void	setPanelTitlebarTabbedStyle(java.lang.String value) Setter for property panelTitlebarTabbedStyle .
void	setPanelTitlebarUntabbedStyle(java.lang.String value) Setter for property panelTitlebarUntabbedStyle .
void	setTabAffinityYn(boolean value) Setter for property tabAffinityYn .
void	setTitleKey(java.lang.String value) Setter for property titleKey .
void	writeInstance() This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries.

Methods inherited from interface atg.svc.repository.beans.FrameworkObject

copyTo, getAppId, getContentIds, getContents, getDefault, getDescriptionKey, getImageUrl, getNameKey, getObjectType, getOptionNames, getOptions, getResourceBundle, getSegmentName, getTemplateIds, getTemplates, isEnabledYn, setAppId, setContentIds, setDefault, setDescriptionKey, setEnabledYn, setImageUrl, setNameKey, setObjectType, setOptionNames, setResourceBundle, setSegmentName, setTemplateIds

Method Detail

getErrorPanelId

java.lang.String getErrorPanelId()
                                 throws javax.ejb.EJBException

Getter for property errorPanelId

Returns:

String

Throws:

javax.ejb.EJBException

setErrorPanelId

void setErrorPanelId(java.lang.String value)
                     throws javax.ejb.EJBException

Setter for property errorPanelId . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getHeader

java.lang.String getHeader()
                           throws javax.ejb.EJBException

Getter for property header

Returns:

String

Throws:

javax.ejb.EJBException

setHeader

void setHeader(java.lang.String value)
               throws javax.ejb.EJBException

Setter for property header . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getId

java.lang.String getId()
                       throws javax.ejb.EJBException

Getter for property id

Specified by:

getId in interface FrameworkObject

Returns:

String

Throws:

javax.ejb.EJBException

setId

void setId(java.lang.String value)
           throws javax.ejb.EJBException

Setter for property id . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Specified by:

setId in interface FrameworkObject

Parameters:

value - String

Throws:

javax.ejb.EJBException

getPanelBackgroundTabStyle

java.lang.String getPanelBackgroundTabStyle()
                                            throws javax.ejb.EJBException

Getter for property panelBackgroundTabStyle

Returns:

String

Throws:

javax.ejb.EJBException

setPanelBackgroundTabStyle

void setPanelBackgroundTabStyle(java.lang.String value)
                                throws javax.ejb.EJBException

Setter for property panelBackgroundTabStyle . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getPanelIds

java.util.List getPanelIds()
                           throws javax.ejb.EJBException

Getter for property panelIds

Returns:

List

Throws:

javax.ejb.EJBException

setPanelIds

void setPanelIds(java.util.List value)
                 throws javax.ejb.EJBException

Setter for property panelIds . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - List

Throws:

javax.ejb.EJBException

getPanelSelectedTabStyle

java.lang.String getPanelSelectedTabStyle()
                                          throws javax.ejb.EJBException

Getter for property panelSelectedTabStyle

Returns:

String

Throws:

javax.ejb.EJBException

setPanelSelectedTabStyle

void setPanelSelectedTabStyle(java.lang.String value)
                              throws javax.ejb.EJBException

Setter for property panelSelectedTabStyle . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getPanelStackId

java.lang.String getPanelStackId()
                                 throws javax.ejb.EJBException

Getter for property panelStackId

Returns:

String

Throws:

javax.ejb.EJBException

setPanelStackId

void setPanelStackId(java.lang.String value)
                     throws javax.ejb.EJBException

Setter for property panelStackId . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getPanelTitlebarTabbedStyle

java.lang.String getPanelTitlebarTabbedStyle()
                                             throws javax.ejb.EJBException

Getter for property panelTitlebarTabbedStyle

Returns:

String

Throws:

javax.ejb.EJBException

setPanelTitlebarTabbedStyle

void setPanelTitlebarTabbedStyle(java.lang.String value)
                                 throws javax.ejb.EJBException

Setter for property panelTitlebarTabbedStyle . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getPanelTitlebarUntabbedStyle

java.lang.String getPanelTitlebarUntabbedStyle()
                                               throws javax.ejb.EJBException

Getter for property panelTitlebarUntabbedStyle

Returns:

String

Throws:

javax.ejb.EJBException

setPanelTitlebarUntabbedStyle

void setPanelTitlebarUntabbedStyle(java.lang.String value)
                                   throws javax.ejb.EJBException

Setter for property panelTitlebarUntabbedStyle . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

isTabAffinityYn

boolean isTabAffinityYn()
                        throws javax.ejb.EJBException

Getter for property tabAffinityYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setTabAffinityYn

void setTabAffinityYn(boolean value)
                      throws javax.ejb.EJBException

Setter for property tabAffinityYn . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - boolean

Throws:

javax.ejb.EJBException

getTitleKey

java.lang.String getTitleKey()
                             throws javax.ejb.EJBException

Getter for property titleKey

Returns:

String

Throws:

javax.ejb.EJBException

setTitleKey

void setTitleKey(java.lang.String value)
                 throws javax.ejb.EJBException

Setter for property titleKey . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

isRemoved

boolean isRemoved()
                  throws javax.ejb.EJBException

Returns true if the underlying object has been removed. False otherwise.

Specified by:

isRemoved in interface FrameworkObject

Throws:

javax.ejb.EJBException

copyTo

void copyTo(PanelStackDefinition destination)
            throws javax.ejb.EJBException

Copies the property values of this instance to another instance of the same data type. Only properties that are both readable and writable are copied. Each property is copied by calling the getter method on the source instance and setting the result in the destination instance using the setter method.

Throws:

javax.ejb.EJBException

writeInstance

void writeInstance()
                   throws javax.ejb.EJBException

This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries. Changes might be made visible before calling this method, but this is not guaranteed until this method is called.

Specified by:

writeInstance in interface FrameworkObject

Throws:

javax.ejb.EJBException

prepareInstanceForWrite

void prepareInstanceForWrite()
                             throws javax.ejb.EJBException

This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write. This must be called before that first read.

Specified by:

prepareInstanceForWrite in interface FrameworkObject

Throws:

javax.ejb.EJBException

_isMutable

boolean _isMutable()

Returns true if the item is mutable. Items are only mutable after a setter method or prepareInstanceForWrite is called.

Specified by:

_isMutable in interface FrameworkObject

getPanels

java.util.List getPanels()
                         throws ObjectNotFoundException,
                                javax.ejb.EJBException

Returns:

Returns the list of panels.

Throws:

ObjectNotFoundException

javax.ejb.EJBException - A system-level error occurred