atg.svc.repository.beans.methods
Class SolutionClassFieldDefinitionMethods

java.lang.Object
  atg.svc.repository.beans.methods.SolutionClassFieldDefinitionMethods

public class SolutionClassFieldDefinitionMethods
extends java.lang.Object

Defines extension methods for the SolutionClassFieldDefinition object.

Version:

$Id: //application/service/version/2007.3/common/src/classes/atg/svc/repository/beans/methods/SolutionClassFieldDefinitionMethods.java#2 $$Change: 632007 $

Author:

dkenyon

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

SolutionClassFieldDefinitionMethods()

Method Summary

java.lang.String	getComputedDisplayName(SolutionClassFieldDefinition pSolutionClassFieldDefinition) Deprecated. Use display name instead.
FieldDefinitionIndexing	getIndexing(SolutionClassFieldDefinition pSolutionClassFieldDefinition) Gets the type of indexing defined on this field.
boolean	getIsConstrainable(SolutionClassFieldDefinition pSolutionClassFieldDefinition) Returns true if the given SolutionClass field is constrainable
boolean	getIsContent(SolutionClassFieldDefinition pSolutionClassFieldDefinition) Returns true if this field is a Content field, false if this field is a Property field.
boolean	getIsRequired(SolutionClassFieldDefinition pSolutionClassFieldDefinition) Returns true if the field is required.
boolean	getIsSearchable(SolutionClassFieldDefinition pSolutionClassFieldDefinition) Returns true if the given SolutionClass field is searchable
int	getOrder(SolutionClassFieldDefinition pSolutionClassFieldDefinition) Gets the order of this SolutionClassFieldDefinition in the solution class.
SolutionClass	getSolutionClass(SolutionClassFieldDefinition pSolutionClassFieldDefinition) Gets the SolutionClass for this SolutionClassFieldDefinition by using the SolutionClass id.
void	setFieldDefinition(java.lang.String pId, SolutionClassFieldDefinition pSolutionClassFieldDefinition) Sets the FieldDefinition for this SolutionClassFieldDefinition by using the FieldDefinition id.
void	setIndexing(FieldDefinitionIndexing pIndexing, SolutionClassFieldDefinition pSolutionClassFieldDefinition) Sets the type of indexing defined on this field using the enumerated value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

SolutionClassFieldDefinitionMethods

public SolutionClassFieldDefinitionMethods()

Method Detail

setFieldDefinition

public void setFieldDefinition(java.lang.String pId,
                               SolutionClassFieldDefinition pSolutionClassFieldDefinition)
                        throws ObjectNotFoundException

Sets the FieldDefinition for this SolutionClassFieldDefinition by using the FieldDefinition id.

Parameters:

pId - The id of the FieldDefinition to set on the SolutionClassFieldDefinition.

pSolutionClassFieldDefinition - The SolutionClassFieldDefinition to set the FieldDefinition on.

Throws:

ObjectNotFoundException - If the FieldDefinition is not found.

getSolutionClass

public SolutionClass getSolutionClass(SolutionClassFieldDefinition pSolutionClassFieldDefinition)
                               throws ObjectNotFoundException

Gets the SolutionClass for this SolutionClassFieldDefinition by using the SolutionClass id.

Parameters:

pSolutionClassFieldDefinition - The SolutionClassFieldDefinition to set the SolutionClass on.

Throws:

ObjectNotFoundException - If the SolutionClass is not found.

getOrder

public int getOrder(SolutionClassFieldDefinition pSolutionClassFieldDefinition)
             throws ObjectNotFoundException

Gets the order of this SolutionClassFieldDefinition in the solution class.

Parameters:

pSolutionClassFieldDefinition - The SolutionClassFieldDefinition to set the SolutionClass on.

Throws:

ObjectNotFoundException - If the SolutionClass or SolutionClassFieldDefinition is not found.

getIsContent

public boolean getIsContent(SolutionClassFieldDefinition pSolutionClassFieldDefinition)

Returns true if this field is a Content field, false if this field is a Property field.

Parameters:

pSolutionClassFieldDefinition - The field to check.

Returns:

True if this field is a Content field, false if this field is a Property field.

getComputedDisplayName

public java.lang.String getComputedDisplayName(SolutionClassFieldDefinition pSolutionClassFieldDefinition)

Deprecated. Use display name instead.

Gets the display name of the given SolutionClassFieldDefinition by computing it as follows. If the display name on the SolutionClassFieldDefinitionis not blank, return it else return the display name of the Field Definition.

Parameters:

pSolutionClassFieldDefinition - The SolutionClassFieldDefinition to compute the title on.

Returns:

A String with the display name.

getIsRequired

public boolean getIsRequired(SolutionClassFieldDefinition pSolutionClassFieldDefinition)

Returns true if the field is required. If the required value is defined on the SolutionClass the value is returned else the value of the FieldDefinition is returned.

Parameters:

pSolutionClassFieldDefinition - The SolutionClassFieldDefinition.

Returns:

True if the field is required else false.

getIndexing

public FieldDefinitionIndexing getIndexing(SolutionClassFieldDefinition pSolutionClassFieldDefinition)

Gets the type of indexing defined on this field. If no indexing is defined on the solution class field then the indexing is taken from the FieldDefinition indexing property.

Parameters:

pSolutionClassFieldDefinition - The SolutionClass field definition.

Returns:

The indexing property for the field.

setIndexing

public void setIndexing(FieldDefinitionIndexing pIndexing,
                        SolutionClassFieldDefinition pSolutionClassFieldDefinition)

Sets the type of indexing defined on this field using the enumerated value.

Parameters:

pIndexing - The type of indexing.

pSolutionClassFieldDefinition - The field to set the value on.

getIsSearchable

public boolean getIsSearchable(SolutionClassFieldDefinition pSolutionClassFieldDefinition)

Returns true if the given SolutionClass field is searchable

Parameters:

pSolutionClassFieldDefinition - The SolutionClass field definition to test.

Returns:

True if the SolutionClass field definition is searchable else false.

getIsConstrainable

public boolean getIsConstrainable(SolutionClassFieldDefinition pSolutionClassFieldDefinition)

Returns true if the given SolutionClass field is constrainable

Parameters:

pSolutionClassFieldDefinition - The SolutionClass field definition to test.

Returns:

True if the SolutionClass field definition is constrainable else false.