atg.svc.repository.beans
Interface SolutionField

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface SolutionField
extends javax.ejb.EJBLocalObject

Class SolutionField

• Home: SolutionFieldHome
• 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	[:Solution.fields]

Property Summaries

Property Name	Property Type	Property Description	Flags
id	String		R, W, Cch, Id, Qry, Req
solutionClassFieldDefinition	SolutionClassFieldDefinition		R, W, Cch, Qry
values	List of SolutionFieldValue		R, W, Cch, CoM, Mv, 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 id: String

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

Property solutionClassFieldDefinition: SolutionClassFieldDefinition

• Getter: getSolutionClassFieldDefinition()
• Setter: setSolutionClassFieldDefinition(atg.svc.repository.beans.SolutionClassFieldDefinition)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: solutionclassfielddefinition
• Attributes:

  Attribute Name	Attribute Value
  auto-checkout	false

Property values: List of SolutionFieldValue

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

  Attribute Name	Attribute Value
  removeNullValues	true

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(SolutionField destination) Copies the property values of this instance to another instance of the same data type.
SolutionFieldValue	createSolutionFieldValue()
atg.svc.repository.beans.SolutionClassFieldDefinition	getComputedSolutionClassFieldDefinition()
java.lang.String	getDisplayName() Gets the display name of the Solution Field.
java.util.List	getExternallyVisibleFieldValues() Gets the field values that are visible to everyone external.
java.lang.String	getId() Getter for property id
boolean	getIsContent()
boolean	getIsEditable()
boolean	getIsExternallyVisibleToEveryone()
boolean	getIsExternallyVisibleToSegment(java.lang.String segmentName)
boolean	getIsVisible()
java.lang.String	getName() Gets the property name of the Solution Field.
atg.svc.repository.beans.Solution	getSolution() Gets the parent Solution of this SolutionField.
atg.svc.repository.beans.SolutionClassFieldDefinition	getSolutionClassFieldDefinition() Getter for property solutionClassFieldDefinition
java.lang.Object	getValue() Gets the value of the field.
java.util.List	getValues() Getter for property values
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	setId(java.lang.String value) Setter for property id .
void	setSolutionClassFieldDefinition(atg.svc.repository.beans.SolutionClassFieldDefinition value) Setter for property solutionClassFieldDefinition .
void	setValue(java.lang.Object value) Sets the value on the field.
void	setValues(java.util.List value) Setter for property values .
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

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

getSolutionClassFieldDefinition

atg.svc.repository.beans.SolutionClassFieldDefinition getSolutionClassFieldDefinition()
                                                                                      throws javax.ejb.EJBException

Getter for property solutionClassFieldDefinition

Returns:

SolutionClassFieldDefinition

Throws:

javax.ejb.EJBException

setSolutionClassFieldDefinition

void setSolutionClassFieldDefinition(atg.svc.repository.beans.SolutionClassFieldDefinition value)
                                     throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getValues

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

Getter for property values

Returns:

List of SolutionFieldValue

Throws:

javax.ejb.EJBException

setValues

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

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

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

getComputedSolutionClassFieldDefinition

atg.svc.repository.beans.SolutionClassFieldDefinition getComputedSolutionClassFieldDefinition()
                                                                                              throws javax.ejb.EJBException

Returns:

Workaround for bug 157924 - if SolutionClassFieldDefinition is null, checks if the field definition was added back to the solution class creating a new one. Use this method instead of getSolutionClassFieldDefintion.

Throws:

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

getIsVisible

boolean getIsVisible()
                     throws javax.ejb.EJBException

Returns:

Returns true if this field is visible 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 field is visible for everyone external.

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 is externally 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

getIsContent

boolean getIsContent()
                     throws javax.ejb.EJBException

Returns:

Returns true if this field is a Content field otherwise false.

Throws:

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

setValue

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

Sets the value on the field.

Parameters:

value -

Throws:

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

getValue

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

Gets the value of the field.

Returns:

The value of the field.

Throws:

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

getSolution

atg.svc.repository.beans.Solution getSolution()
                                              throws ObjectNotFoundException,
                                                     javax.ejb.EJBException

Gets the parent Solution of this SolutionField.

Returns:

The parent Solution of this SolutionField.

Throws:

ObjectNotFoundException

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

getExternallyVisibleFieldValues

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

Gets the field values that are visible to everyone external.

Returns:

The List of SolutionFieldValue objects visible to everyone external.

Throws:

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

getDisplayName

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

Gets the display name of the Solution Field.

Returns:

A String with the display name.

Throws:

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

getName

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

Gets the property name of the Solution Field.

Returns:

A String with the property name.

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 SolutionField as the metadata

Throws:

javax.ejb.CreateException

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