com.ibm.ccd.ui.portlets.search.core
Interface ICollectionViewBean


public interface ICollectionViewBean

The Interface every view bean implements for collection display functionality This interface is to be implemented if the view bean has to display a collection of data. This would mean that the View bean understand how to provide the data that is required for displaying a collection, and also work with the actions associated with the collection


Field Summary
static java.lang.String ASCENDING
          Sorting order is ascending
static java.lang.String COL_DELIMITER
          The desired delimiter to which separates the values.
static java.lang.String COLLECTION_FORM_DISPLAY
          Action to display the collection
static java.lang.String DESCENDING
          Sorting order is descending
static java.lang.String FIRST
          The desired keystring for "First".
static java.lang.String GET_FIRST_RESULTS
          Action to get the first set of values in the collection
static java.lang.String GET_LAST_RESULTS
          Action to get the last set of values in the collection
static java.lang.String GET_NEXT_RESULTS
          Action to get the next set of values in the collection
static java.lang.String GET_PREVIOUS_RESULTS
          Action to get the previous set of values in the collection
static java.lang.String LAST
          The desired keystring for "Last".
static int LINK
          Marks the column contents as ones which have links
static java.lang.String NEXT
          The desired keystring for "Next".
static java.lang.String OF
          The desired keystring for "of".
static java.lang.String PREVIOUS
          The desired keystring for "Previous".
static java.lang.String ROW_DELIMITER
          The desired delimiter to which separates the lines.
static java.lang.String SHOWING
          The desired keystring for "Showing".
static java.lang.String SORT
          The action name for performing the sort.
static int TEXT
          Marks the column as containing only text values
static java.lang.String TO
          The desired keystring for "to".
static java.lang.String WORK_WITH_ITEM
          The desired keystring for "Work with Item(s)".
static java.lang.String ZERO_RECORDS_FOUND
          The desired keystring for "0 records found".
 
Method Summary
 int getEndIndex()
          Returns the end index
 java.util.ArrayList getResultsMetaData()
          Returns the Results Metadata
 java.util.ArrayList getResultsRows()
          Returns the availabe ResultRows associated with the current Result
 int getStartIndex()
          Returns the start index
 int getTotalResultsSize()
          Returns the Total Results size
 boolean hasNextResults()
          Returns the availability of Next Results for the Current Result
 boolean hasPreviousResults()
          Returns the availability of Previous results for the Current Result
 

Field Detail

SORT

static final java.lang.String SORT
The action name for performing the sort.

See Also:
Constant Field Values

ASCENDING

static final java.lang.String ASCENDING
Sorting order is ascending

See Also:
Constant Field Values

DESCENDING

static final java.lang.String DESCENDING
Sorting order is descending

See Also:
Constant Field Values

GET_NEXT_RESULTS

static final java.lang.String GET_NEXT_RESULTS
Action to get the next set of values in the collection

See Also:
Constant Field Values

GET_PREVIOUS_RESULTS

static final java.lang.String GET_PREVIOUS_RESULTS
Action to get the previous set of values in the collection

See Also:
Constant Field Values

GET_FIRST_RESULTS

static final java.lang.String GET_FIRST_RESULTS
Action to get the first set of values in the collection

See Also:
Constant Field Values

GET_LAST_RESULTS

static final java.lang.String GET_LAST_RESULTS
Action to get the last set of values in the collection

See Also:
Constant Field Values

TEXT

static final int TEXT
Marks the column as containing only text values

See Also:
Constant Field Values

LINK

static final int LINK
Marks the column contents as ones which have links

See Also:
Constant Field Values

COL_DELIMITER

static final java.lang.String COL_DELIMITER
The desired delimiter to which separates the values.

See Also:
Constant Field Values

ROW_DELIMITER

static final java.lang.String ROW_DELIMITER
The desired delimiter to which separates the lines.

See Also:
Constant Field Values

SHOWING

static final java.lang.String SHOWING
The desired keystring for "Showing".

See Also:
Constant Field Values

TO

static final java.lang.String TO
The desired keystring for "to".

See Also:
Constant Field Values

OF

static final java.lang.String OF
The desired keystring for "of".

See Also:
Constant Field Values

LAST

static final java.lang.String LAST
The desired keystring for "Last".

See Also:
Constant Field Values

FIRST

static final java.lang.String FIRST
The desired keystring for "First".

See Also:
Constant Field Values

NEXT

static final java.lang.String NEXT
The desired keystring for "Next".

See Also:
Constant Field Values

PREVIOUS

static final java.lang.String PREVIOUS
The desired keystring for "Previous".

See Also:
Constant Field Values

WORK_WITH_ITEM

static final java.lang.String WORK_WITH_ITEM
The desired keystring for "Work with Item(s)".

See Also:
Constant Field Values

ZERO_RECORDS_FOUND

static final java.lang.String ZERO_RECORDS_FOUND
The desired keystring for "0 records found".

See Also:
Constant Field Values

COLLECTION_FORM_DISPLAY

static final java.lang.String COLLECTION_FORM_DISPLAY
Action to display the collection

See Also:
Constant Field Values
Method Detail

getResultsMetaData

java.util.ArrayList getResultsMetaData()
Returns the Results Metadata

Returns:
Array of Result MetaData Elements

getResultsRows

java.util.ArrayList getResultsRows()
Returns the availabe ResultRows associated with the current Result

Returns:
Array of ResultRows

hasNextResults

boolean hasNextResults()
Returns the availability of Next Results for the Current Result

Returns:
true , if next results available
false , if next results are not available

hasPreviousResults

boolean hasPreviousResults()
Returns the availability of Previous results for the Current Result

Returns:
true , if next results available
false , if next results are not available

getTotalResultsSize

int getTotalResultsSize()
Returns the Total Results size

Returns:
total results size, int

getStartIndex

int getStartIndex()
Returns the start index

Returns:
int, the start index

getEndIndex

int getEndIndex()
Returns the end index

Returns:
int, the end index