atg.svc.repository.beans
Interface TabDefinition

All Superinterfaces:

javax.ejb.EJBLocalObject, FrameworkObject

All Known Implementing Classes:

_TabDefinition_BeanImpl, _TabDefinition_Impl, _TabDefinition_ReposImpl

public interface TabDefinition
extends javax.ejb.EJBLocalObject, FrameworkObject

Class TabDefinition

• Home: TabDefinitionHome
• 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
actionId	String		R, W, Cch, Qry
appId	String		R, W, Cch, Qry, Req
cellAssignments	Map		R, W, Cch, CoM, Mv, Qry
contentIds	Map		R, W, Cch, CoM, Mv, Qry
currentPanelStacks	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
id	String		R, W, Cch, Id, Qry, Req
imageUrl	String		R, W, Cch, Qry
nameKey	String		R, W, Cch, Qry
nextStepsId	String		R, W, Cch, Qry
objectType	FrameworkObjectObjectType		R, W, Cch, Qry, Req
optionNames	Map		R, W, Cch, CoM, Mv, Qry
panelStackAssignments	Map		R, W, Cch, CoM, Mv, Qry
panelStackOrder	List		R, W, Cch, CoM, Mv, Qry
resourceBundle	String		R, W, Cch, Qry
segmentName	String		R, W, Cch, Qry
tabId	String		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 actionId: String

• Getter: getActionId()
• Setter: setActionId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: actionid

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 cellAssignments: Map

• Getter: getCellAssignments()
• Setter: setCellAssignments(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: cellassignments

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 currentPanelStacks: Map

• Getter: getCurrentPanelStacks()
• Setter: setCurrentPanelStacks(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: currentpanelstacks

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

• Getter: getNextStepsId()
• Setter: setNextStepsId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: nextstepsid

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 panelStackAssignments: Map

• Getter: getPanelStackAssignments()
• Setter: setPanelStackAssignments(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: panelstackassignments

Property panelStackOrder: List

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

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

• Getter: getTabId()
• Setter: setTabId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: tabid

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	copyTo(TabDefinition 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	getActionId() Getter for property actionId
java.util.Map	getCellAssignments() Getter for property cellAssignments
java.util.Map	getCurrentPanelStacks() Getter for property currentPanelStacks
java.lang.String	getId() Getter for property id
java.lang.String	getNextStepsId() Getter for property nextStepsId
java.util.Map	getPanelStackAssignments() Getter for property panelStackAssignments
java.util.List	getPanelStackOrder() Getter for property panelStackOrder
java.lang.String	getTabId() Getter for property tabId
java.lang.String	getTitleKey() Getter for property titleKey
boolean	isRemoved() Returns true if the underlying object has been removed.
boolean	isVisibleYn() Getter for property visibleYn
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	setAccessRight(java.lang.String value) Setter for property accessRight .
void	setActionId(java.lang.String value) Setter for property actionId .
void	setCellAssignments(java.util.Map value) Setter for property cellAssignments .
void	setCurrentPanelStacks(java.util.Map value) Setter for property currentPanelStacks .
void	setId(java.lang.String value) Setter for property id .
void	setNextStepsId(java.lang.String value) Setter for property nextStepsId .
void	setPanelStackAssignments(java.util.Map value) Setter for property panelStackAssignments .
void	setPanelStackOrder(java.util.List value) Setter for property panelStackOrder .
void	setTabId(java.lang.String value) Setter for property tabId .
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

getActionId

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

Getter for property actionId

Returns:

String

Throws:

javax.ejb.EJBException

setActionId

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

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

getCellAssignments

java.util.Map getCellAssignments()
                                 throws javax.ejb.EJBException

Getter for property cellAssignments

Returns:

Map

Throws:

javax.ejb.EJBException

setCellAssignments

void setCellAssignments(java.util.Map value)
                        throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getCurrentPanelStacks

java.util.Map getCurrentPanelStacks()
                                    throws javax.ejb.EJBException

Getter for property currentPanelStacks

Returns:

Map

Throws:

javax.ejb.EJBException

setCurrentPanelStacks

void setCurrentPanelStacks(java.util.Map value)
                           throws javax.ejb.EJBException

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

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

getNextStepsId

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

Getter for property nextStepsId

Returns:

String

Throws:

javax.ejb.EJBException

setNextStepsId

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

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

getPanelStackAssignments

java.util.Map getPanelStackAssignments()
                                       throws javax.ejb.EJBException

Getter for property panelStackAssignments

Returns:

Map

Throws:

javax.ejb.EJBException

setPanelStackAssignments

void setPanelStackAssignments(java.util.Map value)
                              throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getPanelStackOrder

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

Getter for property panelStackOrder

Returns:

List

Throws:

javax.ejb.EJBException

setPanelStackOrder

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

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

getTabId

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

Getter for property tabId

Returns:

String

Throws:

javax.ejb.EJBException

setTabId

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

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

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