atg.svc.repository.beans
Interface TransactionalFragmentFieldValue

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface TransactionalFragmentFieldValue
extends javax.ejb.EJBLocalObject

Class TransactionalFragmentFieldValue

• Home: TransactionalFragmentFieldValueHome
• 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	[:SolutionFieldValue.fragment]

Property Summaries

Property Name	Property Type	Property Description	Flags
fragmentPath	String		R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
parameters	Set of TransactionalFragmentParameterValue		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 fragmentPath: String

• Getter: getFragmentPath()
• Setter: setFragmentPath(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: fragmentpath

Property id: String

• Getter: getId()
• Setter: setId(java.lang.String)
• Flags: readable, writable, cacheable, idProperty, queryable, required
• Type Name: string
• Sort String: id

Property parameters: Set of TransactionalFragmentParameterValue

• Getter: getParameters()
• Setter: setParameters(java.util.Set)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: set
• Sort String: parameters
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(TransactionalFragmentFieldValue destination) Copies the property values of this instance to another instance of the same data type.
TransactionalFragment	getFragment()
java.lang.String	getFragmentPath() Getter for property fragmentPath
java.lang.String	getId() Getter for property id
java.util.Set	getParameters() Getter for property parameters
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	setFragmentPath(java.lang.String value) Setter for property fragmentPath .
void	setId(java.lang.String value) Setter for property id .
void	setParameters(java.util.Set value) Setter for property parameters .
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

getFragmentPath

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

Getter for property fragmentPath

Returns:

String

Throws:

javax.ejb.EJBException

setFragmentPath

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

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

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

getParameters

java.util.Set getParameters()
                            throws javax.ejb.EJBException

Getter for property parameters

Returns:

Set of TransactionalFragmentParameterValue

Throws:

javax.ejb.EJBException

setParameters

void setParameters(java.util.Set value)
                   throws javax.ejb.EJBException

Setter for property parameters . 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 - Set of TransactionalFragmentParameterValue

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

getFragment

TransactionalFragment getFragment()
                                  throws javax.ejb.EJBException

Returns:

Returns the transactional fragment component associated with this field value.

Throws:

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