atg.svc.repository.beans
Interface SolutionClassFieldDefinition

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_SolutionClassFieldDefinition_BeanImpl, _SolutionClassFieldDefinition_Impl, _SolutionClassFieldDefinition_ReposImpl

public interface SolutionClassFieldDefinition
extends javax.ejb.EJBLocalObject

Class SolutionClassFieldDefinition

• Home: SolutionClassFieldDefinitionHome
• 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.solutionClassFieldDefinition, :SolutionClass.fields]

Property Summaries

Property Name	Property Type	Property Description	Flags
displayName	String		R, W, Cch, Qry, Req
fieldDefinition	FieldDefinition		R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
indexingValue	String		R, W, Cch, Qry
required	boolean		R, W, Cch, Qry
searchWeight	int		R, W, Cch, Qry
title	boolean		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

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

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
• Attributes:

  Attribute Name	Attribute Value
  propertyCategory	primary

Property indexingValue: String

• Getter: getIndexingValue()
• Setter: setIndexingValue(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: indexingvalue

Property required: boolean

• Getter: isRequired()
• Setter: setRequired(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: required

Property searchWeight: int

• Getter: getSearchWeight()
• Setter: setSearchWeight(int)
• Flags: readable, writable, cacheable, queryable
• Type Name: int
• Sort String: searchweight

Property title: boolean

• Getter: isTitle()
• Setter: setTitle(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: title

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(SolutionClassFieldDefinition destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getComputedDisplayName() Gets the computed display name of the solution class field definition.
java.lang.String	getDisplayName() Getter for property displayName
FieldDefinition	getFieldDefinition() Getter for property fieldDefinition
boolean	getHasRequired() Returns true if the value of property required is null.
boolean	getHasSearchWeight() Returns true if the value of property searchWeight is null.
java.lang.String	getId() Getter for property id
FieldDefinitionIndexing	getIndexing() Gets the indexing type on the SolutionClassFieldDefinition
java.lang.String	getIndexingValue() Getter for property indexingValue
boolean	getIsConstrainable() Returns true if the SolutionClass field is constrainable.
boolean	getIsContent() Returns true if the field definition is a content field otherwise false.
boolean	getIsRequired() Returns true if the field is required to be non-blank on save.
boolean	getIsSearchable() Returns true if the SolutionClass field is searchable.
int	getOrder() Get the order for this solution class defn in its solution class
int	getSearchWeight() Getter for property searchWeight
SolutionClass	getSolutionClass() Get the SolutionClass for this solution class defn.
boolean	isRemoved() Returns true if the underlying object has been removed.
boolean	isRequired() Getter for property required
boolean	isTitle() Getter for property title
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	setFieldDefinition(FieldDefinition value) Setter for property fieldDefinition .
void	setFieldDefinition(java.lang.String fieldDefinitionId) Set the FieldDefinition by the repository id.
void	setHasRequired(boolean value) If this is set to false, then the underlying value of property required is set to null.
void	setHasSearchWeight(boolean value) If this is set to false, then the underlying value of property searchWeight is set to null.
void	setId(java.lang.String value) Setter for property id .
void	setIndexing(FieldDefinitionIndexing indexing) Sets the indexing type on the SolutionClassFieldDefinition
void	setIndexingValue(java.lang.String value) Setter for property indexingValue .
void	setRequired(boolean value) Setter for property required .
void	setSearchWeight(int value) Setter for property searchWeight .
void	setTitle(boolean value) Setter for property title .
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

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

getIndexingValue

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

Getter for property indexingValue

Returns:

String

Throws:

javax.ejb.EJBException

setIndexingValue

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

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

isRequired

boolean isRequired()
                   throws javax.ejb.EJBException

Getter for property required

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasRequired

boolean getHasRequired()
                       throws javax.ejb.EJBException

Returns true if the value of property required is null.

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

setHasRequired

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

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

Throws:

javax.ejb.EJBException

getSearchWeight

int getSearchWeight()
                    throws javax.ejb.EJBException

Getter for property searchWeight

Returns:

int

Throws:

javax.ejb.EJBException

getHasSearchWeight

boolean getHasSearchWeight()
                           throws javax.ejb.EJBException

Returns true if the value of property searchWeight is null.

Throws:

javax.ejb.EJBException

setSearchWeight

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

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

setHasSearchWeight

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

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

Throws:

javax.ejb.EJBException

isTitle

boolean isTitle()
                throws javax.ejb.EJBException

Getter for property title

Returns:

boolean

Throws:

javax.ejb.EJBException

setTitle

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

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

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

setFieldDefinition

void setFieldDefinition(java.lang.String fieldDefinitionId)
                        throws ObjectNotFoundException,
                               javax.ejb.EJBException

Set the FieldDefinition by the repository id.

Parameters:

fieldDefinitionId -

Throws:

ObjectNotFoundException

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

getOrder

int getOrder()
             throws ObjectNotFoundException,
                    javax.ejb.EJBException

Get the order for this solution class defn in its solution class

Returns:

The order in the fields list of the associated solution class.

Throws:

ObjectNotFoundException

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

getSolutionClass

SolutionClass getSolutionClass()
                               throws ObjectNotFoundException,
                                      javax.ejb.EJBException

Get the SolutionClass for this solution class defn.

Returns:

The associated solution class.

Throws:

ObjectNotFoundException

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

getIsContent

boolean getIsContent()
                     throws javax.ejb.EJBException

Returns true if the field definition is a content field otherwise false.

Returns:

True if the field definition is a content field otherwise false.

Throws:

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

getComputedDisplayName

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

Gets the computed display name of the solution class field definition.

Returns:

A String with the display name.

Throws:

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

getIsRequired

boolean getIsRequired()
                      throws javax.ejb.EJBException

Returns true if the field is required to be non-blank on save.

Returns:

True if the field is required else false.

Throws:

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

getIndexing

FieldDefinitionIndexing getIndexing()
                                    throws javax.ejb.EJBException

Gets the indexing type on the SolutionClassFieldDefinition

Returns:

The indexing enum value.

Throws:

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

setIndexing

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

Sets the indexing type on the SolutionClassFieldDefinition

Parameters:

indexing -

Throws:

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

getIsSearchable

boolean getIsSearchable()
                        throws javax.ejb.EJBException

Returns true if the SolutionClass field is searchable.

Returns:

True if the SolutionClass field is searchable.

Throws:

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

getIsConstrainable

boolean getIsConstrainable()
                           throws javax.ejb.EJBException

Returns true if the SolutionClass field is constrainable.

Returns:

True if the SolutionClass field is constrainable.

Throws:

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