atg.svc.repository.beans
Interface SolutionFieldValue

All Superinterfaces:

javax.ejb.EJBLocalObject, atg.svc.repository.beans.SecuredItem

public interface SolutionFieldValue
extends javax.ejb.EJBLocalObject, atg.svc.repository.beans.SecuredItem

Class SolutionFieldValue

• Home: SolutionFieldValueHome
• 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	[:SolutionField.values]

Property Summaries

Property Name	Property Type	Property Description	Flags
bigString	String		R, W, Cch, Qry
boolean	boolean		R, W, Cch, Qry
date	Date		R, W, Cch, Qry
externalAudience	String[]		R, W, Cch, Mv, Qry
externalAudienceSorted	Object[]		R, Cch, Drv, Mv, Qry
fragment	TransactionalFragmentFieldValue		R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
internalAudience	String[]		R, W, Cch, Mv, Qry
internalAudienceSorted	Object[]		R, Cch, Drv, Mv, Qry
internalModify	String[]		R, W, Cch, Mv, Qry
internalModifySorted	Object[]		R, Cch, Drv, Mv, Qry
number	float		R, W, Cch, Qry
string	String		R, W, Cch, Qry
type	String		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 bigString: String

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

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 externalAudience: String[]

• Getter: getExternalAudience()
• Setter: setExternalAudience(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@1382926
• Type Name: array
• Sort String: externalaudience
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property externalAudienceSorted: Object[]

• Getter: getExternalAudienceSorted()
• Flags: readable, cacheable, derived, multivalued, queryable
• Type Name: array
• Sort String: externalaudiencesorted

Property fragment: TransactionalFragmentFieldValue

• Getter: getFragment()
• Setter: setFragment(atg.svc.repository.beans.TransactionalFragmentFieldValue)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: fragment

Property id: String

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

Property internalAudience: String[]

• Getter: getInternalAudience()
• Setter: setInternalAudience(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@158cc6
• Type Name: array
• Sort String: internalaudience
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property internalAudienceSorted: Object[]

• Getter: getInternalAudienceSorted()
• Flags: readable, cacheable, derived, multivalued, queryable
• Type Name: array
• Sort String: internalaudiencesorted

Property internalModify: String[]

• Getter: getInternalModify()
• Setter: setInternalModify(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@cd4544
• Type Name: array
• Sort String: internalmodify
• Attributes:

  Attribute Name	Attribute Value
  removeNullValues	true

Property internalModifySorted: Object[]

• Getter: getInternalModifySorted()
• Flags: readable, cacheable, derived, multivalued, queryable
• Type Name: array
• Sort String: internalmodifysorted

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: string
• Sort String: string

Property type: String

• Getter: getType()
• Setter: setType(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: type

Field Summary

Fields inherited from interface atg.svc.repository.beans.SecuredItem

CLASS_VERSION

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(SolutionFieldValue destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getBigString() Getter for property bigString
java.util.Date	getDate() Getter for property date
java.lang.String[]	getExternalAudience() Getter for property externalAudience
java.lang.Object[]	getExternalAudienceSorted() Getter for property externalAudienceSorted
atg.svc.repository.beans.FieldDefinitionType	getFieldDefinitionType()
TransactionalFragmentFieldValue	getFragment() Getter for property fragment
boolean	getHasBoolean() Returns true if the value of property boolean is null.
boolean	getHasNumber() Returns true if the value of property number is null.
boolean	getHasPersonalization()
java.lang.String	getId() Getter for property id
java.lang.String[]	getInternalAudience() Getter for property internalAudience
java.lang.Object[]	getInternalAudienceSorted() Getter for property internalAudienceSorted
java.lang.String[]	getInternalModify() Getter for property internalModify
java.lang.Object[]	getInternalModifySorted() Getter for property internalModifySorted
boolean	getIsEditable()
boolean	getIsExternallyVisibleToEveryone()
boolean	getIsExternallyVisibleToSegment(java.lang.String segmentName)
boolean	getIsVisible() Returns true if the object is visible for the current user.
float	getNumber() Getter for property number
SolutionField	getSolutionField() Gets the SolutionField parent of this SolutionFieldValue.
java.lang.String	getString() Getter for property string
java.lang.String	getType() Getter for property type
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	setBigString(java.lang.String value) Setter for property bigString .
void	setBoolean(boolean value) Setter for property boolean .
void	setDate(java.util.Date value) Setter for property date .
void	setExternalAudience(java.lang.String[] value) Setter for property externalAudience .
void	setFieldDefinitionType(atg.svc.repository.beans.FieldDefinitionType type)
void	setFragment(TransactionalFragmentFieldValue value) Setter for property fragment .
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	setInternalAudience(java.lang.String[] value) Setter for property internalAudience .
void	setInternalModify(java.lang.String[] value) Setter for property internalModify .
void	setNumber(float value) Setter for property number .
void	setString(java.lang.String value) Setter for property string .
void	setType(java.lang.String value) Setter for property type .
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

getBigString

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

Getter for property bigString

Returns:

String

Throws:

javax.ejb.EJBException

setBigString

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

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

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

getExternalAudience

java.lang.String[] getExternalAudience()
                                       throws javax.ejb.EJBException

Getter for property externalAudience

Specified by:

getExternalAudience in interface atg.svc.repository.beans.SecuredItem

Returns:

String[]

Throws:

javax.ejb.EJBException

setExternalAudience

void setExternalAudience(java.lang.String[] value)
                         throws javax.ejb.EJBException

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

Specified by:

setExternalAudience in interface atg.svc.repository.beans.SecuredItem

Parameters:

value - String[]

Throws:

javax.ejb.EJBException

getExternalAudienceSorted

java.lang.Object[] getExternalAudienceSorted()
                                             throws javax.ejb.EJBException

Getter for property externalAudienceSorted

Returns:

Object[]

Throws:

javax.ejb.EJBException

getFragment

TransactionalFragmentFieldValue getFragment()
                                            throws javax.ejb.EJBException

Getter for property fragment

Returns:

TransactionalFragmentFieldValue

Throws:

javax.ejb.EJBException

setFragment

void setFragment(TransactionalFragmentFieldValue value)
                 throws javax.ejb.EJBException

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

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

getInternalAudience

java.lang.String[] getInternalAudience()
                                       throws javax.ejb.EJBException

Getter for property internalAudience

Specified by:

getInternalAudience in interface atg.svc.repository.beans.SecuredItem

Returns:

String[]

Throws:

javax.ejb.EJBException

setInternalAudience

void setInternalAudience(java.lang.String[] value)
                         throws javax.ejb.EJBException

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

Specified by:

setInternalAudience in interface atg.svc.repository.beans.SecuredItem

Parameters:

value - String[]

Throws:

javax.ejb.EJBException

getInternalAudienceSorted

java.lang.Object[] getInternalAudienceSorted()
                                             throws javax.ejb.EJBException

Getter for property internalAudienceSorted

Returns:

Object[]

Throws:

javax.ejb.EJBException

getInternalModify

java.lang.String[] getInternalModify()
                                     throws javax.ejb.EJBException

Getter for property internalModify

Specified by:

getInternalModify in interface atg.svc.repository.beans.SecuredItem

Returns:

String[]

Throws:

javax.ejb.EJBException

setInternalModify

void setInternalModify(java.lang.String[] value)
                       throws javax.ejb.EJBException

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

Specified by:

setInternalModify in interface atg.svc.repository.beans.SecuredItem

Parameters:

value - String[]

Throws:

javax.ejb.EJBException

getInternalModifySorted

java.lang.Object[] getInternalModifySorted()
                                           throws javax.ejb.EJBException

Getter for property internalModifySorted

Returns:

Object[]

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

getType

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

Getter for property type

Returns:

String

Throws:

javax.ejb.EJBException

setType

void setType(java.lang.String 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 - 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(SolutionFieldValue 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

getFieldDefinitionType

atg.svc.repository.beans.FieldDefinitionType getFieldDefinitionType()
                                                                    throws javax.ejb.EJBException

Returns:

Gets the value data type

Throws:

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

setFieldDefinitionType

void setFieldDefinitionType(atg.svc.repository.beans.FieldDefinitionType type)
                            throws javax.ejb.EJBException

Parameters:

type - Sets the value data type

Throws:

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

getIsVisible

boolean getIsVisible()
                     throws javax.ejb.EJBException

Description copied from interface: atg.svc.repository.beans.SecuredItem

Returns true if the object is visible for the current user.

Specified by:

getIsVisible in interface atg.svc.repository.beans.SecuredItem

Returns:

Returns true if this value is visible for the current user.

Throws:

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

getIsEditable

boolean getIsEditable()
                      throws javax.ejb.EJBException

Returns:

Returns true if this value is editable for the current user.

Throws:

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

getIsExternallyVisibleToEveryone

boolean getIsExternallyVisibleToEveryone()
                                         throws javax.ejb.EJBException

Returns:

Returns true if this value is visible for everyone external.

Throws:

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

getSolutionField

SolutionField getSolutionField()
                               throws ObjectNotFoundException,
                                      javax.ejb.EJBException

Gets the SolutionField parent of this SolutionFieldValue.

Returns:

The parent SolutionField of this SolutionFieldValue.

Throws:

ObjectNotFoundException

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

getHasPersonalization

boolean getHasPersonalization()
                              throws javax.ejb.EJBException

Returns:

Returns true if the value has personalization properties specified.

Throws:

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

getIsExternallyVisibleToSegment

boolean getIsExternallyVisibleToSegment(java.lang.String segmentName)
                                        throws javax.ejb.EJBException

Parameters:

segmentName -

Returns:

Returns true if this field value is externally visible for the given segment.

Throws:

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