create_session function

Related topics

Contained in package wwa_api_module_session.

Call this function to create an instance of a form component session.

The form component session instance is created in the database and prepared for interaction with the client form. The form component framework calls this API internally before displaying a form component for the first time within a given session, or when instructed to create a new instance of the form component.

Since this is a static function, it should be invoked as:
<portal_schema>.wwa_api_module_session.create_session

static function create_session
(
p_module_id in integer,
p_version in integer
)
return wwa_api_module_session,

Version: Oracle Portal 3.0.9

Parameters:

p_module_id

The ID of the form component for which a session must be instantiated.

Datatype: integer

p_version

The version of the form component.

Note: The value 1 is always passed since the session for a form component is not versioned.

Datatype: integer

Return:

This function returns a wwa_api_module_session object which can be used to manipulate the properties of the newly create storage.

Exceptions:

Any exception raised, is raised to the calling program.

Example:

Consider an Oracle Portal form component based on the SCOTT.EMP table which has a module_id of 7. To instantiate a session for this form component:
declare
    l_session wwa_api_module_session;
begin
    l_session := <portal_schema>.wwa_api_module_session.create_session (
                           p_module_id => 7,
                           p_version => 1
    );
end;

Version: Oracle Portal 3.0.9
Parameters:
p_module_id	The ID of the form component for which a session must be instantiated. Datatype: integer
p_version	The version of the form component. Note: The value 1 is always passed since the session for a form component is not versioned. Datatype: integer
Return: This function returns a wwa_api_module_session object which can be used to manipulate the properties of the newly create storage. Exceptions: Any exception raised, is raised to the calling program. Example: Consider an Oracle Portal form component based on the SCOTT.EMP table which has a module_id of 7. To instantiate a session for this form component: declare l_session wwa_api_module_session; begin l_session := <portal_schema>.wwa_api_module_session.create_session ( p_module_id => 7, p_version => 1 ); end;

Related topics
Form component session API package	PDK PL/SQL API Reference - Home