Overview | Package | Object Type | Deprecated | Index | Help
| Oracle9iAS Portal PL/SQL API Reference - 9.0.2.6
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES
SUMMARY: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE | DETAIL: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE

## Package wwpro_api_adapter

This package contains methods to work with portlets deployed via the Federated Portal Adapter.

Use these methods when writing database providers which have portlets which may be accessed from another Portal (via HTTP) using the Federated Portal Adapter. The Federated Portal Adapter component allows database providers (written in PL/SQL) to be accessed as if they are Web providers, i.e. via HTTP.

Oracle9iAS Portal communicates with Web providers via HTTP and SOAP, and using PDK-Java you can easily develop providers in Java that receive SOAP messages and respond accordingly. However, providers do not have to be written in Java. Providing they receive and respond to SOAP messages sent by Oracle9iAS Portal, providers can be written in any language.

The Federated Portal Adapter receives SOAP messages for a Web provider, parses the SOAP and then dispatches the messages to a database provider as PL/SQL procedure calls. In effect, the Federated Portal Adapter makes a database provider behave exactly the same way as a Web provider, allowing users to distribute their database providers across database servers. All remote providers can be treated as Web providers, hiding their implementation (database or Web) from the user.

Scope:
  Public
Since:
  Oracle9iAS Portal 9.0.2

Function/Procedure Summary
`is_call_via_adapter` Returns whether or not the current call is via the Federated Portal Adapter. | `boolean`
`open_form` Opens a form on a portlet's customize page. | ``

Function/Procedure Detail

### is_call_via_adapter

    function is_call_via_adapter
    return boolean

  Returns whether or not the current call is via the Federated Portal Adapter.

  Example:

           wwpro_api_adapter.is_call_via_adapter;

  Returns:
    This function returns TRUE if the current call is via the Federated Portal Adapter, FALSE otherwise.
  Since:
    Oracle9iAS Portal 9.0.2

### open_form

    procedure open_form(
        p_formattr in varchar2,
        p_prr in wwpro_api_provider.portlet_runtime_record
    )

  Opens a form on a portlet's customize page.

  Call this procedure to open a form on a portlet's customize page in a manner suitable for use in a portlet which may be deployed using the Federated Portal Adapter.

  This means that customization is performed in the same way as PDK-Java, i.e. via a call to htp.formOpen and then htp.formHidden for these parameter names:

  - p_action
  - _dad
  - _schema
  - _type
  - _providerid
  - _portletid
  - _backurl
  - _mode
  - _referencepath

  These parameters are needed by the Parallel Page Engine (PPE) to show the portlet again. This is exactly the same as the parameters on the customization form for PDK-Java portlets. For example, user clicks:

  - OK - PPE shows page again, saves parameters and redirects to the value passed in _backurl.
  - APPLY - PPE shows page again and saves parameters.
  - CANCEL - User goes back to value passed in _backurl.
  - RESET - PPE shows page again but parameters are not saved.

  Subsequent htp.formHidden calls may be made for other parameter names and values to be saved, e.g. new Title for the portlet.

  Example:

           wwpro_api_adapter.open_form
           (
               p_formattr => 'NAME="customfolder"',
               p_prr      => p_portlet_runtime_record
           );

  Parameters:
    `p_formattr` - the form attributes (equivalent to the cattributes parameter of htp.formOpen)
    `p_prr` - the portlet runtime record containing the parameter values used to populate the form
  Since:
    Oracle9iAS Portal 9.0.2

Overview | Package | Object Type | Deprecated | Index | Help
| Oracle9iAS Portal PL/SQL API Reference - 9.0.2.6
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES
SUMMARY: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE | DETAIL: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE