atg.svc.repository.beans
Interface DefaultFieldValue

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_DefaultFieldValue_BeanImpl, _DefaultFieldValue_Impl, _DefaultFieldValue_ReposImpl

public interface DefaultFieldValue
extends javax.ejb.EJBLocalObject

Class DefaultFieldValue

• Home: DefaultFieldValueHome
• 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
boolean	boolean		R, W, Cch, Qry
date	Date		R, W, Cch, Qry
displayOrder	int		R, W, Cch, Qry, Req
fieldDefinition	FieldDefinition		R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
number	float		R, W, Cch, Qry
string	String		R, W, Cch, 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 boolean: boolean

• Getter: isBoolean()
• Setter: setBoolean(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: boolean

Property date: Date

• Getter: getDate()
• Setter: setDate(java.util.Date)
• Flags: readable, writable, cacheable, queryable
• Type Name: date
• Sort String: date

Property displayOrder: int

• Getter: getDisplayOrder()
• Setter: setDisplayOrder(int)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: int
• Sort String: displayorder

Property fieldDefinition: FieldDefinition

• Getter: getFieldDefinition()
• Setter: setFieldDefinition(atg.svc.repository.beans.FieldDefinition)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: fielddefinition

Property id: String

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

Property number: float

• Getter: getNumber()
• Setter: setNumber(float)
• Flags: readable, writable, cacheable, queryable
• Type Name: float
• Sort String: number

Property string: String

• Getter: getString()
• Setter: setString(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: big string
• Sort String: string

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(DefaultFieldValue destination) Copies the property values of this instance to another instance of the same data type.
java.util.Date	getDate() Getter for property date
int	getDisplayOrder() Getter for property displayOrder
FieldDefinition	getFieldDefinition() Getter for property fieldDefinition
boolean	getHasBoolean() Returns true if the value of property boolean is null.
boolean	getHasNumber() Returns true if the value of property number is null.
java.lang.String	getId() Getter for property id
float	getNumber() Getter for property number
java.lang.String	getString() Getter for property string
java.lang.Object	getValue()
boolean	isBoolean() Getter for property boolean
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	setBoolean(boolean value) Setter for property boolean .
void	setDate(java.util.Date value) Setter for property date .
void	setDisplayOrder(int value) Setter for property displayOrder .
void	setFieldDefinition(FieldDefinition value) Setter for property fieldDefinition .
void	setHasBoolean(boolean value) If this is set to false, then the underlying value of property boolean is set to null.
void	setHasNumber(boolean value) If this is set to false, then the underlying value of property number is set to null.
void	setId(java.lang.String value) Setter for property id .
void	setNumber(float value) Setter for property number .
void	setString(java.lang.String value) Setter for property string .
void	setValue(java.lang.Object 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

isBoolean

boolean isBoolean()
                  throws javax.ejb.EJBException

Getter for property boolean

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasBoolean

boolean getHasBoolean()
                      throws javax.ejb.EJBException

Returns true if the value of property boolean is null.

Throws:

javax.ejb.EJBException

setBoolean

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

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

setHasBoolean

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

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

Throws:

javax.ejb.EJBException

getDate

java.util.Date getDate()
                       throws javax.ejb.EJBException

Getter for property date

Returns:

Date

Throws:

javax.ejb.EJBException

setDate

void setDate(java.util.Date value)
             throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getDisplayOrder

int getDisplayOrder()
                    throws javax.ejb.EJBException

Getter for property displayOrder

Returns:

int

Throws:

javax.ejb.EJBException

setDisplayOrder

void setDisplayOrder(int value)
                     throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getFieldDefinition

FieldDefinition getFieldDefinition()
                                   throws javax.ejb.EJBException

Getter for property fieldDefinition

Returns:

FieldDefinition

Throws:

javax.ejb.EJBException

setFieldDefinition

void setFieldDefinition(FieldDefinition value)
                        throws javax.ejb.EJBException

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

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

getNumber

float getNumber()
                throws javax.ejb.EJBException

Getter for property number

Returns:

float

Throws:

javax.ejb.EJBException

getHasNumber

boolean getHasNumber()
                     throws javax.ejb.EJBException

Returns true if the value of property number is null.

Throws:

javax.ejb.EJBException

setNumber

void setNumber(float value)
               throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

setHasNumber

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

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

Throws:

javax.ejb.EJBException

getString

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

Getter for property string

Returns:

String

Throws:

javax.ejb.EJBException

setString

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

Setter for property string . 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(DefaultFieldValue 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.

getValue

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

Returns:

Returns the value or null if there is no value.

Throws:

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

setValue

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

Parameters:

value - Sets the value

Throws:

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