atg.svc.repository.beans
Interface TabInstance

All Superinterfaces:

javax.ejb.EJBLocalObject, InstanceObject

All Known Implementing Classes:

_TabInstance_BeanImpl, _TabInstance_Impl, _TabInstance_ReposImpl

public interface TabInstance
extends javax.ejb.EJBLocalObject, InstanceObject

Class TabInstance

• Home: TabInstanceHome
• 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
cellAssignments	Map		R, W, Cch, CoM, Mv, Qry
currentPanelStacks	Map		R, W, Cch, CoM, Mv, Qry
enabledYn	boolean		R, W, Cch, Qry, Req
instanceType	InstanceObjectInstanceType		R, W, Cch, Qry, Req
nextStepsId	String		R, W, Cch, Qry
tabId	String		R, W, Cch, Qry, Req
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 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 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 enabledYn: boolean

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

Property instanceType: InstanceObjectInstanceType

• Getter: InstanceObject.getInstanceType()
• Setter: InstanceObject.setInstanceType(atg.svc.repository.beans.InstanceObjectInstanceType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: instancetype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property nextStepsId: String

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

Property tabId: String

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

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(TabInstance destination) Copies the property values of this instance to another instance of the same data type.
java.util.Map	getCellAssignments() Getter for property cellAssignments
java.util.Map	getCurrentPanelStacks() Getter for property currentPanelStacks
java.lang.String	getNextStepsId() Getter for property nextStepsId
java.lang.String	getTabId() Getter for property tabId
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	setCellAssignments(java.util.Map value) Setter for property cellAssignments .
void	setCurrentPanelStacks(java.util.Map value) Setter for property currentPanelStacks .
void	setNextStepsId(java.lang.String value) Setter for property nextStepsId .
void	setTabId(java.lang.String value) Setter for property tabId .
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.InstanceObject

copyTo, getInstanceType, isEnabledYn, setEnabledYn, setInstanceType

Method Detail

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

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

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

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 InstanceObject

Throws:

javax.ejb.EJBException

copyTo

void copyTo(TabInstance 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 InstanceObject

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 InstanceObject

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 InstanceObject