atg.svc.repository.beans
Interface PanelInstance

All Superinterfaces:

javax.ejb.EJBLocalObject, InstanceObject

All Known Implementing Classes:

_PanelInstance_BeanImpl, _PanelInstance_Impl, _PanelInstance_ReposImpl

public interface PanelInstance
extends javax.ejb.EJBLocalObject, InstanceObject

Class PanelInstance

• Home: PanelInstanceHome
• 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
availableYn	boolean		R, W, Cch, Qry, Req
contentOpenYn	boolean		R, W, Cch, Qry, Req
currentPanelId	String		R, W, Cch, Qry
enabledYn	boolean		R, W, Cch, Qry, Req
instanceType	InstanceObjectInstanceType		R, W, Cch, Qry, Req
panelId	String		R, W, Cch, Qry, Req
panelOpenYn	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
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 availableYn: boolean

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

Property contentOpenYn: boolean

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

Property currentPanelId: String

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

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

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

Property panelOpenYn: boolean

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

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 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(PanelInstance destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getCurrentPanelId() Getter for property currentPanelId
boolean	getHasTabScrollIndex() Returns true if the value of property tabScrollIndex is null.
java.lang.String	getPanelId() Getter for property panelId
java.util.List	getTabbedPanelIds() Getter for property tabbedPanelIds
int	getTabScrollIndex() Getter for property tabScrollIndex
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	isTabbedYn() Getter for property tabbedYn
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	setAvailableYn(boolean value) Setter for property availableYn .
void	setContentOpenYn(boolean value) Setter for property contentOpenYn .
void	setCurrentPanelId(java.lang.String value) Setter for property currentPanelId .
void	setHasTabScrollIndex(boolean value) If this is set to false, then the underlying value of property tabScrollIndex is set to null.
void	setPanelId(java.lang.String value) Setter for property panelId .
void	setPanelOpenYn(boolean value) Setter for property panelOpenYn .
void	setTabbedPanelIds(java.util.List value) Setter for property tabbedPanelIds .
void	setTabbedYn(boolean value) Setter for property tabbedYn .
void	setTabScrollIndex(int value) Setter for property tabScrollIndex .
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

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

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

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

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

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

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