atg.svc.repository.beans
Interface CellInstance

All Superinterfaces:

javax.ejb.EJBLocalObject, InstanceObject

All Known Implementing Classes:

_CellInstance_BeanImpl, _CellInstance_Impl, _CellInstance_ReposImpl

public interface CellInstance
extends javax.ejb.EJBLocalObject, InstanceObject

Class CellInstance

• Home: CellInstanceHome
• 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
cellId	String		R, W, Cch, Qry, Req
cellOpenYn	boolean		R, W, Cch, Qry, Req
currentPanelStackId	String		R, W, Cch, Qry, Req
enabledYn	boolean		R, W, Cch, Qry, Req
instanceType	InstanceObjectInstanceType		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 cellId: String

• Getter: getCellId()
• Setter: setCellId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: cellid

Property cellOpenYn: boolean

• Getter: isCellOpenYn()
• Setter: setCellOpenYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: true
• Type Name: boolean
• Sort String: cellopenyn

Property currentPanelStackId: String

• Getter: getCurrentPanelStackId()
• Setter: setCurrentPanelStackId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: currentpanelstackid

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

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(CellInstance destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getCellId() Getter for property cellId
java.lang.String	getCurrentPanelStackId() Getter for property currentPanelStackId
boolean	isCellOpenYn() Getter for property cellOpenYn
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	setCellId(java.lang.String value) Setter for property cellId .
void	setCellOpenYn(boolean value) Setter for property cellOpenYn .
void	setCurrentPanelStackId(java.lang.String value) Setter for property currentPanelStackId .
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

getCellId

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

Getter for property cellId

Returns:

String

Throws:

javax.ejb.EJBException

setCellId

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

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

isCellOpenYn

boolean isCellOpenYn()
                     throws javax.ejb.EJBException

Getter for property cellOpenYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setCellOpenYn

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

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

getCurrentPanelStackId

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

Getter for property currentPanelStackId

Returns:

String

Throws:

javax.ejb.EJBException

setCurrentPanelStackId

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

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

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