org.benow.web.complete
Interface CompletionService

All Superinterfaces:

org.benow.java.spec.Markup, org.benow.service.Service

All Known Implementing Classes:

CompletionServiceImpl

public interface CompletionService
extends org.benow.service.Service

Nested Class Summary

Nested classes/interfaces inherited from interface org.benow.java.spec.Markup

org.benow.java.spec.Markup.ParamName, org.benow.java.spec.Markup.ReturnDescription

Method Summary

java.util.List<CompleteResults>	getCompletionsFor(java.lang.Class<?> aClass, java.lang.String aField, java.lang.String prefix, java.lang.String parameters) Get completions for a field within a given class starting with prefix.
java.util.List<CompleteResults>	getCompletionsForSpanning(java.lang.Class<?> aClass, java.lang.String aField, java.lang.String prefix, java.lang.String parameters, int starting, int spanning) Get completions for a field within a given class starting with prefix.

Method Detail

getCompletionsFor

java.util.List<CompleteResults> getCompletionsFor(java.lang.Class<?> aClass,
                                                  java.lang.String aField,
                                                  java.lang.String prefix,
                                                  java.lang.String parameters)
                                                  throws java.io.IOException

Get completions for a field within a given class starting with prefix.

Note: prefixes shorter than 3 characters are typically ignored.

Parameters:

aClass -

aField -

prefix -

parameters - loose text parameter to pass to completers, typically empty

Returns:

relevant completions for prefix

Throws:

java.io.IOException

getCompletionsForSpanning

java.util.List<CompleteResults> getCompletionsForSpanning(java.lang.Class<?> aClass,
                                                          java.lang.String aField,
                                                          java.lang.String prefix,
                                                          java.lang.String parameters,
                                                          int starting,
                                                          int spanning)
                                                          throws java.io.IOException

Get completions for a field within a given class starting with prefix. A start offset and number of items can be returned to page through results.

Note: prefixes shorter than 3 characters are typically ignored.

Parameters:

aClass -

aField -

prefix -

parameters - loose text parameter to pass to completers, typically empty

starting - index to start from, SubList.FROM_START (-1) for start

number - of items to fetch, SubList.SPANNING_ALL (-1) for all result

Returns:

relevant completions for prefix

Throws:

java.io.IOException