atg.svc.repository.beans.methods
Class SolutionFieldValueMethods

java.lang.Object
  atg.svc.repository.beans.methods.BaseMethods
      atg.svc.repository.beans.methods.SolutionFieldValueMethods

public class SolutionFieldValueMethods
extends BaseMethods

Defines extension methods for the SolutionFieldValue object.

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

SolutionFieldValueMethods()

Method Summary

atg.svc.repository.beans.FieldDefinitionType	getFieldDefinitionType(SolutionFieldValue pSolutionFieldValue) Gets the field definition type metadata for the SolutionFieldValue.
boolean	getHasPersonalization(SolutionFieldValue pSolutionFieldValue) Returns true if personalization has been specified on the given field value.
boolean	getIsEditable(SolutionFieldValue pSolutionFieldValue) Returns true if the SolutionFieldValue is editable by the current user.
boolean	getIsExternallyVisibleToEveryone(SolutionFieldValue pSolutionFieldValue) Returns true if the given SolutionFieldValue is visible to everyone external.
boolean	getIsExternallyVisibleToSegment(java.lang.String pSegment, SolutionFieldValue pSolutionFieldValue) Returns true if the given segment is found on the externalAudience property of the SolutionFieldValue.
boolean	getIsVisible(SolutionFieldValue pSolutionFieldValue) Returns true if the SolutionFieldValue is visible to the current user.
SolutionField	getSolutionField(SolutionFieldValue pFieldValue) Gets the parent SolutionField of the SolutionFieldValue.
java.lang.Object	getValue(SolutionFieldValue pSolutionFieldValue) Gets the primitive value of the SolutionFieldValue object.
void	setFieldDefinitionType(atg.svc.repository.beans.FieldDefinitionType pFieldDefinitionType, SolutionFieldValue pSolutionFieldValue) Sets the FieldDefinition type on the SolutionFieldValue.
void	setValue(java.lang.Object pValue, SolutionFieldValue pSolutionFieldValue) Sets the primitive value of the SolutionFieldValue object.

Methods inherited from class atg.svc.repository.beans.methods.BaseMethods

getServiceFactory

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

SolutionFieldValueMethods

public SolutionFieldValueMethods()

Method Detail

getValue

public java.lang.Object getValue(SolutionFieldValue pSolutionFieldValue)

Gets the primitive value of the SolutionFieldValue object. The value is found based on the type of the FieldDefinition associated with the parent SolutionField object.

Parameters:

pSolutionFieldValue - The SolutionFieldValue to get the value from.

Returns:

The primitive value.

setValue

public void setValue(java.lang.Object pValue,
                     SolutionFieldValue pSolutionFieldValue)

Sets the primitive value of the SolutionFieldValue object. The value to set is found based on the type of the FieldDefinition associated with the parent SolutionField object.

Parameters:

pValue - The value to set on the SolutionFieldValue object.

pSolutionFieldValue - The SolutionFieldValue to set the value on.

getIsVisible

public boolean getIsVisible(SolutionFieldValue pSolutionFieldValue)

Returns true if the SolutionFieldValue is visible to the current user.

Parameters:

pSolutionFieldValue - The SolutionFieldValue to check.

Returns:

True if the value is visible else false.

getIsEditable

public boolean getIsEditable(SolutionFieldValue pSolutionFieldValue)

Returns true if the SolutionFieldValue is editable by the current user.

Parameters:

pSolutionFieldValue - The SolutionFieldValue to check.

Returns:

True if the value is editable else false. =

getFieldDefinitionType

public atg.svc.repository.beans.FieldDefinitionType getFieldDefinitionType(SolutionFieldValue pSolutionFieldValue)

Gets the field definition type metadata for the SolutionFieldValue. This method translates the type field on the SolutionFieldValue into a FieldDefinitionType.

Parameters:

pSolutionFieldValue - The SolutionFieldValue to get the type for.

Returns:

The correct FieldDefinitionType.

setFieldDefinitionType

public void setFieldDefinitionType(atg.svc.repository.beans.FieldDefinitionType pFieldDefinitionType,
                                   SolutionFieldValue pSolutionFieldValue)

Sets the FieldDefinition type on the SolutionFieldValue. This is how the SolutionFieldValue knows what property to get its value from.

Parameters:

pFieldDefinitionType - The type of the field value.

pSolutionFieldValue - The field value.

getSolutionField

public SolutionField getSolutionField(SolutionFieldValue pFieldValue)
                               throws ObjectNotFoundException

Gets the parent SolutionField of the SolutionFieldValue.

Parameters:

pFieldValue - The field to find the parent Solution for.

Returns:

The parent SolutionField or null if the given field value is a bean without an id.

Throws:

ObjectNotFoundException

getIsExternallyVisibleToEveryone

public boolean getIsExternallyVisibleToEveryone(SolutionFieldValue pSolutionFieldValue)

Returns true if the given SolutionFieldValue is visible to everyone external.

Parameters:

pSolutionFieldValue - The SolutionFieldValue to check.

Returns:

True if the SolutionFieldValue is visible to everyone external.

getIsExternallyVisibleToSegment

public boolean getIsExternallyVisibleToSegment(java.lang.String pSegment,
                                               SolutionFieldValue pSolutionFieldValue)

Returns true if the given segment is found on the externalAudience property of the SolutionFieldValue.

Parameters:

pSegment - The segment to search on the externalAudience.

pSolutionFieldValue - The SolutionFieldValue to check.

Returns:

True if the given segment is found on the externalAudience property of the SolutionFieldValue.

getHasPersonalization

public boolean getHasPersonalization(SolutionFieldValue pSolutionFieldValue)

Returns true if personalization has been specified on the given field value. A value has personalization if it has anything other than just the "everyone" segment in each audience property.

Parameters:

pSolutionFieldValue - The value to check.

Returns:

True if personalization has been specified else false.