atg.svc.repository.beans
Interface PanelStackInstance

All Superinterfaces:

javax.ejb.EJBLocalObject, InstanceObject

All Known Implementing Classes:

_PanelStackInstance_BeanImpl, _PanelStackInstance_Impl, _PanelStackInstance_ReposImpl

public interface PanelStackInstance
extends javax.ejb.EJBLocalObject, InstanceObject

Class PanelStackInstance

• Home: PanelStackInstanceHome
• 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
enabledYn	boolean		R, W, Cch, Qry, Req
instanceType	InstanceObjectInstanceType		R, W, Cch, Qry, Req
panelStackId	String		R, W, Cch, Qry, Req
panelTargetElements	List of PanelTargetElement		R, W, CsD, Cch, CoM, Mv, Qry
targetMap	Map		R, W, Cch, CoM, Mv, Qry

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

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

Property panelTargetElements: List of PanelTargetElement

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

Property targetMap: Map

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

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(PanelStackInstance destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getPanelStackId() Getter for property panelStackId
java.util.List	getPanelTargetElements() Getter for property panelTargetElements
java.util.Map	getTargetMap() Getter for property targetMap
boolean	isRemoved() Returns true if the underlying object has been removed.
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	setPanelStackId(java.lang.String value) Setter for property panelStackId .
void	setPanelTargetElements(java.util.List value) Setter for property panelTargetElements .
void	setTargetMap(java.util.Map value) Setter for property targetMap .
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

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

getPanelTargetElements

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

Getter for property panelTargetElements

Returns:

List of PanelTargetElement

Throws:

javax.ejb.EJBException

setPanelTargetElements

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

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

Throws:

javax.ejb.EJBException

getTargetMap

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

Getter for property targetMap

Returns:

Map

Throws:

javax.ejb.EJBException

setTargetMap

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

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

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