Interface PControllerBean

All Superinterfaces:
Remote
All Known Subinterfaces:
PComponentController, PIACollectionBean, PIASearch, PSponsorMemberSearchBean, PSponsorOwnerSearchBean
All Known Implementing Classes:
BalanceGroupSearchBeanImpl, PAccountActivityBeanImpl, PAcctTreeBeanImpl, PAdjustEventBeanImpl, PAdjustmentDetailBeanImpl, PARAccountAdjBeanImpl, PARActionDetailBeanImpl, PARAllocateBeanImpl, PARBalancePageBeanImpl, PARBillAdjBeanImpl, PARConnectionAdjBeanImpl, PARDisputesPageBeanImpl, PAREventSearchPageBeanImpl, PARFlexibleBillNowControllerImpl, PARItemAdjustBeanImpl, PARItemDetailsPageBeanImpl, PARRefundBeanImpl, PARUnappliedPageBeanImpl, PARWriteoffBeanImpl, PBillDetailsPageBeanImpl, PBrandBeanImpl, PBrandBeanImpl, PBrowserBeanImpl, PBrowseWinBeanImpl, PChangeStatusBeanImpl, PComponentControllerImpl, PContentOpInvokerBeanImpl, PControllerImpl, PCreditLimitPanelBeanImpl, PCustomerCenterBeanImpl, PCustomerErrorBeanImpl, PCustomizeProductsPanelBeanImpl, PDefaultController, PDeferredActionBeanImpl, PDeviceHistoryBeanImpl, PDeviceSearchPanelBean, PDeviceSettopBeanImpl, PExistingProductsPanelBeanImpl, PFieldController, PFieldControllerBean, PHierarchyLabelPageBeanImpl, PHierarchyMoveAcctBeanImpl, PIAAccountInfoBeanImpl, PIABalanceInfoBeanImpl, PIACanonFieldBeanImpl, PIACanonFieldController, PIACAPackageInfoBeanImpl, PIAComponentCollectionBean, PIACreateAccountBeanImpl, PIACreditCardBeanImpl, PIAExtendedServicesBeanImpl, PIAFieldBean, PIAFieldController, PIAFUSADirDebitBeanImpl, PIAGroupTreeBeanImpl, PIAGroupTreeController, PIAGSMUtilBeanImpl, PIAIndexedArrayTableBeanImpl, PIAInvoicePOBeanImpl, PIAListBeanImpl, PIAListController, PIAMSExchangeUserBeanImpl, PIANotesPanelController, PIAObjectFieldBeanImpl, PIAObjectFieldController, PIAPanelController, PIAPayInfoPanelController, PIAPaymentFieldBeanImpl, PIAPaymentOnFileFieldBeanImpl, PIAPhoneTableBeanImpl, PIAPhoneTableController, PIAProfileBeanImpl, PIAReservedResourcesBeanImpl, PIASearchPanelBean, PIASearchPanelController, PIASearchResultsBeanImpl, PIASearchResultsPanelController, PIASepaBeanImpl, PIAServiceProfileBeanImpl, PIASimpleSearchController, PIASpecSpreadSheetBeanImpl, PIASpecSpreadSheetController, PIASpreadSheetBeanImpl, PIASpreadSheetController, PIATelcoDeviceBeanImpl, PInstantPaymentBeanImpl, PInvoiceBeanImpl, PInvoiceBeanImpl, PLightComponentHelper, PLocaleBeanImpl, PLocaleInfoBeanImpl, PLoginBeanImpl, PMapInfoPageBeanImpl, PMultipleBillsPanelBeanImpl, PNewServicePageBeanImpl, PNotesBeanImpl, POnlinePaymentAuditBeanImpl, POnlinePaymentBeanImpl, PPaymentPageBeanImpl, PPermissionInfoBeanImpl, PPlanOptionsPageBeanImpl, PPPVBeanImpl, PProductDetailsPanelBeanImpl, PProductsBeanImpl, PPurchaseOfferingBeanImpl, PPurchasePanelBeanImpl, PPurchasePlansBeanImpl, PResultsTableBeanImpl, PRolloverReceiverSearchBeanImpl, PRolloverTransferPanelBeanImpl, PServiceDealProductHistoryPanelBeanImpl, PServicesBeanImpl, PServicesDealsProductsTableBeanImpl, PServiceTableBeanImpl, PSettopPanelBeanImpl, PSponsorGroupBeanImpl, PSponsorGroupMembersBeanImpl, PSponsorMemberSearchBeanImpl, PSponsorOwnerSearchBeanImpl, PSponsorshipBeanImpl, PSponsorshipSetupBeanImpl, PSubscriberPrefsBeanImpl, PSummaryBeanImpl, PSummaryPageBeanImpl, PTopupBeanImpl, PVoucherPaymentBeanImpl, SearchController, ServiceSearchBeanImpl

public interface PControllerBean extends Remote
PControllerBean is the MVC controller part of the distributed Portal-aware component set. Classes that support this interface contain the logic associated with each control and can be deployed as an EJB in the future.
Version:
%version: 2 % %date_modified: Wed Apr 11 10:58:46 2001 %
Author:
larrylf
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addRemoteListener(Object remoteListenerHandle)
    If the controller can send events to other controllers, addRemoteListener passes a handle to the remote listener class.
    int[]
    Given a model and a specification for an array in that model, get the range of actual elements in the array.
    Accesses the data model.
    If the component's controller can listen for events from other controllers, getRemoteListenerHandle posts a listener and returns a handle to identify it.
    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.
    boolean
    Determines whether this is a lightweight component.
    void
    Allows the component to register the controller stub it received when the controller was created.
    void
    releaseRemoteListener(Object remoteListenerHandle)
    Removes all listener resources used by the controller.
    void
    removeRemoteListener(Object remoteListenerHandle)
    If the controller can send events to other controllers, removeRemoteListener passes a handle to the remote listener class.
    void
    Passes the model to the controller.
  • Method Details

    • setModel

      void setModel(PModelHandle model) throws RemoteException
      Passes the model to the controller.
      Parameters:
      model - the new data model
      Throws:
      RemoteException - thrown for errors
    • getModel

      PModelHandle getModel() throws RemoteException
      Accesses the data model.
      Returns:
      The data model.
      Throws:
      RemoteException - thrown for errors
    • isLight

      boolean isLight() throws RemoteException
      Determines whether this is a lightweight component. Lightweight components do not have their own model. Instead, they use that of their container. This means that the getModel() method returns null, the setModel() method is ignored, and no property change events are generated. The value returned must be the same in both the component and the controller.
      Returns:
      True if component is lightweight; false otherwise.
      Throws:
      RemoteException
    • getSelectionDataFor

      Object getSelectionDataFor(String dataItem, int index) throws RemoteException
      Given the name of a display data item and an optional index, returns the information needed for a Selection event. The information returned is usually model data.
      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
    • getArrayRange

      int[] getArrayRange(PModelHandle mh, String spec) throws RemoteException
      Given a model and a specification for an array in that model, get the range of actual elements in the array. The returned array will contain the lowest element number in [0], and the highest in [1]. If the array is sparse, each element is iterated starting at [2] otherwise, only the range is provided.
      Parameters:
      mh - a model handle
      spec - a string field descriptiopn
      Returns:
      An integer array that contains the range of actual values.
      Throws:
      RemoteException - thrown for all problems
    • getRemoteListenerHandle

      Object getRemoteListenerHandle(String type) throws RemoteException
      If the component's controller can listen for events from other controllers, getRemoteListenerHandle posts a listener and returns a handle to identify it.
      Parameters:
      type - the type of listener to get
      Returns:
      An object handle to identify the listener.
      Throws:
      RemoteException - thrown for all problems
    • releaseRemoteListener

      void releaseRemoteListener(Object remoteListenerHandle) throws RemoteException
      Removes all listener resources used by the controller.
      Parameters:
      remoteListenerHandle - an object handle returned by getRemoteListenerHandle() from another object
      Throws:
      RemoteException - thrown for all problems
    • addRemoteListener

      void addRemoteListener(Object remoteListenerHandle) throws RemoteException
      If the controller can send events to other controllers, addRemoteListener passes a handle to the remote listener class. The listener is added to the listener list.
      Parameters:
      remoteListenerHandle - an object handle returned by getRemoteListenerHandle() from another object
      Throws:
      RemoteException - thrown for all problems
    • removeRemoteListener

      void removeRemoteListener(Object remoteListenerHandle) throws RemoteException
      If the controller can send events to other controllers, removeRemoteListener passes a handle to the remote listener class. The listener is removed from the listener list.
      Parameters:
      remoteListenerHandle - an object handle returned by getRemoteListenerHandle() from another object
      Throws:
      RemoteException - thrown for all problems
    • register

      void register(PControllerBean stub) throws RemoteException
      Allows the component to register the controller stub it received when the controller was created.
      Parameters:
      stub - the controller stub owned by the client view.
      Throws:
      RemoteException - thrown in case of error
      See Also: