Formspider APIs


Package api_recordlist

Deprecated:
Use API_LOV instead

See also:
API_LOV

Field Summary
 numberbutton_cancel CONSTANT := bdf_constant.alertbutton2
          
 numberbutton_ok CONSTANT := bdf_constant.alertbutton1
          
 numberbuttoncancel CONSTANT := bdf_constant.alertbutton2
          
 numberbuttonok CONSTANT := bdf_constant.alertbutton1
          

Method Summary
 varchar2 getcancellabel(in_recordlistname_tx IN varchar2)
           Returns the label of the cancel button.
 number getheight(in_recordlistname_tx IN varchar2)
           Returns the height of the recordlist in pixels.
 api_graphics.t_point getlocation(in_recordlistname_tx IN varchar2)
           Return the position of the upper left corner of the recorlist.
 varchar2 getoklabel(in_recordlistname_tx IN varchar2)
           Returns the label of the OK button.
 varchar2 getrecordlistcolumnlabel(in_recordlistdotcolumnname_tx IN varchar2)
           Returns the recorlist column label.
 varchar2 getrecordlistcolumnwidth(in_recordlistdotcolumnname_tx IN varchar2)
           Returns the recorlist column width in pixels.
 number getresponse(in_recordlistname_tx IN varchar2)
           Returns the response of the user to the displayed recorlist.
 varchar2 getsearchlabel(in_recordlistname_tx IN varchar2)
           Returns the label of the search button.
 varchar2 gettitle(in_recordlistname_tx IN varchar2)
           Returns the title of the recorlist.
 number getwidth(in_recordlistname_tx IN varchar2)
           Returns the width of the recorlist in pixels.
 varchar2 isautorefresh(in_recordlistname_tx IN varchar2)
           Returns whether the recorlist automatically executes the query of its datasource every time it appears on the screen.
 varchar2 isrecordlistcolumnvisible(in_recordlistdotcolumnname_tx IN varchar2)
           Returns whether the recorlist column is visible.
  setautorefresh(in_recordlistname_tx IN varchar2, in_autorefresh_yn IN varchar2)
           Updates whether the recorlist automatically executes the query of its datasource every time it appears on the screen.
  setcancellabel(in_recordlistname_tx IN varchar2, in_label_tx IN varchar2)
           Updates the label of the cancel button.
  setheight(in_recordlistname_tx IN varchar2, in_height_nr IN number)
           Updates the height of the recorlist.
  setlocation(in_recordlistname_tx IN varchar2, in_location_r IN api_graphics.t_point)
           Updates the position of the recorlist on the screen.
  setoklabel(in_recordlistname_tx IN varchar2, in_oklabel_tx IN varchar2)
           Updates the OK label of the recorlist.
  setrecordlistcolumnlabel(in_recordlistdotcolumnname_tx IN varchar2, in_label_tx IN varchar2)
           Updates the label of the recorlist column.
  setrecordlistcolumnvisible(in_recordlistdotcolumnname_tx IN varchar2, in_visible_yn IN varchar2)
           Updates Display state of the recorlist column.
  setrecordlistcolumnwidth(in_recordlistdotcolumnname_tx IN varchar2, in_columnwidth_tx IN varchar2)
           Updates the width of the recorlist column.
  setsearchfield(in_recordlistname_tx IN varchar2, in_datasourcedotbindvar_tx IN varchar2, in_value_tx IN varchar2)
           Updates the value in the search text field.
  setsearchlabel(in_recordlistname_tx IN varchar2, in_label_tx IN varchar2)
           Updates the label of the search button.
  settitle(in_recordlistname_tx IN varchar2, in_title_tx IN varchar2)
           Updates the title of the recorlist.
  setwidth(in_recordlistname_tx IN varchar2, in_width_nr IN number)
           Sets new width value to recorlist.
  show(in_recordlistname_tx IN varchar2)
           Displays the recorlist on the screen.

Field Detail

button_cancel

        public number button_cancel CONSTANT := bdf_constant.alertbutton2

button_ok

        public number button_ok CONSTANT := bdf_constant.alertbutton1

buttoncancel

        public number buttoncancel CONSTANT := bdf_constant.alertbutton2

buttonok

        public number buttonok CONSTANT := bdf_constant.alertbutton1

Method Detail

getcancellabel

public varchar2 getcancellabel(in_recordlistname_tx IN varchar2)
Returns the label of the cancel button.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


getheight

public number getheight(in_recordlistname_tx IN varchar2)
Returns the height of the recordlist in pixels.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


getlocation

public api_graphics.t_point getlocation(in_recordlistname_tx IN varchar2)
Return the position of the upper left corner of the recorlist.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


getoklabel

public varchar2 getoklabel(in_recordlistname_tx IN varchar2)
Returns the label of the OK button.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


getrecordlistcolumnlabel

public varchar2 getrecordlistcolumnlabel(in_recordlistdotcolumnname_tx IN varchar2)
Returns the recorlist column label.
Parameters:
in_recordlistdotcolumnname_tx - The name of the recordlist column in the RecordlistName.columnName format. Example: myRecordlist.column1
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_recordlistDotColumnName_tx parameter is in incorrect format.


getrecordlistcolumnwidth

public varchar2 getrecordlistcolumnwidth(in_recordlistdotcolumnname_tx IN varchar2)
Returns the recorlist column width in pixels.
Parameters:
in_recordlistdotcolumnname_tx - The name of the recordlist column in the RecordlistName.columnName format. Example: myRecordlist.column1
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_recordlistDotColumnName_tx parameter is in incorrect format.


getresponse

public number getresponse(in_recordlistname_tx IN varchar2)
Returns the response of the user to the displayed recorlist.

If the user clicks the OK button constant BUTTON_OK is returned. If the user clicks the Cancel button constant BUTTON_CANCEL is returned.

Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


getsearchlabel

public varchar2 getsearchlabel(in_recordlistname_tx IN varchar2)
Returns the label of the search button.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


gettitle

public varchar2 gettitle(in_recordlistname_tx IN varchar2)
Returns the title of the recorlist.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the Recordlist does not exist in the application.


getwidth

public number getwidth(in_recordlistname_tx IN varchar2)
Returns the width of the recorlist in pixels.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the Recordlist does not exist in the application.


isautorefresh

public varchar2 isautorefresh(in_recordlistname_tx IN varchar2)
Returns whether the recorlist automatically executes the query of its datasource every time it appears on the screen.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the Recordlist does not exist in the application.


isrecordlistcolumnvisible

public varchar2 isrecordlistcolumnvisible(in_recordlistdotcolumnname_tx IN varchar2)
Returns whether the recorlist column is visible.
Parameters:
in_recordlistdotcolumnname_tx - The name of the recordlist column in the RecordlistName.columnName format. Example: myRecordlist.column1
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_recordlistDotColumnName_tx parameter is in incorrect format.


setautorefresh

public  setautorefresh(in_recordlistname_tx IN varchar2, 
in_autorefresh_yn IN varchar2)
Updates whether the recorlist automatically executes the query of its datasource every time it appears on the screen.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_autorefresh_yn - The new value of the autorefresh attribute.
Throws:
e_invalidrecordlistname - Raised when the Recordlist does not exist in the application.


setcancellabel

public  setcancellabel(in_recordlistname_tx IN varchar2, 
in_label_tx IN varchar2)
Updates the label of the cancel button.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_label_tx - The new value of the cancel label.
Throws:
e_invalidrecordlistname - Raised when the Recordlist does not exist in the application.


setheight

public  setheight(in_recordlistname_tx IN varchar2, 
in_height_nr IN number)
Updates the height of the recorlist.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_height_nr - The new height of the recorlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


setlocation

public  setlocation(in_recordlistname_tx IN varchar2, 
in_location_r IN api_graphics.t_point)
Updates the position of the recorlist on the screen.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_location_r - The new position of the recorlist on the screen.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


setoklabel

public  setoklabel(in_recordlistname_tx IN varchar2, 
in_oklabel_tx IN varchar2)
Updates the OK label of the recorlist.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_oklabel_tx - New label value
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


setrecordlistcolumnlabel

public  setrecordlistcolumnlabel(in_recordlistdotcolumnname_tx IN varchar2, 
in_label_tx IN varchar2)
Updates the label of the recorlist column.
Parameters:
in_recordlistdotcolumnname_tx - The name of the recordlist column in the RecordlistName.columnName format. Example: myRecordlist.column1
in_label_tx - Column label
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_recordlistDotColumnName_tx parameter is in incorrect format.


setrecordlistcolumnvisible

public  setrecordlistcolumnvisible(in_recordlistdotcolumnname_tx IN varchar2, 
in_visible_yn IN varchar2)
Updates Display state of the recorlist column.
Parameters:
in_recordlistdotcolumnname_tx - The name of the recordlist column in the RecordlistName.columnName format. Example: myRecordlist.column1
in_visible_yn - new value for the visible attribute
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_recordlistDotColumnName_tx parameter is in incorrect format.


setrecordlistcolumnwidth

public  setrecordlistcolumnwidth(in_recordlistdotcolumnname_tx IN varchar2, 
in_columnwidth_tx IN varchar2)
Updates the width of the recorlist column.
Parameters:
in_recordlistdotcolumnname_tx - The name of the recordlist column in the RecordlistName.columnName format. Example: myRecordlist.column1
in_columnwidth_tx - Column width
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_recordlistDotColumnName_tx parameter is in incorrect format.


setsearchfield

public  setsearchfield(in_recordlistname_tx IN varchar2, 
in_datasourcedotbindvar_tx IN varchar2,
in_value_tx IN varchar2)
Updates the value in the search text field.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_datasourcedotbindvar_tx - The name of datasource and it's bind variable('datasource.bindvar')
in_value_tx - The new value of the search field.
Throws:
e_invalidrecordlistname - Raised when the recorlist does not exist in the application.
e_invalidbindvarname - Raised when the bind variable does not exist in the application.
e_invalidinputformat - Raised when the value of the in_datasourceDotbindVar_tx parameter is in incorrect format.


setsearchlabel

public  setsearchlabel(in_recordlistname_tx IN varchar2, 
in_label_tx IN varchar2)
Updates the label of the search button.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_label_tx - The new value of the search label.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


settitle

public  settitle(in_recordlistname_tx IN varchar2, 
in_title_tx IN varchar2)
Updates the title of the recorlist.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_title_tx - The new title of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


setwidth

public  setwidth(in_recordlistname_tx IN varchar2, 
in_width_nr IN number)
Sets new width value to recorlist.
Parameters:
in_recordlistname_tx - The name of the recordlist.
in_width_nr - The new width of the recorlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.


show

public  show(in_recordlistname_tx IN varchar2)
Displays the recorlist on the screen.
Parameters:
in_recordlistname_tx - The name of the recordlist.
Throws:
e_invalidrecordlistname - Raised when the recordlist does not exist in the application.
e_notboundtodatasourcecolumn - Raised when the recordlist is not bound to a datasource column.


Formspider APIs