atg.svc.repository.beans
Interface TransactionalFragmentParameterListValue

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface TransactionalFragmentParameterListValue
extends javax.ejb.EJBLocalObject

Class TransactionalFragmentParameterListValue

• Home: TransactionalFragmentParameterListValueHome
• 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	[:TransactionalFragmentParameter.listValues]

Property Summaries

Property Name	Property Type	Property Description	Flags
displayName	String	Name of the value used for display in the list	R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
value	String	Actual value that gets saved in the parameter	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 displayName: String

Name of the value used for display in the list
• Getter: getDisplayName()
• Setter: setDisplayName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: displayname

Property id: String

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

Property value: String

Actual value that gets saved in the parameter
• Getter: getValue()
• Setter: setValue(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: value

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(TransactionalFragmentParameterListValue destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getDisplayName() Getter for property displayName
java.lang.String	getId() Getter for property id
java.lang.String	getValue() Getter for property value
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	setDisplayName(java.lang.String value) Setter for property displayName .
void	setId(java.lang.String value) Setter for property id .
void	setValue(java.lang.String value) Setter for property value .
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

getDisplayName

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

Getter for property displayName

Returns:

String

Throws:

javax.ejb.EJBException

setDisplayName

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

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

getValue

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

Getter for property value

Returns:

String

Throws:

javax.ejb.EJBException

setValue

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

Setter for property value . 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(TransactionalFragmentParameterListValue 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.