Formspider APIs


Package api_alert


Field Summary
 numberbutton1 CONSTANT := bdf_constant.alertbutton1
           Constant representing the first button in the alert dialog

Value: 0

 numberbutton2 CONSTANT := bdf_constant.alertbutton2
           Constant representing the second button in the alert dialog

Value: 1

 numberbutton3 CONSTANT := bdf_constant.alertbutton3
           Constant representing the second button in the alert dialog

Value: 2

Method Summary
 number getid(in_alertname_tx IN varchar2)
           Returns the ID of the alert dialog.
 varchar2 getlabel(in_alertname_tx IN varchar2)
           Returns the label of the alert.
 number getresponse(in_alertname_tx IN varchar2)
           Returns the user response for an alert.
 varchar2 gettitle(in_alertname_tx IN varchar2)
           Returns the title of the alert.
  setlabel(in_alertname_tx IN varchar2, in_label_tx IN varchar2)
           Updates the label of the alert dialog.
  settitle(in_alertname_tx IN varchar2, in_title_tx IN varchar2)
           Updates the title of the alert dialog.
  show(in_alertname_tx IN varchar2)
           Displays the specified alert on the screen

Field Detail

button1

        public number button1 CONSTANT := bdf_constant.alertbutton1
Constant representing the first button in the alert dialog

Value: 0


button2

        public number button2 CONSTANT := bdf_constant.alertbutton2
Constant representing the second button in the alert dialog

Value: 1


button3

        public number button3 CONSTANT := bdf_constant.alertbutton3
Constant representing the second button in the alert dialog

Value: 2


Method Detail

getid

public number getid(in_alertname_tx IN varchar2)
Returns the ID of the alert dialog.
Parameters:
in_alertname_tx - The name of the alert object.
Throws:
e_invalidalertname - Raised when the alert name is invalid.


getlabel

public varchar2 getlabel(in_alertname_tx IN varchar2)
Returns the label of the alert.
Parameters:
in_alertname_tx - The name of the alert object.
Returns:
Label of the alert
Throws:
e_invalidalertname - Raised when the alert name is invalid.


getresponse

public number getresponse(in_alertname_tx IN varchar2)
Returns the user response for an alert.

The valid values return by this function are implemented as constants BUTTON1, BUTTON2 and BUTTON3. This API function is only meaningful if it is used in the close event of an alert.

Parameters:
in_alertname_tx - The name of the alert object.
Throws:
e_invalidalertname - Raised when the alert name is invalid.


gettitle

public varchar2 gettitle(in_alertname_tx IN varchar2)
Returns the title of the alert.
Parameters:
in_alertname_tx - The name of the alert object.
Returns:
title of the alert
Throws:
e_invalidalertname - Raised when the alert name is invalid.


setlabel

public  setlabel(in_alertname_tx IN varchar2, 
in_label_tx IN varchar2)
Updates the label of the alert dialog.
Parameters:
in_alertname_tx - The name of the alert object.
in_label_tx - The new label
Throws:
e_invalidalertname - Raised when the alert name is invalid.


settitle

public  settitle(in_alertname_tx IN varchar2, 
in_title_tx IN varchar2)
Updates the title of the alert dialog.
Parameters:
in_alertname_tx - The name of the alert object.
in_title_tx - The new label
Throws:
e_invalidalertname - Raised when the alert name is invalid.


show

public  show(in_alertname_tx IN varchar2)
Displays the specified alert on the screen
Parameters:
in_alertname_tx - The name of the alert object.
Throws:
e_invalidalertname - Raised when the alert name is invalid.


Formspider APIs