com.atlassian.jira.issue.pager
Class NextPreviousPager

java.lang.Object
  com.atlassian.jira.issue.pager.NextPreviousPager

All Implemented Interfaces:

Serializable

public class NextPreviousPager
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

NextPreviousPager(ApplicationProperties applicationProperties)

NextPreviousPager(NextPreviousPager that)

Method Summary

String	getCurrentKey()
int	getCurrentPosition()
int	getCurrentSize()
String	getNextKey()
String	getPreviousKey()
boolean	isHasCurrentKey()
void	update(SearchRequest searchRequest, com.atlassian.crowd.embedded.api.User user, String currentKey) IMPORTANT!! This method must be called before current, previous or next issue is called.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NextPreviousPager

public NextPreviousPager(NextPreviousPager that)

NextPreviousPager

public NextPreviousPager(ApplicationProperties applicationProperties)

Method Detail

isHasCurrentKey

public boolean isHasCurrentKey()

getCurrentKey

public String getCurrentKey()

getCurrentPosition

public int getCurrentPosition()

getCurrentSize

public int getCurrentSize()

getNextKey

public String getNextKey()

getPreviousKey

public String getPreviousKey()

update

public void update(SearchRequest searchRequest,
                   com.atlassian.crowd.embedded.api.User user,
                   String currentKey)
            throws IOException,
                   SearchException

IMPORTANT!! This method must be called before current, previous or next issue is called. Otherwise they will return null.

This method keeps track of the current position in a search list and allows the user to easily navigate from issue to another.

Parameters:

searchRequest - The search request to keep track of.

user - The user performing the search

currentKey - the current issue that the user is browsing.

Throws:

IOException - if there is a problem while trying to read from the index

SearchException - thrown if there is an exception thrown during the search