atg.svc.repository.beans
Interface InstanceObject

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Subinterfaces:

CellInstance, ContentInstance, FrameworkInstance, PanelInstance, PanelStackInstance, PanelTargetElement, SkinInstance, TabInstance, TemplateInstance

All Known Implementing Classes:

_CellInstance_BeanImpl, _CellInstance_Impl, _CellInstance_ReposImpl, _ContentInstance_BeanImpl, _ContentInstance_Impl, _ContentInstance_ReposImpl, _FrameworkInstance_BeanImpl, _FrameworkInstance_Impl, _FrameworkInstance_ReposImpl, _InstanceObject_BeanImpl, _InstanceObject_Impl, _InstanceObject_ReposImpl, _PanelInstance_BeanImpl, _PanelInstance_Impl, _PanelInstance_ReposImpl, _PanelStackInstance_BeanImpl, _PanelStackInstance_Impl, _PanelStackInstance_ReposImpl, _PanelTargetElement_BeanImpl, _PanelTargetElement_Impl, _PanelTargetElement_ReposImpl, _SkinInstance_BeanImpl, _SkinInstance_Impl, _SkinInstance_ReposImpl, _TabInstance_BeanImpl, _TabInstance_Impl, _TabInstance_ReposImpl, _TemplateInstance_BeanImpl, _TemplateInstance_Impl, _TemplateInstance_ReposImpl

public interface InstanceObject
extends javax.ejb.EJBLocalObject

Class InstanceObject

• Home: InstanceObjectHome
• 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
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 enabledYn: boolean

• Getter: isEnabledYn()
• Setter: setEnabledYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: true
• Type Name: boolean
• Sort String: enabledyn

Property instanceType: InstanceObjectInstanceType

• Getter: getInstanceType()
• Setter: 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(InstanceObject destination) Copies the property values of this instance to another instance of the same data type.
InstanceObjectInstanceType	getInstanceType() Getter for property instanceType
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	setEnabledYn(boolean value) Setter for property enabledYn .
void	setInstanceType(InstanceObjectInstanceType value) Setter for property instanceType .
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

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

getInstanceType

InstanceObjectInstanceType getInstanceType()
                                           throws javax.ejb.EJBException

Getter for property instanceType

Returns:

InstanceObjectInstanceType

Throws:

javax.ejb.EJBException

setInstanceType

void setInstanceType(InstanceObjectInstanceType value)
                     throws javax.ejb.EJBException

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

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(InstanceObject 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.