org.opensubsystems.patterns.listdata.logic
Interface ListController

All Superinterfaces:

org.opensubsystems.core.logic.StatelessController

All Known Implementing Classes:

ListControllerImpl

public interface ListController
extends org.opensubsystems.core.logic.StatelessController

This interface define business logic related to retrieving list of data objects from the persistence store.

Version:

$Id: ListController.java,v 1.9 2007/01/07 06:15:35 bastafidli Exp $

Author:

Julo Legeny

Code reviewer:

Miro Halas

Code reviewed:

1.7 2005/09/27 01:35:34 jlegeny

Method Summary

java.util.List	getDefinitionList(int iDataType) Get definition list (list of generic data)
java.lang.Object[]	getExactPage(ListOptions options) Get list for some specific page.
java.lang.Object[]	getNextPage(ListOptions options) Get list for next page.
java.lang.Object[]	getPreviousPage(ListOptions options) Get list for previous page.
java.lang.Object[]	getSetDefinition(ListOptions options) Get list after list definition has changed..
java.lang.Object[]	getSetOrder(ListOptions options) Get list after order column changed.
java.lang.Object[]	getSetPageSize(ListOptions options) Get list after page size changed.
java.lang.Object[]	getShowList(ListOptions options) Get default list, which is the list to show when the list is displayed the first time.

Methods inherited from interface org.opensubsystems.core.logic.StatelessController

constructor

Method Detail

getShowList

java.lang.Object[] getShowList(ListOptions options)
                               throws org.opensubsystems.core.error.OSSException,
                                      java.rmi.RemoteException

Get default list, which is the list to show when the list is displayed the first time. No parameters have to be initialized for this action

Parameters:

options - - list options

Returns:

Object[] - index 0 - updated list options - index 1 - list of DataObjects - index 2 - object tatatype

Throws:

org.opensubsystems.core.error.OSSException - - an error has occured

java.rmi.RemoteException - - required since this method can be called remotely

getSetDefinition

java.lang.Object[] getSetDefinition(ListOptions options)
                                    throws org.opensubsystems.core.error.OSSException,
                                           java.rmi.RemoteException

Get list after list definition has changed.. These parameters have to be initialized for this action - definitionId

Parameters:

options - - list options

Returns:

Object[] - index 0 - updated list options - index 1 - list of DataObjects - index 2 - object tatatype

Throws:

org.opensubsystems.core.error.OSSException - - an error has occured

java.rmi.RemoteException - - required since this method can be called remotely

getSetOrder

java.lang.Object[] getSetOrder(ListOptions options)
                               throws org.opensubsystems.core.error.OSSException,
                                      java.rmi.RemoteException

Get list after order column changed. These parameters have to be initialized for this action - definitionId - orderDirection - orderCode - pageSize These parameters are considered if they are initialized - selectedItems

Parameters:

options - - list options

Returns:

Object[] - index 0 - updated list options - index 1 - list of DataObjects - index 2 - object tatatype

Throws:

org.opensubsystems.core.error.OSSException - - an error has occured

java.rmi.RemoteException - - required since this method can be called remotely

getSetPageSize

java.lang.Object[] getSetPageSize(ListOptions options)
                                  throws org.opensubsystems.core.error.OSSException,
                                         java.rmi.RemoteException

Get list after page size changed. These parameters have to be initialized for this action - definitionId - orderDirection - orderCode - beginPosition - pageSize These parameters are considered if there are initialized - clientorderDirection - clientOrderCode - firstVisibleItem - selectedItems

Parameters:

options - - list options

Returns:

Object[] - index 0 - updated list options - index 1 - list of DataObjects - index 2 - object tatatype

Throws:

org.opensubsystems.core.error.OSSException - - an error has occured

java.rmi.RemoteException - - required since this method can be called remotely

getPreviousPage

java.lang.Object[] getPreviousPage(ListOptions options)
                                   throws org.opensubsystems.core.error.OSSException,
                                          java.rmi.RemoteException

Get list for previous page. These parameters have to be initialized for this action - definitionId - orderDirection - orderCode - beginPosition - pageSize These parameters are considered if there are initialized - clientorderDirection - clientOrderCode - firstVisibleItem - selectedItems

Parameters:

options - - list options

Returns:

Object[] - index 0 - updated list options - index 1 - list of DataObjects - index 2 - object tatatype

Throws:

org.opensubsystems.core.error.OSSException - - an error has occured

java.rmi.RemoteException - - required since this method can be called remotely

getNextPage

java.lang.Object[] getNextPage(ListOptions options)
                               throws org.opensubsystems.core.error.OSSException,
                                      java.rmi.RemoteException

Get list for next page. These parameters have to be initialized for this action - definitionId - orderDirection - orderCode - endPosition - pageSize These parameters are considered if there are initialized - clientorderDirection - clientOrderCode - firstVisibleItem - selectedItems

Parameters:

options - - list options

Returns:

Object[] - index 0 - updated list options - index 1 - list of DataObjects - index 2 - object tatatype

Throws:

org.opensubsystems.core.error.OSSException - - an error has occured

java.rmi.RemoteException - - required since this method can be called remotely

getExactPage

java.lang.Object[] getExactPage(ListOptions options)
                                throws org.opensubsystems.core.error.OSSException,
                                       java.rmi.RemoteException

Get list for some specific page. These parameters have to be initialized for this action - definitionId - actualPage - orderDirection - orderCode - pageSize These parameters are considered if there are initialized - clientorderDirection - clientOrderCode - firstVisibleItem - selectedItems

Parameters:

options - - list options

Returns:

Object[] - index 0 - updated list options - index 1 - list of DataObjects - index 2 - object tatatype

Throws:

org.opensubsystems.core.error.OSSException - - an error has occured

java.rmi.RemoteException - - required since this method can be called remotely

getDefinitionList

java.util.List getDefinitionList(int iDataType)
                                 throws org.opensubsystems.core.error.OSSException,
                                        java.rmi.RemoteException

Get definition list (list of generic data)

Parameters:

iDataType - - datatype of the object

Returns:

List - definition list (list of generic data)

Throws:

org.opensubsystems.core.error.OSSException - - an error has occured

java.rmi.RemoteException - - required since this method can be called remotely