atg.svc.repository.beans
Interface TransactionalFragmentParameter

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface TransactionalFragmentParameter
extends javax.ejb.EJBLocalObject

Class TransactionalFragmentParameter

• Home: TransactionalFragmentParameterHome
• 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
defaultValue	String	Default value for parameter	R, W, Cch, Qry
hidden	boolean	True if the parameter should be hidden from the solution author.	R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
label	String	Label to show before parameter input field	R, W, Cch, Qry, Req
listValues	List of TransactionalFragmentParameterListValue		R, W, Cch, CoM, Mv, Qry
name	String	Name of parameter that will be passed to fragment view	R, W, Cch, Qry, Req
type	TransactionalFragmentParameterType	Defines how parameter input should be validated however all values are saved as strings	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 defaultValue: String

Default value for parameter
• Getter: getDefaultValue()
• Setter: setDefaultValue(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: defaultvalue

Property hidden: boolean

True if the parameter should be hidden from the solution author.
• Getter: isHidden()
• Setter: setHidden(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: hidden

Property id: String

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

Property label: String

Label to show before parameter input field
• Getter: getLabel()
• Setter: setLabel(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: label

Property listValues: List of TransactionalFragmentParameterListValue

• Getter: getListValues()
• Setter: setListValues(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: listvalues
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property name: String

Name of parameter that will be passed to fragment view
• Getter: getName()
• Setter: setName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: name

Property type: TransactionalFragmentParameterType

Defines how parameter input should be validated however all values are saved as strings
• Getter: getType()
• Setter: setType(atg.svc.repository.beans.TransactionalFragmentParameterType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: type
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(TransactionalFragmentParameter destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getDefaultValue() Getter for property defaultValue
boolean	getHasHidden() Returns true if the value of property hidden is null.
java.lang.String	getId() Getter for property id
java.lang.String	getLabel() Getter for property label
java.util.List	getListValues() Getter for property listValues
java.lang.String	getName() Getter for property name
TransactionalFragmentParameterType	getType() Getter for property type
boolean	isHidden() Getter for property hidden
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	setDefaultValue(java.lang.String value) Setter for property defaultValue .
void	setHasHidden(boolean value) If this is set to false, then the underlying value of property hidden is set to null.
void	setHidden(boolean value) Setter for property hidden .
void	setId(java.lang.String value) Setter for property id .
void	setLabel(java.lang.String value) Setter for property label .
void	setListValues(java.util.List value) Setter for property listValues .
void	setName(java.lang.String value) Setter for property name .
void	setType(TransactionalFragmentParameterType value) Setter for property type .
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

getDefaultValue

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

Getter for property defaultValue

Returns:

String

Throws:

javax.ejb.EJBException

setDefaultValue

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

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

isHidden

boolean isHidden()
                 throws javax.ejb.EJBException

Getter for property hidden

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasHidden

boolean getHasHidden()
                     throws javax.ejb.EJBException

Returns true if the value of property hidden is null.

Throws:

javax.ejb.EJBException

setHidden

void setHidden(boolean value)
               throws javax.ejb.EJBException

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

setHasHidden

void setHasHidden(boolean value)
                  throws javax.ejb.EJBException

If this is set to false, then the underlying value of property hidden is set to null. If set to true, then nothing is done.

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

getLabel

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

Getter for property label

Returns:

String

Throws:

javax.ejb.EJBException

setLabel

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

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

getListValues

java.util.List getListValues()
                             throws javax.ejb.EJBException

Getter for property listValues

Returns:

List of TransactionalFragmentParameterListValue

Throws:

javax.ejb.EJBException

setListValues

void setListValues(java.util.List value)
                   throws javax.ejb.EJBException

Setter for property listValues . 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 of TransactionalFragmentParameterListValue

Throws:

javax.ejb.EJBException

getName

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

Getter for property name

Returns:

String

Throws:

javax.ejb.EJBException

setName

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

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

getType

TransactionalFragmentParameterType getType()
                                           throws javax.ejb.EJBException

Getter for property type

Returns:

TransactionalFragmentParameterType

Throws:

javax.ejb.EJBException

setType

void setType(TransactionalFragmentParameterType value)
             throws javax.ejb.EJBException

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

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