Formspider APIs


Package api_application


Field Summary
 varchar2(200)java_renderer CONSTANT := bdf_constant.javarenderer
           Value: 'JAVA'
 varchar2(200)javascript_renderer CONSTANT := bdf_constant.javascriptrenderer
           Value: 'JS'
 varchar2(200)mobile_renderer CONSTANT := bdf_constant.mobilerenderer
           Value: 'MobileJS'

Type Summary
 RECORD t_exportobject(bdf_object_id number, objecttype_cd varchar2(200))
           Record for object that will be exported
 RECORD t_object(type_cd varchar2(200), name_tx varchar2(255))
           Record for object types
 table OF t_exportObject INDEX BY binary_integer tt_exportobjects()
           Table for objects that will be exported

Method Summary
  close()
           Terminate Application session.
  createbookmark(in_bookmark_tx IN varchar2)
           Create bookmark for application.
  docommit()
           Commits initialized datasources in the order of their "Commit Order" attribute.
 xmltype export(in_applicationname_tx IN varchar2, in_includerevisionhistory_yn IN varchar2 DEFAULT 'N', in_parent_xml IN xmltype DEFAULT null)
           Gets specified application xml.
 xmltype export(in_exportobjects_t IN tt_exportobjects, in_includerevisionhistory_yn IN varchar2 DEFAULT 'N', in_parent_xml IN xmltype DEFAULT null)
           Gets specified application xml.
  filedownload(in_link_tx IN varchar2, in_title_tx IN varchar2 DEFAULT null, in_filename_tx IN varchar2 DEFAULT null)
           Downloads the file from url.
 varchar2 getbaseurl()
           Gets base URL of the application
 varchar2 getbookmark()
           Gets bookmark that is defined for application.
 varchar2 getbrowsermessage()
           Gets browser message of the application.
 api_event.t_event getclientevent()
           Gets client event
 varchar2 getdatasourceschema()
           Gets current datasource schema name of the application.
 varchar2 getdatasourceschemaname()
           Deprecated. Use getDatasourceSchema instead.
 api_event.t_event getevent()
           Gets last fired event.
 varchar2 getfocusedcomponent(in_innercomponent_yn IN varchar2 DEFAULT 'N')
           Gets focused component name.
 varchar2 getfocuseddialog()
           Gets the focused dialog name.
 varchar2 getfontcolor()
           Gets font color of the application.
 varchar2 getfontfamily()
           Gets font family of the application.
 number getfontsize()
           Gets font size of the application.
 varchar2 getfontstyle()
           Gets font style of the application.
 number getid()
           Gets ID of the application.
 api_graphics.t_point getkeyeventpoint()
           Gets key event coordinate.
 varchar2 getlanguagecode()
           Gets language code of the application.
 varchar2 getlanguagelocalcode()
           Gets language local code of the application.
 varchar2 getlanguagename()
           Gets language name of the application.
 varchar2 getmultilingualvalue(in_key_cd IN varchar2, in_language_cd IN varchar2 DEFAULT null, in_local_cd IN varchar2 DEFAULT null)
           Gets value of given multilingual key in sepecified language.
 varchar2 getoperatingsystem()
           Gets current operating system of the application
 varchar2 getrenderertype()
           Gets type of the renderer.
 varchar2 getrendererversion()
           Gets version of the renderer.
 api_graphics.t_point getrightclickpoint()
           Gets right click coordinate.
 varchar2 getsourcecodeschemaname()
           Deprecated. Use getDatasourceSchema instead.
 varchar2 isdirty()
           Gets value indicating whether any datasource of application has been changed.
 varchar2 isdmlnecessary()
           Gets value indicating whether any datasource (which doesnt have primary key) of application has been changed.
 varchar2 ismobile()
           Returns the value of the editable attribute of the component.
 varchar2 isstateful()
           Returns Y if the application instance uses the same database session to process user events and returns N if it uses a connection from the Formspider database connection pool.
  login(in_username_tx IN varchar2, in_password_tx IN varchar2, in_brimsession_id IN number DEFAULT null, in_rulename_tx IN varchar2 DEFAULT null)
           Opens "UML User" connection on BRIM-Objects of Datasource Schema, if Datasource Schema has BRIM-Objects installation.
  logoff()
           Closes "UML User" connection on BRIM-Objects of Datasource Schema.
  print(in_url_tx IN varchar2)
           Prints specified url.
  raiseapplicationerror()
           Raises application error which stops execution of current and following events.
  restart()
           Terminate Current application session and restart new one.
  run(in_desktoppath_tx IN varchar2 DEFAULT null, in_weblink_tx IN varchar2 DEFAULT null, in_browserwindowname_tx IN varchar2 DEFAULT null, in_transferfocus_yn IN varchar2 DEFAULT null, in_keepsession_yn IN varchar2 DEFAULT null)
           Deprecated. The in_transferfocus_yn parameter is deprecated. Please do not use the attribute to control the behaviour of focus. The value of attribute will be "Y", even it is specified as "N".
  setbrowsermessage(in_browsermessage_tx IN varchar2)
           Updates browser unload message of application.
  setdatasourceschema(in_datasourceschema_tx IN varchar2)
           Updates current datasource schema of the application.
  setfontcolor(in_fontcolor_cd IN varchar2)
           Updates the Font color of application.
  setfontfamily(in_fontfamily_tx IN varchar2)
           Updates the Font family of application.
  setfontsize(in_fontsize_nr IN number)
           Updates the Font size of application.
  setfontstyle(in_fontstyle_tx IN varchar2)
           Updates the Font style of application.
  setlanguage(in_language_cd IN varchar2, in_local_cd IN varchar2)
           Updates language of application.
  setstateful(in_stateful_yn IN varchar2)
           Switches the way an application uses databases sessions.
  showpopupmessage(in_message_tx IN varchar2)
           Shows popup mesage.

Field Detail

java_renderer

        public varchar2(200) java_renderer CONSTANT := bdf_constant.javarenderer
Value: 'JAVA'

javascript_renderer

        public varchar2(200) javascript_renderer CONSTANT := bdf_constant.javascriptrenderer
Value: 'JS'

mobile_renderer

        public varchar2(200) mobile_renderer CONSTANT := bdf_constant.mobilerenderer
Value: 'MobileJS'

Type Detail

t_exportobject

public RECORD t_exportobject(bdf_object_id number, 
objecttype_cd varchar2(200))
Record for object that will be exported
Parameters:
bdf_object_id - ID of the object
objecttype_cd - Type of the object


t_object

public RECORD t_object(type_cd varchar2(200), 
name_tx varchar2(255))
Record for object types
Parameters:
type_cd - Type of the object
name_tx - Name of the object

Object types can be any component like textField, textLabel, button... Also can be panel, dialog, mainframe.


tt_exportobjects

public table OF t_exportObject INDEX BY binary_integer tt_exportobjects()
Table for objects that will be exported


Method Detail

close

public  close()
Terminate Application session.


createbookmark

public  createbookmark(in_bookmark_tx IN varchar2)
Create bookmark for application.
Parameters:
in_bookmark_tx - Bookmark parameter


docommit

public  docommit()
Commits initialized datasources in the order of their "Commit Order" attribute. If there are datasources with the same "Commit Order", dirty rows are committed individually according to the their update order. Note that current database session is also committed.


export

public xmltype export(in_applicationname_tx IN varchar2, 
in_includerevisionhistory_yn IN varchar2 DEFAULT 'N',
in_parent_xml IN xmltype DEFAULT null)
Gets specified application xml.
Parameters:
in_applicationname_tx - Application name that will be exported
in_includerevisionhistory_yn - Using to add/ignore revision history to xml Clob (Default value:'N')
Returns:
Application xml


export

public xmltype export(in_exportobjects_t IN tt_exportobjects, 
in_includerevisionhistory_yn IN varchar2 DEFAULT 'N',
in_parent_xml IN xmltype DEFAULT null)
Gets specified application xml.
Parameters:
in_exportobjects_t - The list of objects that will be exported.
in_includerevisionhistory_yn - Using to add/ignore revision history to xml Clob (Default value:'N')
Returns:
Application xml


filedownload

public  filedownload(in_link_tx IN varchar2, 
in_title_tx IN varchar2 DEFAULT null,
in_filename_tx IN varchar2 DEFAULT null)
Downloads the file from url.

When this action receives from client, it will see the save dialog titled by param in_title_tx When client click on save button, the file that location at in_link_tx param will save

Parameters:
in_link_tx - Source url
in_title_tx - The title of save dialog (Default value:null)
in_filename_tx - File name (Default value:null)


getbaseurl

public varchar2 getbaseurl()
Gets base URL of the application


getbookmark

public varchar2 getbookmark()
Gets bookmark that is defined for application.
Returns:
Bookmark of the application


getbrowsermessage

public varchar2 getbrowsermessage()
Gets browser message of the application.
Returns:
Browser message of the application


getclientevent

public api_event.t_event getclientevent()
Gets client event
Returns:
Record of event


getdatasourceschema

public varchar2 getdatasourceschema()
Gets current datasource schema name of the application.
Returns:
Datasource schema name of the application


getdatasourceschemaname

public varchar2 getdatasourceschemaname()
Gets current datasource schema name of the application.
Returns:
Datasource schema name of the application

Deprecated:
Use getDatasourceSchema instead.


getevent

public api_event.t_event getevent()
Gets last fired event.
Returns:
Record of event


getfocusedcomponent

public varchar2 getfocusedcomponent(in_innercomponent_yn IN varchar2 DEFAULT 'N')
Gets focused component name.
Parameters:
in_innercomponent_yn - Return inner component name or parent of the component. For instance, if it is marked as N, it returns name of the Grid component. Otherwise it returns name of the component in Grid.
Returns:
Name of focused component


getfocuseddialog

public varchar2 getfocuseddialog()
Gets the focused dialog name.
Returns:
Name of the current dialog which is user work on at that moment


getfontcolor

public varchar2 getfontcolor()
Gets font color of the application.
Returns:
Font color of the application


getfontfamily

public varchar2 getfontfamily()
Gets font family of the application.
Returns:
Font family of the application


getfontsize

public number getfontsize()
Gets font size of the application.
Returns:
Font size of the application


getfontstyle

public varchar2 getfontstyle()
Gets font style of the application.
Returns:
Font style of the application


getid

public number getid()
Gets ID of the application.
Returns:
ID of the application


getkeyeventpoint

public api_graphics.t_point getkeyeventpoint()
Gets key event coordinate.
Returns:
Key event coordinate


getlanguagecode

public varchar2 getlanguagecode()
Gets language code of the application.
Returns:
Language code of the application


getlanguagelocalcode

public varchar2 getlanguagelocalcode()
Gets language local code of the application.
Returns:
Language local code of the application


getlanguagename

public varchar2 getlanguagename()
Gets language name of the application.
Returns:
Language name of the application


getmultilingualvalue

public varchar2 getmultilingualvalue(in_key_cd IN varchar2, 
in_language_cd IN varchar2 DEFAULT null,
in_local_cd IN varchar2 DEFAULT null)
Gets value of given multilingual key in sepecified language. If language code and language local code is null, then function returns value of key in the current language. If there is no value found with given key and language, then function returns null.
Parameters:
in_key_cd - key code
in_language_cd - language code
in_local_cd - local code of language
Returns:
Value of given key
Throws:
e_invalidkey - If in_key_cd is not found
e_invalidlanguageparameter - If in_language_cd and in_local_cd are not found


getoperatingsystem

public varchar2 getoperatingsystem()
Gets current operating system of the application


getrenderertype

public varchar2 getrenderertype()
Gets type of the renderer. The valid values return by this function are implemented as constants JAVA_RENDERER, JAVASCRIPT_RENDERER and MOBILE_RENDERER.
Returns:
Type of the renderer


getrendererversion

public varchar2 getrendererversion()
Gets version of the renderer.
Returns:
Version of the renderer


getrightclickpoint

public api_graphics.t_point getrightclickpoint()
Gets right click coordinate.
Returns:
Right click coordinate


getsourcecodeschemaname

public varchar2 getsourcecodeschemaname()
Gets Source code schema name of the application.
Returns:
Source code schema name of the application

Deprecated:
Use getDatasourceSchema instead.


isdirty

public varchar2 isdirty()
Gets value indicating whether any datasource of application has been changed.
Returns:
Value indicating whether any datasource of application has been changed


isdmlnecessary

public varchar2 isdmlnecessary()
Gets value indicating whether any datasource (which doesnt have primary key) of application has been changed.
Returns:
Value indicating whether any datasource (which doesnt have primary key)of application has been changed


ismobile

public varchar2 ismobile()
Returns the value of the editable attribute of the component.


isstateful

public varchar2 isstateful()
Returns Y if the application instance uses the same database session to process user events and returns N if it uses a connection from the Formspider database connection pool.


login

public  login(in_username_tx IN varchar2, 
in_password_tx IN varchar2,
in_brimsession_id IN number DEFAULT null,
in_rulename_tx IN varchar2 DEFAULT null)
Opens "UML User" connection on BRIM-Objects of Datasource Schema, if Datasource Schema has BRIM-Objects installation. Connection will be opened for subsequent events untill opening another connection with this method or calling api_application.logoff.
Parameters:
in_username_tx - User name
in_password_tx - User password
in_brimsession_id - Brim session ID (Default value:null)
in_rulename_tx - Brim rule name to connect (Default value:null)

Tries to connect to the current rule, if in_ruleName_tx parameter is not used. If current rule is not set before, default rule of BRIM is set as current.

See also:
logoff

logoff

public  logoff()
Closes "UML User" connection on BRIM-Objects of Datasource Schema.

See also:
login(varchar2,varchar2,number,varchar2)

print

public  print(in_url_tx IN varchar2)
Prints specified url.
Parameters:
in_url_tx - URL that will be printed


raiseapplicationerror

public  raiseapplicationerror()
Raises application error which stops execution of current and following events.


restart

public  restart()
Terminate Current application session and restart new one.


run

public  run(in_desktoppath_tx IN varchar2 DEFAULT null, 
in_weblink_tx IN varchar2 DEFAULT null,
in_browserwindowname_tx IN varchar2 DEFAULT null,
in_transferfocus_yn IN varchar2 DEFAULT null,
in_keepsession_yn IN varchar2 DEFAULT null)
Starts an application.
Parameters:
in_desktoppath_tx - Path of source (swing client )
in_weblink_tx - Application link (Default value:null)
in_browserwindowname_tx - The window name in browser
in_transferfocus_yn - (Deprecated) Transfer focus to window in browser or left focus on current window.
in_keepsession_yn - Runs new application in same session. By this way applications can communicate via session variables with each other.

Deprecated:
The in_transferfocus_yn parameter is deprecated. Please do not use the attribute to control the behaviour of focus. The value of attribute will be "Y", even it is specified as "N".


setbrowsermessage

public  setbrowsermessage(in_browsermessage_tx IN varchar2)
Updates browser unload message of application.


setdatasourceschema

public  setdatasourceschema(in_datasourceschema_tx IN varchar2)
Updates current datasource schema of the application.
Throws:
e_insufficientprivilege - If application is owned by a guest user


setfontcolor

public  setfontcolor(in_fontcolor_cd IN varchar2)
Updates the Font color of application.
Parameters:
in_fontcolor_cd - Font color of the application. Please see API_COLOR for the valid list of values for this input parameter.
Throws:
e_invalidcolor - Raised when the input color value is not a valid color.

See also:
api_color

setfontfamily

public  setfontfamily(in_fontfamily_tx IN varchar2)
Updates the Font family of application.
Parameters:
in_fontfamily_tx - Font family of the application


setfontsize

public  setfontsize(in_fontsize_nr IN number)
Updates the Font size of application.
Parameters:
in_fontsize_nr - Font size of the application


setfontstyle

public  setfontstyle(in_fontstyle_tx IN varchar2)
Updates the Font style of application.
Parameters:
in_fontstyle_tx - Font style of the application


setlanguage

public  setlanguage(in_language_cd IN varchar2, 
in_local_cd IN varchar2)
Updates language of application.
Parameters:
in_language_cd - Language code
in_local_cd - Local language code
Throws:
e_invalidlanguageparameter - if language parameters is invalid


setstateful

public  setstateful(in_stateful_yn IN varchar2)
Switches the way an application uses databases sessions.
Parameters:
in_stateful_yn - if the value of this parameter is set to Y then the application instance begins using the same database session for each event starting with the next client request. If the value is set to N, the application instance begins using a database connection from the Formspider database connection pool for each event starting with the next client request.


showpopupmessage

public  showpopupmessage(in_message_tx IN varchar2)
Shows popup mesage.
Parameters:
in_message_tx - Message content


Formspider APIs