ro.sync.ecss.extensions.cc

Interface ValueProvider

All Superinterfaces:

java.lang.Comparable<ValueProvider>

All Known Implementing Classes:

ro.sync.ecss.extensions.cc.AbstractValueProvider, SimpleValueProvider, XSLTValueProvider

@API(type=INTERNAL,
     src=PUBLIC)
public interface ValueProvider
extends java.lang.Comparable<ValueProvider>

Provides a list of content completion values for a specific context.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ValueProvider.Action Defines how the returned values should be processed.

Method Summary

Modifier and Type	Method and Description
ValueProvider.Action	getAction() Describes how the returned values should be handled.
ro.sync.ecss.extensions.cc.MatchCriteria	getMatchCriteria() Gets the match criteria for this value provider.
java.util.List<CIValue>	getValues(java.lang.String systemID, ContextProvider contextProvider) Gets content completion values.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getValues

java.util.List<CIValue> getValues(java.lang.String systemID,
                                  ContextProvider contextProvider)

Gets content completion values.

Parameters:

systemID - The system ID of the document for which we are requesting the content completion.

contextProvider - An Xpath location that identifies the element in the context of which we are requesting the possible values.

Returns:

A list of content completion values.

getAction

ValueProvider.Action getAction()

Describes how the returned values should be handled.

Returns:

One of ValueProvider.Action.

getMatchCriteria

ro.sync.ecss.extensions.cc.MatchCriteria getMatchCriteria()

Gets the match criteria for this value provider.

Returns:

The criteria that should match an item with this provider.