atg.svc.repository.beans
Interface FrameworkObject

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Subinterfaces:

CellDefinition, ContentDefinition, FrameworkDefinition, PanelDefinition, PanelStackDefinition, SkinDefinition, TabDefinition, TemplateDefinition

All Known Implementing Classes:

_CellDefinition_BeanImpl, _CellDefinition_Impl, _CellDefinition_ReposImpl, _ContentDefinition_BeanImpl, _ContentDefinition_Impl, _ContentDefinition_ReposImpl, _FrameworkDefinition_BeanImpl, _FrameworkDefinition_Impl, _FrameworkDefinition_ReposImpl, _FrameworkObject_BeanImpl, _FrameworkObject_Impl, _FrameworkObject_ReposImpl, _PanelDefinition_BeanImpl, _PanelDefinition_Impl, _PanelDefinition_ReposImpl, _PanelStackDefinition_BeanImpl, _PanelStackDefinition_Impl, _PanelStackDefinition_ReposImpl, _SkinDefinition_BeanImpl, _SkinDefinition_Impl, _SkinDefinition_ReposImpl, _TabDefinition_BeanImpl, _TabDefinition_Impl, _TabDefinition_ReposImpl, _TemplateDefinition_BeanImpl, _TemplateDefinition_Impl, _TemplateDefinition_ReposImpl

public interface FrameworkObject
extends javax.ejb.EJBLocalObject

Class FrameworkObject

• Home: FrameworkObjectHome
• 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
  references	[:FrameworkObject.default]

Property Summaries

Property Name	Property Type	Property Description	Flags
appId	String		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 appId: String

• Getter: getAppId()
• Setter: setAppId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: appid

Property contentIds: Map

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

Property default: FrameworkObject

• Getter: getDefault()
• Setter: setDefault(atg.svc.repository.beans.FrameworkObject)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: default

Property descriptionKey: String

• Getter: getDescriptionKey()
• Setter: setDescriptionKey(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: descriptionkey

Property enabledYn: boolean

• Getter: isEnabledYn()
• Setter: 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: getImageUrl()
• Setter: setImageUrl(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: imageurl

Property nameKey: String

• Getter: getNameKey()
• Setter: setNameKey(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: namekey

Property objectType: FrameworkObjectObjectType

• Getter: getObjectType()
• Setter: 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: getOptionNames()
• Setter: setOptionNames(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: optionnames

Property resourceBundle: String

• Getter: getResourceBundle()
• Setter: setResourceBundle(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: resourcebundle

Property segmentName: String

• Getter: getSegmentName()
• Setter: setSegmentName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: segmentname

Property templateIds: Map

• Getter: getTemplateIds()
• Setter: 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(FrameworkObject destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getAppId() Getter for property appId
java.util.Map	getContentIds() Getter for property contentIds
java.util.Map	getContents()
FrameworkObject	getDefault() Getter for property default
java.lang.String	getDescriptionKey() Getter for property descriptionKey
java.lang.String	getId() Getter for property id
java.lang.String	getImageUrl() Getter for property imageUrl
java.lang.String	getNameKey() Getter for property nameKey
FrameworkObjectObjectType	getObjectType() Getter for property objectType
java.util.Map	getOptionNames() Getter for property optionNames
java.util.Map	getOptions()
java.lang.String	getResourceBundle() Getter for property resourceBundle
java.lang.String	getSegmentName() Getter for property segmentName
java.util.Map	getTemplateIds() Getter for property templateIds
java.util.Map	getTemplates()
boolean	isEnabledYn() Getter for property enabledYn
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	setAppId(java.lang.String value) Setter for property appId .
void	setContentIds(java.util.Map value) Setter for property contentIds .
void	setDefault(FrameworkObject value) Setter for property default .
void	setDescriptionKey(java.lang.String value) Setter for property descriptionKey .
void	setEnabledYn(boolean value) Setter for property enabledYn .
void	setId(java.lang.String value) Setter for property id .
void	setImageUrl(java.lang.String value) Setter for property imageUrl .
void	setNameKey(java.lang.String value) Setter for property nameKey .
void	setObjectType(FrameworkObjectObjectType value) Setter for property objectType .
void	setOptionNames(java.util.Map value) Setter for property optionNames .
void	setResourceBundle(java.lang.String value) Setter for property resourceBundle .
void	setSegmentName(java.lang.String value) Setter for property segmentName .
void	setTemplateIds(java.util.Map value) Setter for property templateIds .
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 javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

getAppId

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

Getter for property appId

Returns:

String

Throws:

javax.ejb.EJBException

setAppId

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

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

getContentIds

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

Getter for property contentIds

Returns:

Map

Throws:

javax.ejb.EJBException

setContentIds

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

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

getDefault

FrameworkObject getDefault()
                           throws javax.ejb.EJBException

Getter for property default

Returns:

FrameworkObject

Throws:

javax.ejb.EJBException

setDefault

void setDefault(FrameworkObject value)
                throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getDescriptionKey

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

Getter for property descriptionKey

Returns:

String

Throws:

javax.ejb.EJBException

setDescriptionKey

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

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

isEnabledYn

boolean isEnabledYn()
                    throws javax.ejb.EJBException

Getter for property enabledYn

Returns:

boolean

Throws:

javax.ejb.EJBException

setEnabledYn

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

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

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.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getImageUrl

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

Getter for property imageUrl

Returns:

String

Throws:

javax.ejb.EJBException

setImageUrl

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

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

getNameKey

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

Getter for property nameKey

Returns:

String

Throws:

javax.ejb.EJBException

setNameKey

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

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

getObjectType

FrameworkObjectObjectType getObjectType()
                                        throws javax.ejb.EJBException

Getter for property objectType

Returns:

FrameworkObjectObjectType

Throws:

javax.ejb.EJBException

setObjectType

void setObjectType(FrameworkObjectObjectType value)
                   throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getOptionNames

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

Getter for property optionNames

Returns:

Map

Throws:

javax.ejb.EJBException

setOptionNames

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

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

getResourceBundle

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

Getter for property resourceBundle

Returns:

String

Throws:

javax.ejb.EJBException

setResourceBundle

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

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

getSegmentName

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

Getter for property segmentName

Returns:

String

Throws:

javax.ejb.EJBException

setSegmentName

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

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

getTemplateIds

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

Getter for property templateIds

Returns:

Map

Throws:

javax.ejb.EJBException

setTemplateIds

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

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

Throws:

javax.ejb.EJBException

copyTo

void copyTo(FrameworkObject 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.

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.

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.

getContents

java.util.Map getContents()
                          throws ObjectNotFoundException,
                                 javax.ejb.EJBException

Returns:

Returns the map of contents.

Throws:

ObjectNotFoundException

javax.ejb.EJBException - A system-level error occurred

getOptions

java.util.Map getOptions()
                         throws ObjectNotFoundException,
                                javax.ejb.EJBException

Returns:

Returns the map of options.

Throws:

ObjectNotFoundException

javax.ejb.EJBException - A system-level error occurred

getTemplates

java.util.Map getTemplates()
                           throws ObjectNotFoundException,
                                  javax.ejb.EJBException

Returns:

Returns the map of templates.

Throws:

ObjectNotFoundException

javax.ejb.EJBException - A system-level error occurred