atg.svc.repository.beans
Interface CellDefinition

All Superinterfaces:

javax.ejb.EJBLocalObject, FrameworkObject

All Known Implementing Classes:

_CellDefinition_BeanImpl, _CellDefinition_Impl, _CellDefinition_ReposImpl

public interface CellDefinition
extends javax.ejb.EJBLocalObject, FrameworkObject

Class CellDefinition

• Home: CellDefinitionHome
• 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
appId	String		R, W, Cch, Qry, Req
cellId	String		R, W, Cch, Qry, Req
cellOpenYn	boolean		R, W, Cch, Qry, Req
contentIds	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
objectType	FrameworkObjectObjectType		R, W, Cch, Qry, Req
optionNames	Map		R, W, Cch, CoM, Mv, Qry
resourceBundle	String		R, W, Cch, Qry
segmentName	String		R, W, Cch, Qry
templateIds	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 accessRight: String

• Getter: getAccessRight()
• Setter: setAccessRight(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: accessright

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

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(CellDefinition 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	getCellId() Getter for property cellId
java.lang.String	getId() Getter for property id
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	setAccessRight(java.lang.String value) Setter for property accessRight .
void	setCellId(java.lang.String value) Setter for property cellId .
void	setCellOpenYn(boolean value) Setter for property cellOpenYn .
void	setId(java.lang.String value) Setter for property id .
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

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

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

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