atg.svc.repository.beans
Interface FrameworkInstance

All Superinterfaces:

javax.ejb.EJBLocalObject, InstanceObject

All Known Implementing Classes:

_FrameworkInstance_BeanImpl, _FrameworkInstance_Impl, _FrameworkInstance_ReposImpl

public interface FrameworkInstance
extends javax.ejb.EJBLocalObject, InstanceObject

Class FrameworkInstance

• Home: FrameworkInstanceHome
• 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
currentTabId	String		R, W, Cch, Qry
enabledYn	boolean		R, W, Cch, Qry, Req
frameworkId	String		R, W, Cch, Qry, Req
instanceType	InstanceObjectInstanceType		R, W, Cch, Qry, Req
previousTabId	String		R, W, Cch, Qry
tabIds	List		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 currentTabId: String

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

Property enabledYn: boolean

• Getter: InstanceObject.isEnabledYn()
• Setter: InstanceObject.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 instanceType: InstanceObjectInstanceType

• Getter: InstanceObject.getInstanceType()
• Setter: InstanceObject.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

Property previousTabId: String

• Getter: getPreviousTabId()
• Setter: setPreviousTabId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: previoustabid

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

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(FrameworkInstance 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	getPreviousTabId() Getter for property previousTabId
java.util.List	getTabIds() Getter for property tabIds
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	setPreviousTabId(java.lang.String value) Setter for property previousTabId .
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.InstanceObject

copyTo, getInstanceType, isEnabledYn, setEnabledYn, setInstanceType

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

getPreviousTabId

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

Getter for property previousTabId

Returns:

String

Throws:

javax.ejb.EJBException

setPreviousTabId

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

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

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 InstanceObject

Throws:

javax.ejb.EJBException

copyTo

void copyTo(FrameworkInstance 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 InstanceObject

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 InstanceObject

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 InstanceObject