com.atlassian.jira.issue.pager
Class NextPreviousPager

java.lang.Object
  extended by com.atlassian.jira.issue.pager.NextPreviousPager
All Implemented Interfaces:
java.io.Serializable

public class NextPreviousPager
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Constructor Summary
NextPreviousPager(ApplicationProperties applicationProperties)
           
NextPreviousPager(NextPreviousPager that)
           
 
Method Summary
 java.lang.String getCurrentKey()
           
 int getCurrentPosition()
           
 int getCurrentSize()
           
 java.lang.String getNextKey()
           
 java.lang.String getPreviousKey()
           
 boolean isHasCurrentKey()
           
 void update(SearchRequest searchRequest, com.opensymphony.user.User user, java.lang.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 java.lang.String getCurrentKey()

getCurrentPosition

public int getCurrentPosition()

getCurrentSize

public int getCurrentSize()

getNextKey

public java.lang.String getNextKey()

getPreviousKey

public java.lang.String getPreviousKey()

update

public void update(SearchRequest searchRequest,
                   com.opensymphony.user.User user,
                   java.lang.String currentKey)
            throws java.io.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:
java.io.IOException - if there is a problem while trying to read from the index
SearchException - thrown if there is an exception thrown during the search


Copyright © 2002-2010 Atlassian. All Rights Reserved.