net.mlw.vlh
Interface ValueListAdapter

All Known Implementing Classes:

AbstractValueListAdapter, Ibatis20Adapter, ValueListAdapterCacheDecorator

public interface ValueListAdapter

This class abstracts the means by which a ValueList is retrieved by the service.

Version:

$Revision: 1.5 $ $Date: 2005/04/07 14:07:40 $

Author:

Matthew L. Wilson, Andrej Zachar

Field Summary

static int	DO_FILTER Constant to tell the Handler to do filtering.
static int	DO_FOCUS Constant to tell the Handler to do focusing.
static int	DO_NOTHING Constant to tell the Handler to do nothing.
static int	DO_PAGE Constant to tell the Handler to do paging.
static int	DO_SORT Constant to tell the Handler to do sorting.

Method Summary

int	getAdapterType() This method tells the Service what still needs to be done on the Collection before returning the data.
ValueList	getValueList(String name, ValueListInfo info) Gets a ValueList

Field Detail

DO_NOTHING

public static final int DO_NOTHING

Constant to tell the Handler to do nothing.

See Also:

Constant Field Values

DO_SORT

public static final int DO_SORT

Constant to tell the Handler to do sorting.

See Also:

Constant Field Values

DO_PAGE

public static final int DO_PAGE

Constant to tell the Handler to do paging.

See Also:

Constant Field Values

DO_FILTER

public static final int DO_FILTER

Constant to tell the Handler to do filtering.

See Also:

Constant Field Values

DO_FOCUS

public static final int DO_FOCUS

Constant to tell the Handler to do focusing.

See Also:

Constant Field Values

Method Detail

getValueList

public ValueList getValueList(String name,
                              ValueListInfo info)

Gets a ValueList

Parameters:

info - The ValueList information

name - The name of the ValueList

Returns:

The ValueList

getAdapterType

public int getAdapterType()

This method tells the Service what still needs to be done on the Collection before returning the data.

Returns:

A bitwise or combination of DO_NOTHING, DO_SORT, DO_PAGE and DO_FILTER. For example:

           public int getAdapterType()
           {
             return DO_SORT | DO_PAGE;
           }