atg.svc.repository.beans
Interface FieldDefinition

All Superinterfaces:

javax.ejb.EJBLocalObject, SecuredItem

All Known Subinterfaces:

BooleanFieldDefinition, DateFieldDefinition, DecimalFieldDefinition, ListFieldDefinition, NumberFieldDefinition, OrganizationFieldDefinition, StatementFieldDefinition, TextFieldDefinition, TransactionalFragmentFieldDefinition, UserFieldDefinition

All Known Implementing Classes:

_BooleanFieldDefinition_BeanImpl, _BooleanFieldDefinition_Impl, _BooleanFieldDefinition_ReposImpl, _DateFieldDefinition_BeanImpl, _DateFieldDefinition_Impl, _DateFieldDefinition_ReposImpl, _DecimalFieldDefinition_BeanImpl, _DecimalFieldDefinition_Impl, _DecimalFieldDefinition_ReposImpl, _FieldDefinition_BeanImpl, _FieldDefinition_Impl, _FieldDefinition_ReposImpl, _ListFieldDefinition_BeanImpl, _ListFieldDefinition_Impl, _ListFieldDefinition_ReposImpl, _NumberFieldDefinition_BeanImpl, _NumberFieldDefinition_Impl, _NumberFieldDefinition_ReposImpl, _OrganizationFieldDefinition_BeanImpl, _OrganizationFieldDefinition_Impl, _OrganizationFieldDefinition_ReposImpl, _StatementFieldDefinition_BeanImpl, _StatementFieldDefinition_Impl, _StatementFieldDefinition_ReposImpl, _TextFieldDefinition_BeanImpl, _TextFieldDefinition_Impl, _TextFieldDefinition_ReposImpl, _TransactionalFragmentFieldDefinition_BeanImpl, _TransactionalFragmentFieldDefinition_Impl, _TransactionalFragmentFieldDefinition_ReposImpl, _UserFieldDefinition_BeanImpl, _UserFieldDefinition_Impl, _UserFieldDefinition_ReposImpl

public interface FieldDefinition
extends javax.ejb.EJBLocalObject, SecuredItem

Class FieldDefinition

• Home: FieldDefinitionHome
• 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	[:SolutionClassFieldDefinition.fieldDefinition, :DefaultFieldValue.fieldDefinition]

Property Summaries

Property Name	Property Type	Property Description	Flags
default	boolean	Set to true if the field instance should set default values from the definition on create.	R, W, Cch, Qry
displayName	String	Name displayed in UI to users	R, W, Cch, Qry, Req
editor	FieldDefinitionEditor		R, W, Cch, Qry, Req
externalAudience	String[]		R, W, Cch, Mv, Qry
externalAudienceSorted	Object[]		R, Cch, Drv, Mv, Qry
id	String		R, W, Cch, Id, Qry, Req
indexing	FieldDefinitionIndexing		R, W, Cch, 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
multiValued	boolean	Set to true if the field instance can hold multiple values	R, W, Cch, Qry, Req
name	String	Immutable logical name of the field definition	R, W, Cch, Qry, Req
purpose	FieldDefinitionPurpose		R, W, Cch, Qry, Req
required	boolean	Set to true if the field instance should not allow null values	R, W, Cch, Qry, Req
type	FieldDefinitionType		R, W, Cch, Qry, Req
usage	FieldDefinitionUsage		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 default: boolean

Set to true if the field instance should set default values from the definition on create.
• Getter: isDefault()
• Setter: setDefault(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: default

Property displayName: String

Name displayed in UI to users
• Getter: getDisplayName()
• Setter: setDisplayName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: displayname

Property editor: FieldDefinitionEditor

• Getter: getEditor()
• Setter: setEditor(atg.svc.repository.beans.FieldDefinitionEditor)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: editor
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property externalAudience: String[]

• Getter: getExternalAudience()
• Setter: setExternalAudience(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@1148603
• 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 id: String

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

Property indexing: FieldDefinitionIndexing

• Getter: getIndexing()
• Setter: setIndexing(atg.svc.repository.beans.FieldDefinitionIndexing)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: indexing
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property internalAudience: String[]

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

  Attribute Name	Attribute Value
  deployable	false
  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;@bfed5a
• Type Name: array
• Sort String: internalmodify
• Attributes:

  Attribute Name	Attribute Value
  deployable	false
  removeNullValues	true

Property internalModifySorted: Object[]

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

Property multiValued: boolean

Set to true if the field instance can hold multiple values
• Getter: isMultiValued()
• Setter: setMultiValued(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: multivalued

Property name: String

Immutable logical name of the field definition
• Getter: getName()
• Setter: setName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: name

Property purpose: FieldDefinitionPurpose

• Getter: getPurpose()
• Setter: setPurpose(atg.svc.repository.beans.FieldDefinitionPurpose)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: purpose
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property required: boolean

Set to true if the field instance should not allow null values
• Getter: isRequired()
• Setter: setRequired(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: required

Property type: FieldDefinitionType

• Getter: getType()
• Setter: setType(atg.svc.repository.beans.FieldDefinitionType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: type
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property usage: FieldDefinitionUsage

• Getter: getUsage()
• Setter: setUsage(atg.svc.repository.beans.FieldDefinitionUsage)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: usage
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

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(FieldDefinition destination) Copies the property values of this instance to another instance of the same data type.
SolutionFieldValue	createSolutionFieldValue()
java.util.List	getDefaultValues()
java.lang.String	getDisplayName() Getter for property displayName
FieldDefinitionEditor	getEditor() Getter for property editor
java.lang.String[]	getExternalAudience() Getter for property externalAudience
java.lang.Object[]	getExternalAudienceSorted() Getter for property externalAudienceSorted
boolean	getHasDefault() Returns true if the value of property default is null.
java.lang.String	getId() Getter for property id
FieldDefinitionIndexing	getIndexing() Getter for property indexing
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	getIsExternallyVisible()
boolean	getIsExternallyVisible(java.lang.String segmentName)
boolean	getIsInternalOnly()
boolean	getIsMultiValued()
boolean	getIsVisible() Returns true if the object is visible for the current user.
java.lang.String	getName() Getter for property name
FieldDefinitionPurpose	getPurpose() Getter for property purpose
FieldDefinitionType	getType() Getter for property type
FieldDefinitionUsage	getUsage() Getter for property usage
boolean	isDefault() Getter for property default
boolean	isMultiValued() Getter for property multiValued
boolean	isRemoved() Returns true if the underlying object has been removed.
boolean	isRequired() Getter for property required
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	setDefault(boolean value) Setter for property default .
void	setDefaultValues(java.util.List value)
void	setDisplayName(java.lang.String value) Setter for property displayName .
void	setEditor(FieldDefinitionEditor value) Setter for property editor .
void	setExternalAudience(java.lang.String[] value) Setter for property externalAudience .
void	setHasDefault(boolean value) If this is set to false, then the underlying value of property default is set to null.
void	setId(java.lang.String value) Setter for property id .
void	setIndexing(FieldDefinitionIndexing value) Setter for property indexing .
void	setInternalAudience(java.lang.String[] value) Setter for property internalAudience .
void	setInternalModify(java.lang.String[] value) Setter for property internalModify .
void	setMultiValued(boolean value) Setter for property multiValued .
void	setName(java.lang.String value) Setter for property name .
void	setPurpose(FieldDefinitionPurpose value) Setter for property purpose .
void	setRequired(boolean value) Setter for property required .
void	setType(FieldDefinitionType value) Setter for property type .
void	setUsage(FieldDefinitionUsage value) Setter for property usage .
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

isDefault

boolean isDefault()
                  throws javax.ejb.EJBException

Getter for property default

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasDefault

boolean getHasDefault()
                      throws javax.ejb.EJBException

Returns true if the value of property default is null.

Throws:

javax.ejb.EJBException

setDefault

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

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

setHasDefault

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

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

Throws:

javax.ejb.EJBException

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

getEditor

FieldDefinitionEditor getEditor()
                                throws javax.ejb.EJBException

Getter for property editor

Returns:

FieldDefinitionEditor

Throws:

javax.ejb.EJBException

setEditor

void setEditor(FieldDefinitionEditor value)
               throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getExternalAudience

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

Getter for property externalAudience

Specified by:

getExternalAudience in interface 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 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

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

getIndexing

FieldDefinitionIndexing getIndexing()
                                    throws javax.ejb.EJBException

Getter for property indexing

Returns:

FieldDefinitionIndexing

Throws:

javax.ejb.EJBException

setIndexing

void setIndexing(FieldDefinitionIndexing value)
                 throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getInternalAudience

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

Getter for property internalAudience

Specified by:

getInternalAudience in interface 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 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 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 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

isMultiValued

boolean isMultiValued()
                      throws javax.ejb.EJBException

Getter for property multiValued

Returns:

boolean

Throws:

javax.ejb.EJBException

setMultiValued

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

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

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

getPurpose

FieldDefinitionPurpose getPurpose()
                                  throws javax.ejb.EJBException

Getter for property purpose

Returns:

FieldDefinitionPurpose

Throws:

javax.ejb.EJBException

setPurpose

void setPurpose(FieldDefinitionPurpose value)
                throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

isRequired

boolean isRequired()
                   throws javax.ejb.EJBException

Getter for property required

Returns:

boolean

Throws:

javax.ejb.EJBException

setRequired

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

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

getType

FieldDefinitionType getType()
                            throws javax.ejb.EJBException

Getter for property type

Returns:

FieldDefinitionType

Throws:

javax.ejb.EJBException

setType

void setType(FieldDefinitionType 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 - FieldDefinitionType

Throws:

javax.ejb.EJBException

getUsage

FieldDefinitionUsage getUsage()
                              throws javax.ejb.EJBException

Getter for property usage

Returns:

FieldDefinitionUsage

Throws:

javax.ejb.EJBException

setUsage

void setUsage(FieldDefinitionUsage value)
              throws javax.ejb.EJBException

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

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

getIsMultiValued

boolean getIsMultiValued()
                         throws javax.ejb.EJBException

Returns:

Returns true if the field definition is multi-valued

Throws:

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

getIsVisible

boolean getIsVisible()
                     throws javax.ejb.EJBException

Description copied from interface: SecuredItem

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

Specified by:

getIsVisible in interface SecuredItem

Returns:

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

Throws:

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

getIsExternallyVisible

boolean getIsExternallyVisible()
                               throws javax.ejb.EJBException

Returns:

Returns true if this field is visible for everyone external.

Throws:

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

getIsExternallyVisible

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

Parameters:

segmentName -

Returns:

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

Throws:

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

getIsEditable

boolean getIsEditable()
                      throws javax.ejb.EJBException

Returns:

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

Throws:

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

getIsInternalOnly

boolean getIsInternalOnly()
                          throws javax.ejb.EJBException

Returns:

Returns true if this field is for internal use only.

Throws:

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

createSolutionFieldValue

SolutionFieldValue createSolutionFieldValue()
                                            throws javax.ejb.CreateException,
                                                   javax.ejb.EJBException

Returns:

Creates and returns a new SolutionFieldValue with this FieldDefinition as the metadata

Throws:

javax.ejb.CreateException

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

setDefaultValues

void setDefaultValues(java.util.List value)
                      throws javax.ejb.CreateException,
                             javax.ejb.FinderException,
                             PersistenceException,
                             javax.ejb.RemoveException,
                             javax.ejb.EJBException

Parameters:

value -

Throws:

javax.ejb.CreateException

javax.ejb.FinderException

PersistenceException

javax.ejb.RemoveException

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

getDefaultValues

java.util.List getDefaultValues()
                                throws javax.ejb.FinderException,
                                       javax.ejb.EJBException

Returns:

Gets the default values for this field definition in the correct display order

Throws:

javax.ejb.FinderException

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