IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.cs.html
Class PageRetrieverOperation

java.lang.Object
  extended by com.ibm.btt.base.BTTOperation
      extended by com.ibm.btt.base.BTTServerOperation
          extended by com.ibm.btt.cs.html.PageRetrieverOperation
All Implemented Interfaces:
Cacheable, Operation, ServerOperation, java.io.Externalizable, java.io.Serializable

public abstract class PageRetrieverOperation
extends BTTServerOperation

Abstract class for server side pagination. User need to override the getPageData method to set the pagination data in the specific indexed Collection.

See Also:
Serialized Form

Nested Class Summary
 class PageRetrieverOperation.SortColumn
           
 
Field Summary
 
Fields inherited from class com.ibm.btt.base.BTTOperation
aOperationRepliedListener, COMPID, externalizer
 
Constructor Summary
PageRetrieverOperation()
           
PageRetrieverOperation(java.lang.String anOperationName)
          Constructs a PageRetrieverOperation.
PageRetrieverOperation(java.lang.String anOperationName, Context aParentContext)
           
PageRetrieverOperation(java.lang.String anOperationName, java.lang.String aParentContext)
          Constructs a PageRetrieverOperation.
 
Method Summary
 void execute()
          Implements the server operation logic.
abstract  int getPageData(int start, int count, java.util.List<PageRetrieverOperation.SortColumn> sortColumnList)
          User need to override the getPageData method to set the pagination data in the indexed Collection named 'items'.
 
Methods inherited from class com.ibm.btt.base.BTTServerOperation
createOperation, fireExitEvent, getCSReplyFormat, getCSRequestFormat, getOriginWorkstation, runInSession, setCSReplyFormat, setCSRequestFormat, setOriginWorkstation, updateContext, updateContext, validate, validate
 
Methods inherited from class com.ibm.btt.base.BTTOperation
addElement, addOperationRepliedListener, chainTo, clearKeyedCollection, close, externalizer, fireHandleOperationRepliedEvent, getApplicationId, getContext, getContextByType, getContextName, getContextNamed, getElementAt, getExternalizer, getFormat, getFormats, getHostReceiveFormat, getHostSendFormat, getInstanceOfOperationStep, getKeyedCollection, getName, getOperationStep, getOperationStepRC, getOperationSteps, getParent, getSelfDefinedOpTagInputStream, getService, getSessionId, getSgmlSelfDefinedOpFileName, getType, getValueAt, getXValidator, initializeFormatFrom, initializeFrom, initializeKeyedCollectionValueFrom, initializeOpStep, initializeOpStepsFrom, isCacheable, isChained, postExecute, preExecute, prune, readExternal, readExternal, readObject, reinitialize, removeAt, removeExternal, removeOperationRepliedListener, setApplicationId, setContext, setContextName, setDefinedContext, setExternalizer, setHostReceiveFormat, setHostSendFormat, setKeyedCollection, setName, setSessionId, setType, setValueAt, setXValidator, toString, toStrings, toTags, unchain, writeExternal, writeExternal, xValidate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.btt.base.Operation
addElement, addOperationRepliedListener, chainTo, close, getApplicationId, getContext, getContextName, getElementAt, getFormat, getFormats, getKeyedCollection, getName, getParent, getService, getType, getValueAt, isChained, prune, removeAt, removeOperationRepliedListener, setApplicationId, setContext, setContextName, setKeyedCollection, setName, setType, setValueAt, unchain, xValidate
 
Methods inherited from interface com.ibm.btt.base.Cacheable
isCacheable, reinitialize
 

Constructor Detail

PageRetrieverOperation

public PageRetrieverOperation()

PageRetrieverOperation

public PageRetrieverOperation(java.lang.String anOperationName)
                       throws java.io.IOException
Constructs a PageRetrieverOperation.

Parameters:
anOperationName - java.lang.String
Throws:
java.io.IOException - The exception description.

PageRetrieverOperation

public PageRetrieverOperation(java.lang.String anOperationName,
                              Context aParentContext)
                       throws java.io.IOException,
                              DSEInvalidRequestException
Throws:
java.io.IOException
DSEInvalidRequestException

PageRetrieverOperation

public PageRetrieverOperation(java.lang.String anOperationName,
                              java.lang.String aParentContext)
                       throws java.io.IOException,
                              DSEObjectNotFoundException,
                              DSEInvalidRequestException
Constructs a PageRetrieverOperation.

Parameters:
anOperationName - java.lang.String
aParentContext - java.lang.String
Throws:
java.io.IOException - The exception description.
com.ibm.dse.base.DSEObjectNotFoundException - The exception description.
com.ibm.dse.base.DSEInvalidRequestException - The exception description.
DSEObjectNotFoundException
DSEInvalidRequestException
Method Detail

execute

public void execute()
             throws java.lang.Exception
Description copied from class: BTTServerOperation
Implements the server operation logic. The execute method should be implemented by subclasses.

Specified by:
execute in interface Operation
Overrides:
execute in class BTTServerOperation
Throws:
java.lang.Exception

getPageData

public abstract int getPageData(int start,
                                int count,
                                java.util.List<PageRetrieverOperation.SortColumn> sortColumnList)
                         throws java.lang.Exception
User need to override the getPageData method to set the pagination data in the indexed Collection named 'items'. The pagination operation context data should be defined according to the following specification: .....

Parameters:
start - start row of the
count - count of page
sortColumnList - column list for sorting, for multiple column sorting, the order of the list is also the order of the sorting column
Returns:
total count of all pages data
Throws:
java.lang.Exception

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011