Formspider APIs


Package api_session


Method Summary
  add(in_name_tx IN varchar2, in_value_tx IN varchar2)
           Creates, updates the parameter value pair in the web session where the value is of type Varchar2.
  add(in_name_tx IN varchar2, in_value_nr IN number)
           Creates, updates the parameter value pair in the web session where the value is of type Number.
  add(in_name_tx IN varchar2, in_value_dt IN date)
           Creates, updates the parameter value pair in the web session where the value is of type Date.
  add(in_name_tx IN varchar2, in_value_cl IN clob)
           Creates, updates the parameter value pair in the web session where the value is of type CLOB.
  authenticate()
           Authenticates the session
  close(in_session_id IN number DEFAULT null)
           Closes the specified session.
 number getid()
           Returns the ID of the session.
 varchar2 getremoteusername()
           Returns the value of the request.getRemoteUser method.
 varchar2 getuserip()
           Returns the IP address of the user
 clob getvaluecl(in_name_tx IN varchar2)
           Returns value of the parameter as CLOB.
 date getvaluedt(in_name_tx IN varchar2)
           Returns value of the parameter as Date.
 number getvaluenr(in_name_tx IN varchar2)
           Returns value of the parameter as Number.
 varchar2 getvaluetx(in_name_tx IN varchar2)
           Returns value of the parameter as Varchar2.
  remove(in_name_tx IN varchar2)
           Deletes the parameter value pair from the web session.
  removeall()
           Deletes all parameter value pairs from the web session.
  setcurrentapplication(in_session_id IN number, in_application_id IN number)
           Updates the current application running in a Formspider web session.
  setcurrentapplication(in_session_id IN number, in_applicationname_tx IN varchar2)
           Updates the current application running in a Formspider web session.

Method Detail

add

public  add(in_name_tx IN varchar2, 
in_value_tx IN varchar2)
Creates, updates the parameter value pair in the web session where the value is of type Varchar2.
Parameters:
in_name_tx - The name of the session parameter.
in_value_tx - The value of the parameter as Varchar2.


add

public  add(in_name_tx IN varchar2, 
in_value_nr IN number)
Creates, updates the parameter value pair in the web session where the value is of type Number.
Parameters:
in_name_tx - The name of the session parameter.
in_value_nr - The value of the parameter as Number.


add

public  add(in_name_tx IN varchar2, 
in_value_dt IN date)
Creates, updates the parameter value pair in the web session where the value is of type Date.
Parameters:
in_name_tx - The name of the session parameter.
in_value_dt - The value of the parameter as Date.


add

public  add(in_name_tx IN varchar2, 
in_value_cl IN clob)
Creates, updates the parameter value pair in the web session where the value is of type CLOB.
Parameters:
in_name_tx - The name of the session parameter.
in_value_cl - The value of the parameter as CLOB.


authenticate

public  authenticate()
Authenticates the session


close

public  close(in_session_id IN number DEFAULT null)
Closes the specified session.
Parameters:
in_session_id - The ID of the web session. (Default value: Current session ID)


getid

public number getid()
Returns the ID of the session.


getremoteusername

public varchar2 getremoteusername()
Returns the value of the request.getRemoteUser method.

For more information please see http://download.oracle.com/docs/cd/E17802_01/webservices/webservices/docs/1.5/api/javax/servlet/http/HttpServletRequest.html#getRemoteUser()


getuserip

public varchar2 getuserip()
Returns the IP address of the user


getvaluecl

public clob getvaluecl(in_name_tx IN varchar2)
Returns value of the parameter as CLOB.
Parameters:
in_name_tx - The name of the session parameter.


getvaluedt

public date getvaluedt(in_name_tx IN varchar2)
Returns value of the parameter as Date.
Parameters:
in_name_tx - The name of the session parameter.


getvaluenr

public number getvaluenr(in_name_tx IN varchar2)
Returns value of the parameter as Number.
Parameters:
in_name_tx - The name of the session parameter.


getvaluetx

public varchar2 getvaluetx(in_name_tx IN varchar2)
Returns value of the parameter as Varchar2.
Parameters:
in_name_tx - The name of the session parameter.


remove

public  remove(in_name_tx IN varchar2)
Deletes the parameter value pair from the web session.
Parameters:
in_name_tx - The name of session


removeall

public  removeall()
Deletes all parameter value pairs from the web session.


setcurrentapplication

public  setcurrentapplication(in_session_id IN number, 
in_application_id IN number)
Updates the current application running in a Formspider web session. This API is used to execute Formspider application events programmaticly from external applications.
Parameters:
in_session_id - The ID of the web session.
in_application_id - The ID of the Formspider application.
Throws:
e_invalidsessionid - Raised when the web session ID does not exist.
e_invalidapplicationname - Raised when the application ID does not exist.


setcurrentapplication

public  setcurrentapplication(in_session_id IN number, 
in_applicationname_tx IN varchar2)
Updates the current application running in a Formspider web session. This API is used to execute Formspider application events programmaticly from external applications.
Parameters:
in_session_id - The ID of the web session.
in_applicationname_tx - The name of the Formspider application.
Throws:
e_invalidsessionid - Raised when the web session ID does not exist.
e_invalidapplicationname - Raised when the application does not exist.


Formspider APIs