atg.svc.repository.beans
Interface PanelDefinition

All Superinterfaces:

javax.ejb.EJBLocalObject, FrameworkObject

All Known Implementing Classes:

_PanelDefinition_BeanImpl, _PanelDefinition_Impl, _PanelDefinition_ReposImpl

public interface PanelDefinition
extends javax.ejb.EJBLocalObject, FrameworkObject

Class PanelDefinition

• Home: PanelDefinitionHome
• 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
accessRight	String		R, W, Cch, Qry, Req
allowContentToggleYn	boolean		R, W, Cch, Qry, Req
allowPanelToggleYn	boolean		R, W, Cch, Qry, Req
allowSlotsYn	boolean		R, W, Cch, Qry, Req
allowTabbingYn	boolean		R, W, Cch, Qry, Req
alwaysTabbedYn	boolean		R, W, Cch, Qry, Req
appId	String		R, W, Cch, Qry, Req
availableYn	boolean		R, W, Cch, Qry, Req
contentIds	Map		R, W, Cch, CoM, Mv, Qry
contentOpenYn	boolean		R, W, Cch, Qry, Req
contentUrl	String		R, W, Cch, Qry
currentPanelId	String		R, W, Cch, Qry
default	FrameworkObject		R, W, Cch, Qry
descriptionKey	String		R, W, Cch, Qry
enabledYn	boolean		R, W, Cch, Qry, Req
helpKey	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
onload	String		R, W, Cch, Qry
onunload	String		R, W, Cch, Qry
optionNames	Map		R, W, Cch, CoM, Mv, Qry
otherContext	String		R, W, Cch, Qry
panelId	String		R, W, Cch, Qry, Req
panelItemCount	int		R, W, Cch, Qry
panelOpenYn	boolean		R, W, Cch, Qry, Req
panelTitleStyle	String		R, W, Cch, Qry
resourceBundle	String		R, W, Cch, Qry
segmentName	String		R, W, Cch, Qry
showTitleYn	boolean		R, W, Cch, Qry, Req
slotRendererCombos	List of SlotRendererCombo		R, W, CsD, Cch, CoM, Mv, Qry
tabHolderYn	boolean		R, W, Cch, Qry, Req
tabScrollIndex	int		R, W, Cch, Qry
tabbedPanelIds	List		R, W, Cch, CoM, Mv, Qry
tabbedYn	boolean		R, W, Cch, Qry, Req
templateIds	Map		R, W, Cch, CoM, Mv, Qry
titleKey	String		R, W, Cch, Qry
visibleYn	boolean		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 accessRight: String

• Getter: getAccessRight()
• Setter: setAccessRight(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: accessright

Property allowContentToggleYn: boolean

• Getter: isAllowContentToggleYn()
• Setter: setAllowContentToggleYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: allowcontenttoggleyn

Property allowPanelToggleYn: boolean

• Getter: isAllowPanelToggleYn()
• Setter: setAllowPanelToggleYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: allowpaneltoggleyn

Property allowSlotsYn: boolean

• Getter: isAllowSlotsYn()
• Setter: setAllowSlotsYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: allowslotsyn

Property allowTabbingYn: boolean

• Getter: isAllowTabbingYn()
• Setter: setAllowTabbingYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: allowtabbingyn

Property alwaysTabbedYn: boolean

• Getter: isAlwaysTabbedYn()
• Setter: setAlwaysTabbedYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: alwaystabbedyn

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 availableYn: boolean

• Getter: isAvailableYn()
• Setter: setAvailableYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: availableyn

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 contentOpenYn: boolean

• Getter: isContentOpenYn()
• Setter: setContentOpenYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: true
• Type Name: boolean
• Sort String: contentopenyn

Property contentUrl: String

• Getter: getContentUrl()
• Setter: setContentUrl(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: contenturl

Property currentPanelId: String

• Getter: getCurrentPanelId()
• Setter: setCurrentPanelId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: currentpanelid

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 helpKey: String

• Getter: getHelpKey()
• Setter: setHelpKey(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: helpkey

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 onload: String

• Getter: getOnload()
• Setter: setOnload(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: onload

Property onunload: String

• Getter: getOnunload()
• Setter: setOnunload(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: onunload

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 otherContext: String

• Getter: getOtherContext()
• Setter: setOtherContext(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: othercontext

Property panelId: String

• Getter: getPanelId()
• Setter: setPanelId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: panelid

Property panelItemCount: int

• Getter: getPanelItemCount()
• Setter: setPanelItemCount(int)
• Flags: readable, writable, cacheable, queryable
• Type Name: int
• Sort String: panelitemcount

Property panelOpenYn: boolean

• Getter: isPanelOpenYn()
• Setter: setPanelOpenYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: true
• Type Name: boolean
• Sort String: panelopenyn

Property panelTitleStyle: String

• Getter: getPanelTitleStyle()
• Setter: setPanelTitleStyle(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: paneltitlestyle

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 showTitleYn: boolean

• Getter: isShowTitleYn()
• Setter: setShowTitleYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: true
• Type Name: boolean
• Sort String: showtitleyn

Property slotRendererCombos: List of SlotRendererCombo

• Getter: getSlotRendererCombos()
• Setter: setSlotRendererCombos(java.util.List)
• Flags: readable, writable, cascadeDelete, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: slotrenderercombos
• Attributes:

  Attribute Name	Attribute Value
  deployable	false

Property tabHolderYn: boolean

• Getter: isTabHolderYn()
• Setter: setTabHolderYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: tabholderyn

Property tabScrollIndex: int

• Getter: getTabScrollIndex()
• Setter: setTabScrollIndex(int)
• Flags: readable, writable, cacheable, queryable
• Type Name: int
• Sort String: tabscrollindex

Property tabbedPanelIds: List

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

Property tabbedYn: boolean

• Getter: isTabbedYn()
• Setter: setTabbedYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: tabbedyn

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
• Type Name: string
• Sort String: titlekey

Property visibleYn: boolean

• Getter: isVisibleYn()
• Setter: setVisibleYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: true
• Type Name: boolean
• Sort String: visibleyn

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	addSlotRendererCombo(SlotRendererCombo combo) Adds a SlotRendererCombo to the PanelDefinition
void	copyTo(PanelDefinition destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getAccessRight() Getter for property accessRight
java.lang.String	getContentUrl() Getter for property contentUrl
java.lang.String	getCurrentPanelId() Getter for property currentPanelId
boolean	getHasPanelItemCount() Returns true if the value of property panelItemCount is null.
boolean	getHasTabScrollIndex() Returns true if the value of property tabScrollIndex is null.
java.lang.String	getHelpKey() Getter for property helpKey
java.lang.String	getId() Getter for property id
java.lang.String	getOnload() Getter for property onload
java.lang.String	getOnunload() Getter for property onunload
java.lang.String	getOtherContext() Getter for property otherContext
java.lang.String	getPanelId() Getter for property panelId
int	getPanelItemCount() Getter for property panelItemCount
java.lang.String	getPanelTitleStyle() Getter for property panelTitleStyle
java.util.List	getSlotRendererCombos() Getter for property slotRendererCombos
java.util.List	getTabbedPanelIds() Getter for property tabbedPanelIds
int	getTabScrollIndex() Getter for property tabScrollIndex
java.lang.String	getTitleKey() Getter for property titleKey
boolean	isAllowContentToggleYn() Getter for property allowContentToggleYn
boolean	isAllowPanelToggleYn() Getter for property allowPanelToggleYn
boolean	isAllowSlotsYn() Getter for property allowSlotsYn
boolean	isAllowTabbingYn() Getter for property allowTabbingYn
boolean	isAlwaysTabbedYn() Getter for property alwaysTabbedYn
boolean	isAvailableYn() Getter for property availableYn
boolean	isContentOpenYn() Getter for property contentOpenYn
boolean	isPanelOpenYn() Getter for property panelOpenYn
boolean	isRemoved() Returns true if the underlying object has been removed.
boolean	isShowTitleYn() Getter for property showTitleYn
boolean	isTabbedYn() Getter for property tabbedYn
boolean	isTabHolderYn() Getter for property tabHolderYn
boolean	isVisibleYn() Getter for property visibleYn
void	moveSlotRendererComboDown(SlotRendererCombo combo) Move a SlotRendererCombo down in the order
void	moveSlotRendererComboUp(SlotRendererCombo combo) Move a SlotRendererCombo up in the order
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.
boolean	removeSlotRendererCombo(SlotRendererCombo combo) Remove a SlotRendererCombo from the PanelDefinition
void	setAccessRight(java.lang.String value) Setter for property accessRight .
void	setAllowContentToggleYn(boolean value) Setter for property allowContentToggleYn .
void	setAllowPanelToggleYn(boolean value) Setter for property allowPanelToggleYn .
void	setAllowSlotsYn(boolean value) Setter for property allowSlotsYn .
void	setAllowTabbingYn(boolean value) Setter for property allowTabbingYn .
void	setAlwaysTabbedYn(boolean value) Setter for property alwaysTabbedYn .
void	setAvailableYn(boolean value) Setter for property availableYn .
void	setContentOpenYn(boolean value) Setter for property contentOpenYn .
void	setContentUrl(java.lang.String value) Setter for property contentUrl .
void	setCurrentPanelId(java.lang.String value) Setter for property currentPanelId .
void	setHasPanelItemCount(boolean value) If this is set to false, then the underlying value of property panelItemCount is set to null.
void	setHasTabScrollIndex(boolean value) If this is set to false, then the underlying value of property tabScrollIndex is set to null.
void	setHelpKey(java.lang.String value) Setter for property helpKey .
void	setId(java.lang.String value) Setter for property id .
void	setOnload(java.lang.String value) Setter for property onload .
void	setOnunload(java.lang.String value) Setter for property onunload .
void	setOtherContext(java.lang.String value) Setter for property otherContext .
void	setPanelId(java.lang.String value) Setter for property panelId .
void	setPanelItemCount(int value) Setter for property panelItemCount .
void	setPanelOpenYn(boolean value) Setter for property panelOpenYn .
void	setPanelTitleStyle(java.lang.String value) Setter for property panelTitleStyle .
void	setShowTitleYn(boolean value) Setter for property showTitleYn .
void	setSlotRendererCombos(java.util.List value) Setter for property slotRendererCombos .
void	setTabbedPanelIds(java.util.List value) Setter for property tabbedPanelIds .
void	setTabbedYn(boolean value) Setter for property tabbedYn .
void	setTabHolderYn(boolean value) Setter for property tabHolderYn .
void	setTabScrollIndex(int value) Setter for property tabScrollIndex .
void	setTitleKey(java.lang.String value) Setter for property titleKey .
void	setVisibleYn(boolean value) Setter for property visibleYn .
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

getAccessRight

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

Getter for property accessRight

Returns:

String

Throws:

javax.ejb.EJBException

setAccessRight

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

Setter for property accessRight . 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

isAllowContentToggleYn

boolean isAllowContentToggleYn()
                               throws javax.ejb.EJBException

Getter for property allowContentToggleYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setAllowContentToggleYn

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

Setter for property allowContentToggleYn . 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

isAllowPanelToggleYn

boolean isAllowPanelToggleYn()
                             throws javax.ejb.EJBException

Getter for property allowPanelToggleYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setAllowPanelToggleYn

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

Setter for property allowPanelToggleYn . 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

isAllowSlotsYn

boolean isAllowSlotsYn()
                       throws javax.ejb.EJBException

Getter for property allowSlotsYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setAllowSlotsYn

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

Setter for property allowSlotsYn . 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

isAllowTabbingYn

boolean isAllowTabbingYn()
                         throws javax.ejb.EJBException

Getter for property allowTabbingYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setAllowTabbingYn

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

Setter for property allowTabbingYn . 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

isAlwaysTabbedYn

boolean isAlwaysTabbedYn()
                         throws javax.ejb.EJBException

Getter for property alwaysTabbedYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setAlwaysTabbedYn

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

Setter for property alwaysTabbedYn . 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

isAvailableYn

boolean isAvailableYn()
                      throws javax.ejb.EJBException

Getter for property availableYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setAvailableYn

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

Setter for property availableYn . 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

isContentOpenYn

boolean isContentOpenYn()
                        throws javax.ejb.EJBException

Getter for property contentOpenYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setContentOpenYn

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

Setter for property contentOpenYn . 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

getContentUrl

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

Getter for property contentUrl

Returns:

String

Throws:

javax.ejb.EJBException

setContentUrl

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

Setter for property contentUrl . 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

getCurrentPanelId

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

Getter for property currentPanelId

Returns:

String

Throws:

javax.ejb.EJBException

setCurrentPanelId

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

Setter for property currentPanelId . 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

getHelpKey

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

Getter for property helpKey

Returns:

String

Throws:

javax.ejb.EJBException

setHelpKey

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

Setter for property helpKey . 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

getOnload

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

Getter for property onload

Returns:

String

Throws:

javax.ejb.EJBException

setOnload

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

Setter for property onload . 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

getOnunload

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

Getter for property onunload

Returns:

String

Throws:

javax.ejb.EJBException

setOnunload

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

Setter for property onunload . 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

getOtherContext

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

Getter for property otherContext

Returns:

String

Throws:

javax.ejb.EJBException

setOtherContext

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

Setter for property otherContext . 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

getPanelId

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

Getter for property panelId

Returns:

String

Throws:

javax.ejb.EJBException

setPanelId

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

Setter for property panelId . 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

getPanelItemCount

int getPanelItemCount()
                      throws javax.ejb.EJBException

Getter for property panelItemCount

Returns:

int

Throws:

javax.ejb.EJBException

getHasPanelItemCount

boolean getHasPanelItemCount()
                             throws javax.ejb.EJBException

Returns true if the value of property panelItemCount is null.

Throws:

javax.ejb.EJBException

setPanelItemCount

void setPanelItemCount(int value)
                       throws javax.ejb.EJBException

Setter for property panelItemCount . 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 - int

Throws:

javax.ejb.EJBException

setHasPanelItemCount

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

If this is set to false, then the underlying value of property panelItemCount is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

isPanelOpenYn

boolean isPanelOpenYn()
                      throws javax.ejb.EJBException

Getter for property panelOpenYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setPanelOpenYn

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

Setter for property panelOpenYn . 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

getPanelTitleStyle

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

Getter for property panelTitleStyle

Returns:

String

Throws:

javax.ejb.EJBException

setPanelTitleStyle

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

Setter for property panelTitleStyle . 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

isShowTitleYn

boolean isShowTitleYn()
                      throws javax.ejb.EJBException

Getter for property showTitleYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setShowTitleYn

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

Setter for property showTitleYn . 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

getSlotRendererCombos

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

Getter for property slotRendererCombos

Returns:

List of SlotRendererCombo

Throws:

javax.ejb.EJBException

setSlotRendererCombos

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

Setter for property slotRendererCombos . 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 of SlotRendererCombo

Throws:

javax.ejb.EJBException

isTabHolderYn

boolean isTabHolderYn()
                      throws javax.ejb.EJBException

Getter for property tabHolderYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setTabHolderYn

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

Setter for property tabHolderYn . 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

getTabScrollIndex

int getTabScrollIndex()
                      throws javax.ejb.EJBException

Getter for property tabScrollIndex

Returns:

int

Throws:

javax.ejb.EJBException

getHasTabScrollIndex

boolean getHasTabScrollIndex()
                             throws javax.ejb.EJBException

Returns true if the value of property tabScrollIndex is null.

Throws:

javax.ejb.EJBException

setTabScrollIndex

void setTabScrollIndex(int value)
                       throws javax.ejb.EJBException

Setter for property tabScrollIndex . 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 - int

Throws:

javax.ejb.EJBException

setHasTabScrollIndex

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

If this is set to false, then the underlying value of property tabScrollIndex is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

getTabbedPanelIds

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

Getter for property tabbedPanelIds

Returns:

List

Throws:

javax.ejb.EJBException

setTabbedPanelIds

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

Setter for property tabbedPanelIds . 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

isTabbedYn

boolean isTabbedYn()
                   throws javax.ejb.EJBException

Getter for property tabbedYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setTabbedYn

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

Setter for property tabbedYn . 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

isVisibleYn

boolean isVisibleYn()
                    throws javax.ejb.EJBException

Getter for property visibleYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setVisibleYn

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

Setter for property visibleYn . 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

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(PanelDefinition 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

addSlotRendererCombo

void addSlotRendererCombo(SlotRendererCombo combo)
                          throws javax.ejb.EJBException

Adds a SlotRendererCombo to the PanelDefinition

Parameters:

combo - The SlotRendererCombo

Throws:

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

removeSlotRendererCombo

boolean removeSlotRendererCombo(SlotRendererCombo combo)
                                throws javax.ejb.EJBException

Remove a SlotRendererCombo from the PanelDefinition

Parameters:

combo - The SlotRendererCombo

Returns:

true if the combo was removed successfully

Throws:

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

moveSlotRendererComboUp

void moveSlotRendererComboUp(SlotRendererCombo combo)
                             throws javax.ejb.EJBException

Move a SlotRendererCombo up in the order

Parameters:

combo - The SlotRendererCombo

Throws:

javax.ejb.EJBException

moveSlotRendererComboDown

void moveSlotRendererComboDown(SlotRendererCombo combo)
                               throws javax.ejb.EJBException

Move a SlotRendererCombo down in the order

Parameters:

combo - The SlotRendererCombo

Throws:

javax.ejb.EJBException