Package com.portal.app.comp

Class PIASearchPanelController

java.lang.Object

com.portal.bas.PControllerImpl

com.portal.bas.PComponentControllerImpl

com.portal.bas.comp.PIAPanelController

com.portal.app.comp.PIASearchPanelController

All Implemented Interfaces:

PComponentController, PControllerBean, PropertyChangeListener, Serializable, Remote, Unreferenced, EventListener

public class PIASearchPanelController
extends PIAPanelController

Controller class for the generic search component. A global step search is used and the data is sent to interested listeners (if remote listeners exist) or back to the client incrementally. This controller uses a complex search, so you can search with any field combination (unlike the regular admin).
Because this uses a complex search, it needs to know what storable classes to search in. It currently looks in /account, /payinfo/cc, and /services. Additional code will need to be added if you add search criteria to the panel that falls outside these known classes. Adding additional fields from the /account class should be ok. But even adding additional fields from /payinfo/cc or /services may require additional tweaks to this code. We hope to make it more flexible as we move forward.

Version:

%revision%

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.portal.bas.PControllerImpl

mFList, mRemoteListeners, UPDATE_CLIENT, UPDATE_MODEL_CHANGE, UPDATE_NEW_MODEL, UPDATE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
PIASearchPanelController()	Creates the search panel controller

Method Summary

Modifier and Type	Method	Description
Object	actionPerformed(ActionEvent event)	Handles an action performed in the GUI.
protected void	fireResultsEvent(PModelHandle[] out)
Object	getSelectionDataFor(String dataItem, int index)	Given the name of a display data item and an optional index, returns the information needed for a Selection event.
protected void	handleDistributeToListener(Object listener, EventObject evt)	Called by distributeEventToListeners to pass an event to specific listener methods.

Methods inherited from class com.portal.bas.comp.PIAPanelController

getRemoteListenerHandle, propertyChange, update

Methods inherited from class com.portal.bas.PComponentControllerImpl

fireDataChangeEvent, fireDataChangeEvent, fireDataChangeEvent, fireDataChangeEvent, getConnection, getProperty, getView, setDisplayComponent, setProperty, update

Methods inherited from class com.portal.bas.PControllerImpl

addRemoteListener, closeSecContext, createClientException, distributeEventToListeners, fireModelChangeEvent, getAppController, getArrayRange, getContext, getField, getField, getField, getFieldWithRestriction, getFieldWithRestriction, getFieldWithRestriction, getModel, getSecContext, isLight, register, releaseContext, releaseRemoteListener, removeRemoteListener, setField, setField, setModel, unreferenced

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.portal.bas.PControllerBean

addRemoteListener, getArrayRange, getModel, isLight, register, releaseRemoteListener, removeRemoteListener, setModel

Constructor Details

PIASearchPanelController

public PIASearchPanelController()
                         throws RemoteException

Creates the search panel controller

Throws:

RemoteException

Method Details

actionPerformed

public Object actionPerformed(ActionEvent event)
                       throws RemoteException

Description copied from class: PIAPanelController

Handles an action performed in the GUI.

Specified by:

actionPerformed in interface PComponentController

Overrides:

actionPerformed in class PIAPanelController

Parameters:

event - - event issued by the client to begin the search process

Returns:

An object may be returned as a result of action processing.

Throws:

RemoteException - thrown for errors

fireResultsEvent

protected void fireResultsEvent(PModelHandle[] out)

handleDistributeToListener

protected void handleDistributeToListener(Object listener,
 EventObject evt)

Description copied from class: PControllerImpl

Called by distributeEventToListeners to pass an event to specific listener methods. When overriding this method, be sure to pass calls for unknown listener classes to the parent controller to handle other types of event objects.

Overrides:

handleDistributeToListener in class PControllerImpl

Parameters:

listener - the listener to call a method for

evt - the event object to distribute

getSelectionDataFor

public Object getSelectionDataFor(String dataItem,
 int index)
                           throws RemoteException

Description copied from class: PIAPanelController

Given the name of a display data item and an optional index, returns the information needed for a Selection event.

Specified by:

getSelectionDataFor in interface PControllerBean

Overrides:

getSelectionDataFor in class PIAPanelController

Parameters:

dataItem - the name of a data item. Must match the name of an item changed by sending a PViewDataChangeEvent.

index - an optional index into an array data item

Returns:

Usually, a model handle or array of model handles.

Throws:

RemoteException - thrown for errors