Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action.util
Interface Pageable

All Known Implementing Classes:
BranchAction, DeleteAction, ForumAction, ForumCategoryAction, ForumThreadAction, LockThreadAction, MoveThreadAction, OnlineAction, PollAction, PollDeleteAction, PollExpireAction, PollsViewAction, PrivateMessagesAction, SearchAction, SearchProfile, TagAction, UnlockThreadAction, UserPicker, UserSearch, ViewModerateAction

public interface Pageable

A Pageable object is an object which describes how a list of items can be paged (split up into equals chunks of items). At a minimum, we need to know the starting index in the item list, the total number of items in the list, and an idea of the number of items per page and starting point in the page list. The last two items come from the ResultFilter class (see the getResultFilter() method).


Method Summary
 ResultFilter getResultFilter()
          Returns a Jive Forums result filter - this gives us a handle on the current index in the list and the number of items per page.
 int getStart()
          Returns the starting index in the item list.
 int getTotalItemCount()
          Returns the total number of items our list/collection/whatever.
 

Method Detail

getStart

int getStart()
Returns the starting index in the item list. This will be within the range of 0 to getTotalItemCount()-1.

Returns:
the starting index in the item list.

getTotalItemCount

int getTotalItemCount()
Returns the total number of items our list/collection/whatever. This number will always be > 0.

Returns:
the total number of items we're looking at.

getResultFilter

ResultFilter getResultFilter()
Returns a Jive Forums result filter - this gives us a handle on the current index in the list and the number of items per page.

Returns:
a Forums result filter.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.