atg.svc.repository.beans
Interface ConfigurationObject

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Subinterfaces:

CellConfig, ContentConfig, FrameworkConfig, PanelConfig, PanelStackConfig, SkinConfig, TabConfig, TemplateConfig

All Known Implementing Classes:

_CellConfig_BeanImpl, _CellConfig_Impl, _CellConfig_ReposImpl, _ConfigurationObject_BeanImpl, _ConfigurationObject_Impl, _ConfigurationObject_ReposImpl, _ContentConfig_BeanImpl, _ContentConfig_Impl, _ContentConfig_ReposImpl, _FrameworkConfig_BeanImpl, _FrameworkConfig_Impl, _FrameworkConfig_ReposImpl, _PanelConfig_BeanImpl, _PanelConfig_Impl, _PanelConfig_ReposImpl, _PanelStackConfig_BeanImpl, _PanelStackConfig_Impl, _PanelStackConfig_ReposImpl, _SkinConfig_BeanImpl, _SkinConfig_Impl, _SkinConfig_ReposImpl, _TabConfig_BeanImpl, _TabConfig_Impl, _TabConfig_ReposImpl, _TemplateConfig_BeanImpl, _TemplateConfig_Impl, _TemplateConfig_ReposImpl

public interface ConfigurationObject
extends javax.ejb.EJBLocalObject

Class ConfigurationObject

• Home: ConfigurationObjectHome
• 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
configType	ConfigurationObjectConfigType		R, W, Cch, Qry, Req
enabledYn	boolean		R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
userId	String		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 configType: ConfigurationObjectConfigType

• Getter: getConfigType()
• Setter: setConfigType(atg.svc.repository.beans.ConfigurationObjectConfigType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: configtype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property enabledYn: boolean

• Getter: isEnabledYn()
• Setter: setEnabledYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• 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 userId: String

• Getter: getUserId()
• Setter: setUserId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: userid

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(ConfigurationObject destination) Copies the property values of this instance to another instance of the same data type.
ConfigurationObjectConfigType	getConfigType() Getter for property configType
java.lang.String	getId() Getter for property id
java.lang.String	getUserId() Getter for property userId
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	setConfigType(ConfigurationObjectConfigType value) Setter for property configType .
void	setEnabledYn(boolean value) Setter for property enabledYn .
void	setId(java.lang.String value) Setter for property id .
void	setUserId(java.lang.String value) Setter for property userId .
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

getConfigType

ConfigurationObjectConfigType getConfigType()
                                            throws javax.ejb.EJBException

Getter for property configType

Returns:

ConfigurationObjectConfigType

Throws:

javax.ejb.EJBException

setConfigType

void setConfigType(ConfigurationObjectConfigType value)
                   throws javax.ejb.EJBException

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

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

getUserId

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

Getter for property userId

Returns:

String

Throws:

javax.ejb.EJBException

setUserId

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

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

Throws:

javax.ejb.EJBException

copyTo

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