Index (Context Client 8.5.0-1041 API)

A B C E F G H I K N O R S T V W

A

Aspect - Interface in com.sdl.context.api: An aspect.
AspectDefinition - Interface in com.sdl.context.api.definition: An aspect definition.

B

build() - Method in class com.sdl.context.api.resolution.EvidenceBuilder: Build the evidence.

C

coerce(Object) - Method in interface com.sdl.context.api.types.ComparableAndCoercible
coerce(Object) - Method in class com.sdl.context.api.types.GenericVersion
com.sdl.context.api - package com.sdl.context.api
com.sdl.context.api.definition - package com.sdl.context.api.definition
com.sdl.context.api.engine - package com.sdl.context.api.engine
com.sdl.context.api.exception - package com.sdl.context.api.exception
com.sdl.context.api.resolution - package com.sdl.context.api.resolution
com.sdl.context.api.types - package com.sdl.context.api.types
com.sdl.context.odata.client.api - package com.sdl.context.odata.client.api
ComparableAndCoercible<T> - Interface in com.sdl.context.api.types: Object that is comparable to other objects and coercible into other objects.
compareTo(Version) - Method in class com.sdl.context.api.types.GenericVersion
compareTo(String) - Method in class com.sdl.context.api.types.GenericVersion
compareTo(VersionPart) - Method in class com.sdl.context.api.types.GenericVersionPart
containsKey(String) - Method in interface com.sdl.context.api.Aspect: Returns true if a property with the specified key exists in the Aspect.
containsKey(String) - Method in interface com.sdl.context.api.ContextMap: Test whether the context map includes an aspect with the specified name.
containsKey(String) - Method in interface com.sdl.context.api.resolution.Evidence: Returns true if the evidence contains an item with the specified key.
containsOrigin(String) - Method in interface com.sdl.context.api.resolution.Evidence: Returns true if the evidence contains an evidence item of the specified origin (e.g.
ContextBroker - Interface in com.sdl.context.api: The context broker makes CWD features available to the system.
ContextBrokerDiscoveryException - Exception in com.sdl.context.api.exception: Exception thrown when there was an issue with context broker discovery.
ContextBrokerDiscoveryException(Throwable) - Constructor for exception com.sdl.context.api.exception.ContextBrokerDiscoveryException
ContextBrokerDiscoveryException(String) - Constructor for exception com.sdl.context.api.exception.ContextBrokerDiscoveryException
ContextBrokerRuntimeException - Exception in com.sdl.context.api.exception: Runtime exception to cover the rare situation where context broker jars have not been configured correctly.
ContextBrokerRuntimeException(String, Throwable) - Constructor for exception com.sdl.context.api.exception.ContextBrokerRuntimeException
ContextEngine<A extends ContextMap<? extends Aspect>> - Interface in com.sdl.context.api.engine: The context engine responsible for resolving context from evidence.
ContextEngineProvider - Class in com.sdl.context.odata.client.api: Provide class used to initialize and provide ODataContextEngine used to access Context Service .
ContextMap<A extends Aspect> - Interface in com.sdl.context.api: A context map.
ContextProperty - Interface in com.sdl.context.api: A context property.
ContextPropertyDefinition - Interface in com.sdl.context.api.definition: A context property definition.
ContextPropertyName - Interface in com.sdl.context.api.definition: Context property name.
ContextPropertyType - Enum in com.sdl.context.api.definition: A context property type.
ContextSegmentPath - Interface in com.sdl.context.api.types: A context segment path.
ContextualDelivery - Class in com.sdl.context.api: Contextual Delivery static helper.
ContextVocabulary - Interface in com.sdl.context.api: A vocabulary that describes context aspect and property definitions.

E

equals(Object) - Method in class com.sdl.context.api.definition.GenericContextPropertyName
equals(Object) - Method in class com.sdl.context.api.types.GenericVersion
equals(Object) - Method in class com.sdl.context.api.types.GenericVersionPart
evaluateExpression(String, ContextPropertyType) - Method in interface com.sdl.context.api.engine.ContextEngine: Evaluate passed expression for the specified type using evidence.
evaluateExpression(String, ContextPropertyType) - Method in class com.sdl.context.odata.client.api.ODataContextEngine
Evidence - Interface in com.sdl.context.api.resolution: Evidence.
EvidenceBuilder - Class in com.sdl.context.api.resolution: Evidence builder to create evidence that can be used via the ContextEngine resolve method to resolve context.
EvidenceBuilder() - Constructor for class com.sdl.context.api.resolution.EvidenceBuilder: Create new EvidenceBuilder.
EvidenceItem - Interface in com.sdl.context.api.resolution: Evidence item - storage for all evidence properties.

F

findPropertyDefinition(String, String) - Method in interface com.sdl.context.api.ContextVocabulary: Deprecated.
- please use findPropertyDefinition(ContextPropertyName name)
findPropertyDefinition(ContextPropertyName) - Method in interface com.sdl.context.api.ContextVocabulary: Returns the property definition for the specified property name.
fromAspectQualifiedName(String) - Static method in class com.sdl.context.api.definition.GenericContextPropertyName

G

GenericContextPropertyName - Class in com.sdl.context.api.definition: Generic context property name implementation.
GenericContextPropertyName(String, String) - Constructor for class com.sdl.context.api.definition.GenericContextPropertyName
GenericContextSegmentPath - Class in com.sdl.context.api.types: Generic context segment path.
GenericContextSegmentPath(String, List<String>) - Constructor for class com.sdl.context.api.types.GenericContextSegmentPath: Create a context segment path from a list of segment names.
GenericVersion - Class in com.sdl.context.api.types: Version type, e.g.
GenericVersion() - Constructor for class com.sdl.context.api.types.GenericVersion: Create an instance of a version.
GenericVersion(String) - Constructor for class com.sdl.context.api.types.GenericVersion
GenericVersion(int) - Constructor for class com.sdl.context.api.types.GenericVersion
GenericVersion(int, int) - Constructor for class com.sdl.context.api.types.GenericVersion
GenericVersion(int, int, int) - Constructor for class com.sdl.context.api.types.GenericVersion
GenericVersion(String, String) - Constructor for class com.sdl.context.api.types.GenericVersion: Create Version from major and minor version parts as strings.
GenericVersion(String, String, String) - Constructor for class com.sdl.context.api.types.GenericVersion
GenericVersion(double) - Constructor for class com.sdl.context.api.types.GenericVersion
GenericVersionPart - Class in com.sdl.context.api.types: Part of a version object, e.g.
GenericVersionPart(String) - Constructor for class com.sdl.context.api.types.GenericVersionPart
GenericVersionPart(int) - Constructor for class com.sdl.context.api.types.GenericVersionPart
get(String) - Method in interface com.sdl.context.api.Aspect: Returns the value of the property (with the specified key).
get(String) - Method in interface com.sdl.context.api.ContextMap: Get aspect with the specified name, returning null if aspect does not exist.
get(ContextPropertyName) - Method in interface com.sdl.context.api.ContextMap: Get context map value from context property name.
get(String) - Method in interface com.sdl.context.api.ContextVocabulary: Returns the aspect definition for the specified aspect name.
get(String) - Method in interface com.sdl.context.api.definition.AspectDefinition: Returns the property definition for the specified property name.
get(String) - Method in interface com.sdl.context.api.resolution.Evidence: Returns the evidence item identified by the specified key (e.g.
get(String) - Method in class com.sdl.context.api.resolution.EvidenceBuilder: Get the evidence value for the given key.
getAspectName() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Name of the aspect to which this property is associated, e.g.
getAspectName() - Method in interface com.sdl.context.api.definition.ContextPropertyName: Returns the name of the aspect that the property is in e.g.
getAspectName() - Method in class com.sdl.context.api.definition.GenericContextPropertyName
getAspectQualifiedName() - Method in interface com.sdl.context.api.definition.ContextPropertyName: Return the property name including aspect name prefix e.g.
getAspectQualifiedName() - Method in class com.sdl.context.api.definition.GenericContextPropertyName
getBroker() - Static method in class com.sdl.context.api.ContextualDelivery: Get the context broker for this system.
getDefaultValue() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Returns default value.
getDefinition() - Method in interface com.sdl.context.api.Aspect: Get aspect definition.
getEngine() - Method in interface com.sdl.context.api.ContextBroker: Get the context engine.
getExpression() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Context expression that can be used to evaluate the property value.
getExpressionTrust() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Trust value for when expression is applied.
getId() - Method in interface com.sdl.context.api.ContextVocabulary: Returns the ID (unique identifier) for the vocabulary.
getImplies() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Segments that are automatically true when this segment is true.
getIncrementalVersion() - Method in class com.sdl.context.api.types.GenericVersion
getIncrementalVersion() - Method in interface com.sdl.context.api.types.Version: Returns the incremental version, e.g.
getIncrementalVersionModifier() - Method in class com.sdl.context.api.types.GenericVersion
getIncrementalVersionModifier() - Method in interface com.sdl.context.api.types.Version: Returns the incremental version modifier, e.g.
getIncrementalVersionModifierNumber() - Method in class com.sdl.context.api.types.GenericVersion
getIncrementalVersionModifierNumber() - Method in interface com.sdl.context.api.types.Version: Returns the incremental version modifier number, e.g.
getIncrementalVersionNamePart() - Method in class com.sdl.context.api.types.GenericVersion
getIncrementalVersionNamePart() - Method in interface com.sdl.context.api.types.Version: Returns the version part which relates to the incremental portion of the version, so if the Version was "1.2.3" this would return a version part that relates to "3".
getInstance() - Static method in class com.sdl.context.odata.client.api.ContextEngineProvider
getKey() - Method in interface com.sdl.context.api.resolution.EvidenceItem: Returns the key for the evidence item (e.g.
getKey() - Method in interface com.sdl.context.api.types.ContextSegmentPath: Return the key, i.ed.
getKey() - Method in class com.sdl.context.api.types.GenericContextSegmentPath
getLocalPropertyName() - Method in interface com.sdl.context.api.definition.ContextPropertyName: Returns the property name e.g.
getLocalPropertyName() - Method in class com.sdl.context.api.definition.GenericContextPropertyName
getMajorVersion() - Method in class com.sdl.context.api.types.GenericVersion
getMajorVersion() - Method in interface com.sdl.context.api.types.Version: Returns the major version, e.g.
getMajorVersionModifier() - Method in class com.sdl.context.api.types.GenericVersion
getMajorVersionModifier() - Method in interface com.sdl.context.api.types.Version: Returns the major version modifier, e.g.
getMajorVersionModifierNumber() - Method in class com.sdl.context.api.types.GenericVersion
getMajorVersionModifierNumber() - Method in interface com.sdl.context.api.types.Version: Returns the major version modifier number, e.g.
getMajorVersionNamePart() - Method in class com.sdl.context.api.types.GenericVersion
getMajorVersionNamePart() - Method in interface com.sdl.context.api.types.Version: Returns the version part which relates to the major portion of the version, so if if the Version was "1.2" this would return a version part that relates to "1".
getMap() - Method in interface com.sdl.context.api.ContextBroker: Get the context map for the current user interaction.
getMinorVersion() - Method in class com.sdl.context.api.types.GenericVersion
getMinorVersion() - Method in interface com.sdl.context.api.types.Version: Returns the minor version, e.g.
getMinorVersionModifier() - Method in class com.sdl.context.api.types.GenericVersion
getMinorVersionModifier() - Method in interface com.sdl.context.api.types.Version: Returns the minor version modifier, e.g.
getMinorVersionModifierNumber() - Method in class com.sdl.context.api.types.GenericVersion
getMinorVersionModifierNumber() - Method in interface com.sdl.context.api.types.Version: Returns the minor version modifier number, e.g.
getMinorVersionNamePart() - Method in class com.sdl.context.api.types.GenericVersion
getMinorVersionNamePart() - Method in interface com.sdl.context.api.types.Version: Returns the version part which relates to the minor portion of the version, so if if the Version was "1.2" this would return a version part that relates to "2".
getModifier() - Method in class com.sdl.context.api.types.GenericVersionPart
getModifier() - Method in interface com.sdl.context.api.types.VersionPart: Returns the modifier, e.g.
getModifierNumber() - Method in class com.sdl.context.api.types.GenericVersionPart
getModifierNumber() - Method in interface com.sdl.context.api.types.VersionPart: Returns the modifier number.
getModifierPriority() - Method in class com.sdl.context.api.types.GenericVersionPart
getModifierPriority() - Method in interface com.sdl.context.api.types.VersionPart: Returns a number indicating the priority of the modifier.
getName() - Method in interface com.sdl.context.api.ContextProperty: Get the context property name.
getName() - Method in interface com.sdl.context.api.definition.AspectDefinition: Name of the aspect e.g.
getName() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Get the context property name for this definition.
getName() - Method in class com.sdl.context.api.types.GenericVersion
getName() - Method in interface com.sdl.context.api.types.Version: Returns a string representation of the version, e.g.
getNumber() - Method in class com.sdl.context.api.types.GenericVersionPart
getNumber() - Method in interface com.sdl.context.api.types.VersionPart: Returns the initial number of the version part, e.g.
getODataContextEngine() - Method in class com.sdl.context.odata.client.api.ContextEngineProvider: Get ODataContextEngine.
getOrigin() - Method in interface com.sdl.context.api.resolution.EvidenceItem: Returns the origin for the evidence item (e.g.
getProperty(String) - Method in interface com.sdl.context.api.Aspect: Gets a property.
getPropertyDefinitions() - Method in interface com.sdl.context.api.ContextVocabulary: Return all the context property definitions in this repository in order of evaluation.
getPropertyName() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Name of the context property.
getRequires() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Segments that are required to be true for this segment also to be true.
getSegments() - Method in interface com.sdl.context.api.types.ContextSegmentPath: Returns the list of segment names in the segment path.
getSegments() - Method in class com.sdl.context.api.types.GenericContextSegmentPath
getType() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Type of the context property.
getValue() - Method in interface com.sdl.context.api.ContextProperty: Gets the property value.
getValue() - Method in interface com.sdl.context.api.resolution.EvidenceItem: Returns the value of the evidence item.
getValueAsString() - Method in interface com.sdl.context.api.resolution.EvidenceItem: Returns a string representation of the evidence value.
getVocabulary() - Method in interface com.sdl.context.api.ContextBroker: Get the context vocabulary.
getVocabulary() - Method in interface com.sdl.context.api.engine.ContextEngine: Get the vocabulary being used by the engine.
getVocabulary() - Method in class com.sdl.context.odata.client.api.ODataContextEngine

H

hasExpression() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Does the property have an expression defined?
hashCode() - Method in class com.sdl.context.api.definition.GenericContextPropertyName
hashCode() - Method in class com.sdl.context.api.types.GenericVersion
hashCode() - Method in class com.sdl.context.api.types.GenericVersionPart
hasImplies() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Does this property definition have implies defined?
hasRequires() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: Does this property definition have requires defined?

I

isEmpty() - Method in interface com.sdl.context.api.Aspect: Returns true if there are no properties in the Aspect.
isEmpty() - Method in interface com.sdl.context.api.ContextMap: Is the context map empty?
isIdentifier(String) - Method in interface com.sdl.context.api.definition.AspectDefinition: Is the given property name an identifier?
isIdentifier() - Method in interface com.sdl.context.api.definition.ContextPropertyDefinition: 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.
iterator() - Method in interface com.sdl.context.api.resolution.Evidence: Provides an iterator which returns all the EvidenceItems in the Evidence.

K

keySet() - Method in interface com.sdl.context.api.Aspect: Returns the keys of all the property keys in this Aspect.
keySet() - Method in interface com.sdl.context.api.ContextMap: Get aspect names included in this context map.
keySet() - Method in interface com.sdl.context.api.ContextVocabulary: Returns the set of aspect names in the vocabulary e.g.
keySet() - Method in interface com.sdl.context.api.definition.AspectDefinition: Returns the set of property names related to the aspect, e.g.

N

newPropertyName(String, String) - Static method in class com.sdl.context.api.definition.GenericContextPropertyName

O

ODataContextEngine - Class in com.sdl.context.odata.client.api: Context engine which resolves context maps via the OData context engine web service.
ODataContextEngine() - Constructor for class com.sdl.context.odata.client.api.ODataContextEngine

R

resolve(Evidence) - Method in interface com.sdl.context.api.engine.ContextEngine: Resolves a context map based on the provided evidence.
resolve(Evidence) - Method in class com.sdl.context.odata.client.api.ODataContextEngine
ResolverException - Exception in com.sdl.context.api.exception: A context exception.
ResolverException(String) - Constructor for exception com.sdl.context.api.exception.ResolverException
ResolverException(String, Throwable) - Constructor for exception com.sdl.context.api.exception.ResolverException
RuntimeContextException - Exception in com.sdl.context.api.exception: Runtime context exception.
RuntimeContextException(String) - Constructor for exception com.sdl.context.api.exception.RuntimeContextException

S

size() - Method in interface com.sdl.context.api.Aspect: Returns the number of properties in the Aspect.
size() - Method in interface com.sdl.context.api.ContextMap: Get the number of aspects in this context map.

T

toString() - Method in class com.sdl.context.api.definition.GenericContextPropertyName
toString() - Method in class com.sdl.context.api.types.GenericContextSegmentPath
toString() - Method in class com.sdl.context.api.types.GenericVersion
toString() - Method in class com.sdl.context.api.types.GenericVersionPart

V

valueOf(String) - Static method in enum com.sdl.context.api.definition.ContextPropertyType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.sdl.context.api.definition.ContextPropertyType: Returns an array containing the constants of this enum type, in the order they are declared.
Version - Interface in com.sdl.context.api.types: Version type, e.g.
VersionPart - Interface in com.sdl.context.api.types: Part of a version, e.g.
VocabularyException - Exception in com.sdl.context.api.exception: Vocabulary exception.
VocabularyException(String) - Constructor for exception com.sdl.context.api.exception.VocabularyException
VocabularyException(String, Throwable) - Constructor for exception com.sdl.context.api.exception.VocabularyException

W

with(Object) - Method in class com.sdl.context.api.resolution.EvidenceBuilder: Add evidence item for given user-agent HTTP header.
with(String, Object) - Method in class com.sdl.context.api.resolution.EvidenceBuilder: Add evidence for the given key / value pair, e.g.
with(String, Object, String) - Method in class com.sdl.context.api.resolution.EvidenceBuilder: Add evidence for the given key / value pair and origin, e.g.
with(Map<String, Object>) - Method in class com.sdl.context.api.resolution.EvidenceBuilder: Create evidence based on a map of evidence key / value pairs.
with(Evidence) - Method in class com.sdl.context.api.resolution.EvidenceBuilder: State evidence that the evidence that you are building inherits from.
withEvidence(Map<String, Object>) - Static method in class com.sdl.context.api.resolution.EvidenceBuilder: Create evidence based on a map of evidence key / value pairs.
withPublicationId(Integer) - Method in class com.sdl.context.api.resolution.EvidenceBuilder: Add evidence item for given publication id related to target group.
withUserAgent(String) - Static method in class com.sdl.context.api.resolution.EvidenceBuilder: Create evidence based on just a single user agent HTTP header.

A B C E F G H I K N O R S T V W