com.sdl.context.api.definition

Interface ContextPropertyDefinition

All Superinterfaces:

Serializable

public interface ContextPropertyDefinition
extends Serializable

A context property definition.

Method Summary

Modifier and Type	Method and Description
String	getAspectName() Name of the aspect to which this property is associated, e.g.
Object	getDefaultValue() Returns default value.
String	getExpression() Context expression that can be used to evaluate the property value.
int	getExpressionTrust() Trust value for when expression is applied.
List<String>	getImplies() Segments that are automatically true when this segment is true.
ContextPropertyName	getName() Get the context property name for this definition.
String	getPropertyName() Name of the context property.
List<String>	getRequires() Segments that are required to be true for this segment also to be true.
ContextPropertyType	getType() Type of the context property.
boolean	hasExpression() Does the property have an expression defined?
boolean	hasImplies() Does this property definition have implies defined?
boolean	hasRequires() Does this property definition have requires defined?
boolean	isIdentifier() Is the property an identifier? Can it be used as part of the unique identifier for the given aspect? This is currently only used for context repository storage.

Method Detail

getAspectName

String getAspectName()

Name of the aspect to which this property is associated, e.g. "browser"

Returns:

aspectName

getPropertyName

String getPropertyName()

Name of the context property. Note that this name is the local property name relative to the aspect, e.g. "displayWidth" and NOT "browser.displayWidth"

Returns:

context property name

getName

ContextPropertyName getName()

Get the context property name for this definition.

Returns:

context property name

getExpression

String getExpression()

Context expression that can be used to evaluate the property value.

Returns:

context expression

getType

ContextPropertyType getType()

Type of the context property.

Returns:

type

getExpressionTrust

int getExpressionTrust()

Trust value for when expression is applied.

Returns:

expression trust

hasExpression

boolean hasExpression()

Does the property have an expression defined?

Returns:

whether property has expression

getDefaultValue

Object getDefaultValue()

Returns default value.

Returns:

default value.

isIdentifier

boolean isIdentifier()

Is the property an identifier? Can it be used as part of the unique identifier for the given aspect? This is currently only used for context repository storage.

Returns:

whether the property is an identifier or not

getRequires

List<String> getRequires()

Segments that are required to be true for this segment also to be true. Requires are only applicable to boolean properties, i.e. context segments.

Returns:

list of required segments for this segment

getImplies

List<String> getImplies()

Segments that are automatically true when this segment is true. Implies are only applicable to boolean properties, i.e. context segments.

Returns:

list of implied segments for this segment

hasRequires

boolean hasRequires()

Does this property definition have requires defined?

Returns:

whether this property definition has requires defined.

hasImplies

boolean hasImplies()

Does this property definition have implies defined?

Returns:

whether this property definition has requires defined.