com.plumtree.portaluiinfrastructure.search
Class PaginationControl

java.lang.Object
  com.plumtree.portaluiinfrastructure.search.SearchResultControl
      com.plumtree.portaluiinfrastructure.search.PaginationControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class PaginationControl
extends SearchResultControl

Author:

CraigS

Field Summary

static java.lang.String	FIRST_RESULT_DATA
static java.lang.String	ORDER_BY_DATA
static java.lang.String	PAGE_SIZE_DATA
static java.lang.String	STR_MVC_CLASS_NAME

Fields inherited from class com.plumtree.portaluiinfrastructure.search.SearchResultControl

_model, _parent, BASIC_FIELDS, KEY_DATA, PARTIAL_SEARCH, RECONSTRUCTION_ARGS_PREFIX, RECONSTRUCTION_PREFIX_LENGTH, USER_QUERY

Constructor Summary

PaginationControl()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
protected Redirect	ExecuteSearchControl(XPHashtable args, java.lang.String key) Execute method that subclasses should implement; unlike Execute() it's allowed to throw a SearchExecutionException.
java.lang.String	GetName() Return the name of the MVC object.
static ILinkElement	makeURL(IBaseSearchResultModelRO model, AActivitySpace parent, java.lang.String urlText, java.lang.String orderBy, int newFirst) Factory method to make a pagination link for some search results.
static ILinkElement	makeURL(IBaseSearchResultModelRO model, AActivitySpace parent, java.lang.String urlText, java.lang.String orderBy, int newFirst, boolean bEmbed) Factory method to make a pagination link for some search results.
static HTMLElement	makeURL(IBaseSearchResultModelRO model, AActivitySpace parent, java.lang.String urlText, java.lang.String orderBy, int newFirst, int pageSize) Factory method to make a pagination link for some search results.
static java.lang.String	makeURLAsString(IBaseSearchResultModelRO model, AActivitySpace parent, java.lang.String urlText, java.lang.String orderBy, int newFirst, int pageSize) Factory method to make a pagination link for some search results.

Methods inherited from class com.plumtree.portaluiinfrastructure.search.SearchResultControl

addCommonData, CheckActionSecurityAndExecute, expectModelInitialized, Init, parseQueryArgs, SpaceNeedsPassthruURL

Methods inherited from class java.lang.Object

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

FIRST_RESULT_DATA

public static final java.lang.String FIRST_RESULT_DATA

See Also:

Constant Field Values

PAGE_SIZE_DATA

public static final java.lang.String PAGE_SIZE_DATA

See Also:

Constant Field Values

ORDER_BY_DATA

public static final java.lang.String ORDER_BY_DATA

See Also:

Constant Field Values

Constructor Detail

PaginationControl

public PaginationControl()

Method Detail

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class SearchResultControl

Returns:

the name of the object.

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IControl#GetName()

makeURLAsString

public static java.lang.String makeURLAsString(IBaseSearchResultModelRO model,
                                               AActivitySpace parent,
                                               java.lang.String urlText,
                                               java.lang.String orderBy,
                                               int newFirst,
                                               int pageSize)

Factory method to make a pagination link for some search results.

Parameters:

model - Current batch of search results

parent - ActivitySpace we're living in

urlText - Desired text within URL

orderBy - Sort order within which newFirst is to be interpreted

newFirst - Desired first result on new page

pageSize - Desired number of results on page

makeURL

public static HTMLElement makeURL(IBaseSearchResultModelRO model,
                                  AActivitySpace parent,
                                  java.lang.String urlText,
                                  java.lang.String orderBy,
                                  int newFirst,
                                  int pageSize)

Factory method to make a pagination link for some search results.

Parameters:

model - Current batch of search results

parent - ActivitySpace we're living in

urlText - Desired text within URL

orderBy - Sort order within which newFirst is to be interpreted

newFirst - Desired first result on new page

pageSize - Desired number of results on page

makeURL

public static ILinkElement makeURL(IBaseSearchResultModelRO model,
                                   AActivitySpace parent,
                                   java.lang.String urlText,
                                   java.lang.String orderBy,
                                   int newFirst)

Factory method to make a pagination link for some search results.

Parameters:

model - Current batch of search results

parent - ActivitySpace we're living in

urlText - Desired text within URL

orderBy - Sort order within which newFirst is to be interpreted

newFirst - Desired first result on new page

makeURL

public static ILinkElement makeURL(IBaseSearchResultModelRO model,
                                   AActivitySpace parent,
                                   java.lang.String urlText,
                                   java.lang.String orderBy,
                                   int newFirst,
                                   boolean bEmbed)

Factory method to make a pagination link for some search results.

Parameters:

model - Current batch of search results

parent - ActivitySpace we're living in

urlText - Desired text within URL

orderBy - Sort order within which newFirst is to be interpreted

newFirst - Desired first result on new page

bEmbed - Whether or not this URL should be embedded in a form

Create

public java.lang.Object Create()

Description copied from class: SearchResultControl

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class SearchResultControl

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

ExecuteSearchControl

protected Redirect ExecuteSearchControl(XPHashtable args,
                                        java.lang.String key)

Description copied from class: SearchResultControl

Execute method that subclasses should implement; unlike Execute() it's allowed to throw a SearchExecutionException. The key argument indicates the page on which this control's URL was located; this lets us handle the case where the user hits BACK before clicking on something, and (for example) drills down into a different set of categories than the set being displayed on the current page.

Specified by:

ExecuteSearchControl in class SearchResultControl

See Also:

com.plumtree.portalpages.search.SearchResultControl#ExecuteSearchControl()