atg.svc.repository.beans
Interface FrameworkDefinition

All Superinterfaces:

javax.ejb.EJBLocalObject, FrameworkObject

All Known Implementing Classes:

_FrameworkDefinition_BeanImpl, _FrameworkDefinition_Impl, _FrameworkDefinition_ReposImpl

public interface FrameworkDefinition
extends javax.ejb.EJBLocalObject, FrameworkObject

Class FrameworkDefinition

• Home: FrameworkDefinitionHome
• 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
appId	String		R, W, Cch, Qry, Req
contentIds	Map		R, W, Cch, CoM, Mv, Qry
currentTabId	String		R, W, Cch, Qry
default	FrameworkObject		R, W, Cch, Qry
descriptionKey	String		R, W, Cch, Qry
enabledYn	boolean		R, W, Cch, Qry, Req
frameworkId	String		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
skinIds	List		R, W, Cch, CoM, Mv, Qry
tabIds	List		R, W, Cch, CoM, Mv, 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: FrameworkObject.getAppId()
• Setter: FrameworkObject.setAppId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: appid

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

• Getter: getCurrentTabId()
• Setter: setCurrentTabId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: currenttabid

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

• Getter: getFrameworkId()
• Setter: setFrameworkId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: frameworkid

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 skinIds: List

• Getter: getSkinIds()
• Setter: setSkinIds(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: skinids

Property tabIds: List

• Getter: getTabIds()
• Setter: setTabIds(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: tabids

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(FrameworkDefinition destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getCurrentTabId() Getter for property currentTabId
java.lang.String	getFrameworkId() Getter for property frameworkId
java.lang.String	getId() Getter for property id
java.util.List	getSkinIds() Getter for property skinIds
java.util.List	getSkins()
java.util.List	getTabIds() Getter for property tabIds
java.util.List	getTabs()
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	setCurrentTabId(java.lang.String value) Setter for property currentTabId .
void	setFrameworkId(java.lang.String value) Setter for property frameworkId .
void	setId(java.lang.String value) Setter for property id .
void	setSkinIds(java.util.List value) Setter for property skinIds .
void	setTabIds(java.util.List value) Setter for property tabIds .
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

getCurrentTabId

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

Getter for property currentTabId

Returns:

String

Throws:

javax.ejb.EJBException

setCurrentTabId

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

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

getFrameworkId

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

Getter for property frameworkId

Returns:

String

Throws:

javax.ejb.EJBException

setFrameworkId

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

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

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

getSkinIds

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

Getter for property skinIds

Returns:

List

Throws:

javax.ejb.EJBException

setSkinIds

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

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

getTabIds

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

Getter for property tabIds

Returns:

List

Throws:

javax.ejb.EJBException

setTabIds

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

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

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

getSkins

java.util.List getSkins()
                        throws ObjectNotFoundException,
                               javax.ejb.EJBException

Returns:

Returns the list of skins.

Throws:

ObjectNotFoundException

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

getTabs

java.util.List getTabs()
                       throws ObjectNotFoundException,
                              javax.ejb.EJBException

Returns:

Returns the list of tabs.

Throws:

ObjectNotFoundException

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