Formspider APIs


Package api_datasource


Field Summary
 numberall_rows CONSTANT := bdf_datasource_mng.g_updateallrows
           Used for updating column values of all rows with setColumnValue or deleting all rows of datasources with deleteRowById
 varchar2(200)analyze_all_rows CONSTANT := bdf_datasource_mng.g_analyzeallrows
          
 varchar2(200)analyze_dml_rows CONSTANT := bdf_datasource_mng.g_analyzedmlrows
          
 varchar2(200)clear_all CONSTANT := bdf_datasource_mng.g_clearall
           Erases all the rows in the datasource as well as the snapshot
 varchar2(200)clear_current CONSTANT := bdf_datasource_mng.g_clearcurrent
           Erases all the rows that are currently in the datasource.
 varchar2(200)clear_snapshots CONSTANT := bdf_datasource_mng.g_clearsnapshots
           Erases all the snapshot information from the datasource.
 varchar2(200)clearall CONSTANT := bdf_datasource_mng.g_clearall
          
 varchar2(200)clearcurrent CONSTANT := bdf_datasource_mng.g_clearcurrent
          
 varchar2(200)clearsnapshots CONSTANT := bdf_datasource_mng.g_clearsnapshots
          
 varchar2(200)datatype_blob CONSTANT := bdf_constant.datatypeblob
           Value: 'BLOB'
 varchar2(200)datatype_clob CONSTANT := bdf_constant.datatypeclob
           Value: 'CLOB'
 varchar2(200)datatype_date CONSTANT := bdf_constant.datatypedate
           Value: 'DATE'
 varchar2(200)datatype_number CONSTANT := bdf_constant.datatypenumber
           Value: 'NUMBER'
 varchar2(200)datatype_varchar2 CONSTANT := bdf_constant.datatypevarchar2
           Value: 'VARCHAR2'
 varchar2(200)file_format_xls CONSTANT := bdf_constant.fileformatxls
           Value: 'xls'
 varchar2(200)file_format_xlsx CONSTANT := bdf_constant.fileformatxlsx
           Value: 'xlsx'
 varchar2(200)keep_current_value CONSTANT := bdf_constant.keepcurrentvalue
          
 varchar2(200)keepcurrentvalue CONSTANT := bdf_constant.keepcurrentvalue
          
 varchar2(200)row_status_deleted CONSTANT := bdf_datasource_mng.g_deleted
           Constant that represents the deleted row status.
 varchar2(200)row_status_new CONSTANT := bdf_datasource_mng.g_new
           Constant that represents the new row status.
 varchar2(200)row_status_temp CONSTANT := bdf_datasource_mng.g_temp
           Constant that represents the new row status which is not modified yet.
 varchar2(200)row_status_updated CONSTANT := bdf_datasource_mng.g_updated
           Constant that represents the updated status.

Type Summary
 RECORD t_columns(name_tx varchar2(255), datatype_cd varchar2(200))
           Record of column holds name and datatype
 RECORD t_excelcolumns(datasourcecolumnname_tx varchar2(255), label_tx varchar2(4000), format_tx varchar2(255))
           Record type for the excel column object.
 RECORD t_requiredcolumnviolation(row_id number, columns_t tt_columns)
           Type holds a datasource row ID that has missing values for some of its required columns.
 bdf_datasource_mng.t_rowColumn t_rowcolumn()
           Type that represents a datasource column.
 bdf_datasource_mng.tt_searchField tt_bindvarvalue()
           Type that represents a list of bind variable-value pairs with potential operand overrides.
 table OF t_columns INDEX BY binary_integer tt_columns()
           Table type that holds a list of column names and datatypes.
 bdf_criterion_api.tt_criterionName tt_criterionname()
           Type that represents a list of criterion names.
 table OF varchar2(255) INDEX BY binary_integer tt_datasourcecolumnnames()
           Table type that holds a list of datasource column names.
 table OF varchar2(255) INDEX BY binary_integer tt_datasourcenames()
           Table type that holds a list of datasource names.
 table OF t_excelColumns INDEX BY binary_integer tt_excelcolumns()
           Table type to hold datasource column information to be printed in excel file
 table OF t_requiredColumnViolation INDEX BY binary_integer tt_requiredcolumnviolation()
           Table type that holds a list of datasource row ID's and the list of mandatory columns for each row that has null value.
 bdf_datasource_mng.tt_row tt_row()
           Type that represents a datasource row.
 bdf_datasource_mng.tt_rows tt_rows()
           Table type that represents a set of datasource rows.

Method Summary
 tt_criterionname all_criteria()
           Constant that represents a list of all criteria in the Datasource Definition.
  clear(in_datasourcename_tx IN varchar2, in_clearoption_cd IN varchar2 DEFAULT clear_current)
           Delete the rows from the datasource.
 number createrow(in_datasourcename_tx IN varchar2, in_nextsiblingrow_id IN number DEFAULT null, in_nextsiblingpk_tx IN varchar2 DEFAULT null)
           Creates a new row in the datasource and returns its row ID.
 number createrowbyrownumber(in_datasourcename_tx IN varchar2, in_rownumberinpage_nr IN number, in_page_nr IN number DEFAULT null)
           Creates a new row in the data and returns the datasource row ID of the newly created row.
  deletecurrentrow(in_datasourcename_tx IN varchar2)
           Deprecated. Use deleteRow instead.
  deleterow(in_datasourcename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Deletes the row from the datasource.
  deleterowbyid(in_datasourcename_tx IN varchar2, in_row_id IN number)
           Deprecated. Use deleteRow instead.
  deleterowbyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid)
           Deletes the row from the datasource using its Oracle row id.
  deleterowbypk(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2)
           Deletes the row from the datasource using the rows primary key.
  docommit(in_datasourcename_tx IN varchar2)
           Commits specified datasource.
  docommit(in_datasourcenames_tt IN tt_datasourcenames)
           Commits specified datasources in the order of their "Commit Order" attribute.
  download(in_datasourcedotcolumn_tx IN varchar2, in_filename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Downloads specified BLOB as a file.
  executequery(in_datasourcename_tx IN varchar2, in_page_nr IN number DEFAULT null, in_rowsperpage_nr IN number DEFAULT -1, in_whereclause_tx IN varchar2 DEFAULT keep_current_value, in_orderbyclause_tx IN varchar2 DEFAULT keep_current_value)
           Runs the query of the datasource and populates it with the row set returned.
  firstrow(in_datasourcename_tx IN varchar2)
           Sets first row of the datasource as the current row.
 date getbindvarvaluedt(in_datasourcedotbindvar_tx IN varchar2)
           Returns the bind variable value as Date.
 number getbindvarvaluenr(in_datasourcedotbindvar_tx IN varchar2)
           Returns the bind variable value as Number.
 varchar2 getbindvarvaluetx(in_datasourcedotbindvar_tx IN varchar2)
           Returns the bind variable value as Varchar2.
 tt_columns getcolumnnames(in_datasourcename_tx IN varchar2)
           Returns the table of column names and datatypes
 blob getcolumnvaluebl(in_datasourcedotcolumn_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the value of the row's BLOB column.
 blob getcolumnvalueblbyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns the value of the row's BLOB column using the row's Oracle row id.
 blob getcolumnvalueblbypk(in_datasourcedotcolumn_tx IN varchar2, in_pk_tx IN varchar2)
           Returns the value of the row's BLOB column using the row's primary key.
 clob getcolumnvaluecl(in_datasourcedotcolumn_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the value of the row's CLOB column.
 clob getcolumnvalueclbyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns the value of the row's CLOB column using the row's Oracle row id.
 clob getcolumnvalueclbypk(in_datasourcedotcolumn_tx IN varchar2, in_pk_tx IN varchar2)
           Returns the value of the row's CLOB column using the row's primary key.
 date getcolumnvaluedt(in_datasourcedotcolumn_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the value of the row's Date column.
 date getcolumnvaluedtbyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns the value of the row's Date column using the row's Oracle row id.
 date getcolumnvaluedtbypk(in_datasourcedotcolumn_tx IN varchar2, in_pk_tx IN varchar2)
           Returns the value of the row's Date column using the row's primary key.
 number getcolumnvaluenr(in_datasourcedotcolumn_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the value of the row's Number column.
 number getcolumnvaluenrbyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns the value of the row's Number column using the row's Oracle row id.
 number getcolumnvaluenrbypk(in_datasourcedotcolumn_tx IN varchar2, in_pk_tx IN varchar2)
           Returns the value of the row's Number column using the row's primary key.
 varchar2 getcolumnvaluetx(in_datasourcedotcolumn_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the value of the row's Varchar2 column.
 varchar2 getcolumnvaluetxbyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns the value of the row's Varchar2 column using the row's Oracle row id.
 varchar2 getcolumnvaluetxbypk(in_datasourcedotcolumn_tx IN varchar2, in_pk_tx IN varchar2)
           Returns the value of the row's Varchar2 column using the row's primary key.
 number getcompleterowcount(in_datasourcename_tx IN varchar2)
           Returns the number of rows by executing a select count(*) using the query of the datasource.
 number getcurrentpage(in_datasourcename_tx IN varchar2)
           Returns the current page number the datasource is on.
 number getcurrentrowid(in_datasourcename_tx IN varchar2)
           Returns the datasource row ID of the current row.
 varchar2 getdefaultquery(in_datasourcename_tx IN varchar2)
           Get the query of the datasource.
 number getfilteredrowcount(in_datasourcename_tx IN varchar2)
           Returns the number of row in the datasource without ignoring any filters it might have.
 varchar2 getfilterorderbyclause(in_datasourcename_tx IN varchar2)
           Returns the order by clause of the datasource filter.
 varchar2 getfilterwhereclause(in_datasourcename_tx IN varchar2)
           Returns the where clause of the datasource filter.
 number getid(in_datasourcename_tx IN varchar2)
           Returns the run time ID of the datasource object.
 number getmaxrowfetch(in_datasourcename_tx IN varchar2)
           Returns the maximum number of rows the datasource will fetch when its query is executed.
 rowid getorarowid(in_datasourcename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the value of the datasource row's Oracle row id.
 varchar2 getpkcolumnname(in_datasourcename_tx IN varchar2)
           Returns the name of the primary key of the datasource.
 number getpreviouscurrentrowid(in_datasourcename_tx IN varchar2)
           Returns the previous current row ID of the datasource.
 varchar2 getquery(in_datasourcename_tx IN varchar2, in_includedeletedrows_yn IN varchar2 DEFAULT 'N')
           Returns an SQL that bring back the rows in a datasource.
 tt_requiredcolumnviolation getrequiredcolumnviolations(in_datasourcename_tx IN varchar2, in_analyzeoption_cd IN varchar2 DEFAULT analyze_all_rows)
           Returns the list of rows of a datasource that have null values in their required columns.
 tt_row getrow(in_datasourcename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns a row of the datasource disregarding any filters it may have.
 tt_row getrowbyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns a row of the datasource using the row's Oracle row id.
 tt_row getrowbypk(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2)
           Returns a row of the datasource using the row's primary key.
 number getrowcount(in_datasourcename_tx IN varchar2)
           Returns the number of rows in the datasource.
 number getrowid(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2)
           Returns the row ID of the row using its primary key.
 number getrowidbyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns the row ID of the row using its Oracle row id.
 number getrownumber(in_datasourcename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the row number of the row.
 number getrownumberbyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns the row number of the row using its Oracle row id.
 number getrownumberbypk(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2)
           Returns the row number of the row using its primary key.
 number getrownumberinpage(in_datasourcename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the row number of the row in the page.
 number getrownumberinpagebyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid)
           Gets row number in page of the record that is specified by Oracle row id value.
 number getrownumberinpagebypk(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2)
           Gets row number in page of the record that is specified by PK value.
  getrows(in_datasourcename_tx IN varchar2, io_rows_t IN OUT NOCOPY tt_rows, in_includedeletedrows_yn IN varchar2 DEFAULT 'N')
           Returns the rows in a datasource.
 number getrowsperpage(in_datasourcename_tx IN varchar2)
           Gets # of rows of this datasource.If there is no paging, current page is 1.
 varchar2 getrowstatus(in_datasourcename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Returns the update status of the row.
 varchar2 getrowstatusbyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid)
           Returns the update status of the using its Oracle row id.
 varchar2 getrowstatusbypk(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2)
           Returns the update status of the using its primary key.
 clob getwhereclause(in_datasourcename_tx IN varchar2)
           Returns the current parsed where clasue for the data source.
  importfromfile(in_datasourcename_tx IN varchar2, in_file_bl IN blob, in_fileformat_cd IN varchar2, in_datasourcecolumnnames_t IN tt_datasourcecolumnnames)
           Imports data existing in the given file to the specified datasource.
 varchar2 isdirty(in_datasourcename_tx IN varchar2)
           Returns whether any rows in the datasource has changed.
 varchar2 isdmlnecessary(in_datasourcename_tx IN varchar2)
           Returns whether the datasource has changes in it that will be applied to the database in the next api_aplication.doCommit.
  lastrow(in_datasourcename_tx IN varchar2)
           Sets last row of the datasource as the current row.
  loadsnapshot(in_datasourcename_tx IN varchar2)
           Erases the current content of the datasource and loads the rows from its last snapshot.
  nextpage(in_datasourcename_tx IN varchar2)
           Makes the next page of rows in the datasource available to the UI.
  nextrow(in_datasourcename_tx IN varchar2)
           Changes the current row of the datasource to the next one.
  previouspage(in_datasourcename_tx IN varchar2)
           Makes the previous page of rows in the datasource available to the UI.Uses the current rows per page value.
  previousrow(in_datasourcename_tx IN varchar2)
           Changes the current row of the datasource to the previous one.
  printtoexcel(in_datasourcename_tx IN varchar2, in_excelcolumns_t IN tt_excelcolumns, in_usepaging_yn IN varchar2 DEFAULT 'Y', in_filename_tx IN varchar2 DEFAULT null, in_fileformat_cd IN varchar2 DEFAULT file_format_xls)
           Generates an excel file using specified columns of a given datasource Below is an example regarding the usage of this API for printing a datasource based on employees table of HR schema.
  refreshcurrentrow(in_datasourcename_tx IN varchar2)
           Deprecated. Use refreshRow instead.
  refreshrow(in_datasourcename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Updates the row in the datasource from the database.If input parameter row ID is not specified the procedure updates the current row from the database.
  refreshrowbyid(in_datasourcename_tx IN varchar2, in_row_id IN number DEFAULT null)
           Deprecated. Use refreshRow instead.
  refreshrowbyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid)
           Updates the row in the datasource from the database using its Oracle row id.
  refreshrowbypk(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2)
           Updates the row in the datasource from the database using its primary key.
  setbindvar(in_datasourcedotbindvar_tx IN varchar2, in_value_nr IN number)
           Updates the bind variable of the datasource.
  setbindvar(in_datasourcedotbindvar_tx IN varchar2, in_value_tx IN varchar2)
           Updates the bind variable of the datasource.
  setbindvar(in_datasourcedotbindvar_tx IN varchar2, in_value_dt IN date)
           Updates the bind variable of the datasource.
  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, in_value_tx IN varchar2, in_row_id IN number DEFAULT null)
           Updates the Varchar2 value of the column in the datasource row.
  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, in_value_nr IN number, in_row_id IN number DEFAULT null)
           Updates the Number value of the column in the datasource row.
  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, in_value_dt IN date, in_row_id IN number DEFAULT null)
           Updates the Date value of the column in the datasource row.
  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, in_value_cl IN clob, in_row_id IN number DEFAULT null)
           Updates the CLOB value of the column in the datasource row.
  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, in_value_bl IN blob, in_row_id IN number DEFAULT null)
           Updates the BLOB value of the column in the datasource row.
  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_value_tx IN varchar2, in_orarowid_ri IN rowid)
           Updates the Varchar2 value of the column in the datasource row.
  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_value_nr IN number, in_orarowid_ri IN rowid)
           Updates the Number value of the column in the datasource row.
  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_value_dt IN date, in_orarowid_ri IN rowid)
           Updates the Date value of the column in the datasource row.
  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_value_cl IN clob, in_orarowid_ri IN rowid)
           Updates the CLOB value of the column in the datasource row.
  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, in_value_bl IN blob, in_orarowid_ri IN rowid)
           Updates the BLOB value of the column in the datasource row.
  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, in_value_tx IN varchar2, in_pk_tx IN varchar2)
           Updates the Varchar2 value of the column in the datasource row.
  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, in_value_nr IN number, in_pk_tx IN varchar2)
           Updates the Number value of the column in the datasource row.
  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, in_value_dt IN date, in_pk_tx IN varchar2)
           Updates the Date value of the column in the datasource row.
  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, in_value_cl IN clob, in_pk_tx IN varchar2)
           Updates the CLOB value of the column in the datasource row.
  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, in_value_bl IN blob, in_pk_tx IN varchar2)
           Updates the BLOB value of the column in the datasource row.
  setcurrentrow(in_datasourcename_tx IN varchar2, in_row_id IN number)
           Changes the current row of the datasource.
  setcurrentrowbyid(in_datasourcename_tx IN varchar2, in_row_id IN number)
           Deprecated. Use setCurrentRow instead.
  setcurrentrowbyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid)
           Changes the current row of the datasource.
  setcurrentrowbypk(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2)
           Changes the current row of the datasource.
  setcurrentrowbyrownr(in_datasourcename_tx IN varchar2, in_rownumberinpage_nr IN number, in_page_nr IN number DEFAULT null)
           Changes the current row of the datasource.
  setdefaultquery(in_datasourcename_tx IN varchar2, in_query_tx IN varchar2)
           Set the query of the datasource which is defined in the Datasource Definition object.
  setfilter(in_datasourcename_tx IN varchar2, in_whereclause_tx IN varchar2, in_orderbyclause_tx IN varchar2, in_page_nr IN number DEFAULT null, in_rowsperpage_nr IN number DEFAULT -1)
           Narrows the available rows to the UI in the datasource by applying an additional where clause and reorders them with an additional order by clause.
  setfilterorderbyclause(in_datasourcename_tx IN varchar2, in_orderbyclause_tx IN varchar2, in_page_nr IN number DEFAULT null, in_rowsperpage_nr IN number DEFAULT -1)
           Reorder the rows in the datasource.
  setfilterwhereclause(in_datasourcename_tx IN varchar2, in_whereclause_tx IN varchar2, in_page_nr IN number DEFAULT null, in_rowsperpage_nr IN number DEFAULT -1)
           Narrows the available rows to the UI in the datasource by applying an additional where clause.
  setmaxrowfetch(in_datasourcename_tx IN varchar2, in_maxrowfetch_nr IN number)
           Updates the maximum number of rows the datasource can query from the database.
  setpage(in_datasourcename_tx IN varchar2, in_page_nr IN number DEFAULT null, in_rowsperpage_nr IN number DEFAULT -1)
           Updates which interval of rows the datasource makes available to the UI.
  setrownumber(in_datasourcename_tx IN varchar2, in_rownumberinpage_nr IN number, in_page_nr IN number DEFAULT null, in_row_id IN number DEFAULT null)
           Updates the row order in the datasource.
  setrownumberbyorarowid(in_datasourcename_tx IN varchar2, in_orarowid_ri IN rowid, in_rownumberinpage_nr IN number, in_page_nr IN number DEFAULT null)
           Updates the row order in the datasource.
  setrownumberbypk(in_datasourcename_tx IN varchar2, in_pk_tx IN varchar2, in_rownumberinpage_nr IN number, in_page_nr IN number DEFAULT null)
           Updates the row order in the datasource.
  setwhereclause(in_datasourcename_tx IN varchar2, in_criterionnames_t IN tt_criterionname, in_bindvarvalues_t IN tt_bindvarvalue, in_structure_cl IN clob DEFAULT keep_current_value)
           Updates the whereclause of a datasource using the Criteria defined in the Datasource Definition.
  setwhereclause(in_datasourcename_tx IN varchar2, in_criterionnames_t IN tt_criterionname, in_structure_cl IN clob DEFAULT keep_current_value)
           Updates the whereclause of a datasource using the Criteria defined in the Datasource Definition.
  setwhereclause(in_datasourcename_tx IN varchar2, in_whereclause_cl IN clob)
           Updates the whereclause of a datasource.
  takesnapshot(in_datasourcename_tx IN varchar2)
           Saves the current state (rows, row status etc....) of the datasource for later use.

Field Detail

all_rows

        public number all_rows CONSTANT := bdf_datasource_mng.g_updateallrows
Used for updating column values of all rows with setColumnValue or deleting all rows of datasources with deleteRowById

analyze_all_rows

        public varchar2(200) analyze_all_rows CONSTANT := bdf_datasource_mng.g_analyzeallrows

analyze_dml_rows

        public varchar2(200) analyze_dml_rows CONSTANT := bdf_datasource_mng.g_analyzedmlrows

clear_all

        public varchar2(200) clear_all CONSTANT := bdf_datasource_mng.g_clearall
Erases all the rows in the datasource as well as the snapshot

clear_current

        public varchar2(200) clear_current CONSTANT := bdf_datasource_mng.g_clearcurrent
Erases all the rows that are currently in the datasource.

clear_snapshots

        public varchar2(200) clear_snapshots CONSTANT := bdf_datasource_mng.g_clearsnapshots
Erases all the snapshot information from the datasource.

clearall

        public varchar2(200) clearall CONSTANT := bdf_datasource_mng.g_clearall

clearcurrent

        public varchar2(200) clearcurrent CONSTANT := bdf_datasource_mng.g_clearcurrent

clearsnapshots

        public varchar2(200) clearsnapshots CONSTANT := bdf_datasource_mng.g_clearsnapshots

datatype_blob

        public varchar2(200) datatype_blob CONSTANT := bdf_constant.datatypeblob
Value: 'BLOB'

datatype_clob

        public varchar2(200) datatype_clob CONSTANT := bdf_constant.datatypeclob
Value: 'CLOB'

datatype_date

        public varchar2(200) datatype_date CONSTANT := bdf_constant.datatypedate
Value: 'DATE'

datatype_number

        public varchar2(200) datatype_number CONSTANT := bdf_constant.datatypenumber
Value: 'NUMBER'

datatype_varchar2

        public varchar2(200) datatype_varchar2 CONSTANT := bdf_constant.datatypevarchar2
Value: 'VARCHAR2'

file_format_xls

        public varchar2(200) file_format_xls CONSTANT := bdf_constant.fileformatxls
Value: 'xls'

file_format_xlsx

        public varchar2(200) file_format_xlsx CONSTANT := bdf_constant.fileformatxlsx
Value: 'xlsx'

keep_current_value

        public varchar2(200) keep_current_value CONSTANT := bdf_constant.keepcurrentvalue

keepcurrentvalue

        public varchar2(200) keepcurrentvalue CONSTANT := bdf_constant.keepcurrentvalue

row_status_deleted

        public varchar2(200) row_status_deleted CONSTANT := bdf_datasource_mng.g_deleted
Constant that represents the deleted row status.

row_status_new

        public varchar2(200) row_status_new CONSTANT := bdf_datasource_mng.g_new
Constant that represents the new row status.

row_status_temp

        public varchar2(200) row_status_temp CONSTANT := bdf_datasource_mng.g_temp
Constant that represents the new row status which is not modified yet.

row_status_updated

        public varchar2(200) row_status_updated CONSTANT := bdf_datasource_mng.g_updated
Constant that represents the updated status.

Type Detail

t_columns

public RECORD t_columns(name_tx varchar2(255), 
datatype_cd varchar2(200))
Record of column holds name and datatype


t_excelcolumns

public RECORD t_excelcolumns(datasourcecolumnname_tx varchar2(255), 
label_tx varchar2(4000),
format_tx varchar2(255))
Record type for the excel column object.
Parameters:
datasourcecolumnname_tx - Name of the datasource column from which data will be fetched in excel file
label_tx - Column header label for the datasource column in excel file
format_tx - Pattern which will be used to format datasource column data in excel file(Formspider dateFormat & numberMask)


t_requiredcolumnviolation

public RECORD t_requiredcolumnviolation(row_id number, 
columns_t tt_columns)
Type holds a datasource row ID that has missing values for some of its required columns.
Parameters:
row_id - datasource row ID of the row.
columns_t - List of required columns that have a null value.


t_rowcolumn

public bdf_datasource_mng.t_rowColumn t_rowcolumn()
Type that represents a datasource column. PL/SQL record type with columns value_nr (number), value_tx (varchar2), value_dt (date), value_cl (clob), value_bl (blob)


tt_bindvarvalue

public bdf_datasource_mng.tt_searchField tt_bindvarvalue()
Type that represents a list of bind variable-value pairs with potential operand overrides. Columns: bindvarname_tx, value_tx, value_nr, value_dt, formatmask_tx, allowoverride_yn


tt_columns

public table OF t_columns INDEX BY binary_integer tt_columns()
Table type that holds a list of column names and datatypes.


tt_criterionname

public bdf_criterion_api.tt_criterionName tt_criterionname()
Type that represents a list of criterion names. An array of varchar2's.


tt_datasourcecolumnnames

public table OF varchar2(255) INDEX BY binary_integer tt_datasourcecolumnnames()
Table type that holds a list of datasource column names.


tt_datasourcenames

public table OF varchar2(255) INDEX BY binary_integer tt_datasourcenames()
Table type that holds a list of datasource names.


tt_excelcolumns

public table OF t_excelColumns INDEX BY binary_integer tt_excelcolumns()
Table type to hold datasource column information to be printed in excel file


tt_requiredcolumnviolation

public table OF t_requiredColumnViolation INDEX BY binary_integer tt_requiredcolumnviolation()
Table type that holds a list of datasource row ID's and the list of mandatory columns for each row that has null value.


tt_row

public bdf_datasource_mng.tt_row tt_row()
Type that represents a datasource row. PL/SQL table type of t_rowColumn indexed by datasource column names.


tt_rows

public bdf_datasource_mng.tt_rows tt_rows()
Table type that represents a set of datasource rows. PL/SQL table type of t_row indexed by binary_integer.


Method Detail

all_criteria

public tt_criterionname all_criteria()
Constant that represents a list of all criteria in the Datasource Definition. (To be used in setWhereClause procedure for the in_criterionNames_t input parameter)


clear

public  clear(in_datasourcename_tx IN varchar2, 
in_clearoption_cd IN varchar2 DEFAULT clear_current)
Delete the rows from the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_clearoption_cd - The valid values for this input parameter are:

CLEAR_CURRENT: Erases all the rows that are currently in the datasource.

CLEAR_SNAPSHOTS: Erases all the snapshot information from the datasource.

CLEAR_ALL: Erases all the rows in the datasource as well as the snapshot information.

The default value for this input parameter is CLEAR_CURRENT.

Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidinputparameter - Raised when in_clearOption_cd value is invalid
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


createrow

public number createrow(in_datasourcename_tx IN varchar2, 
in_nextsiblingrow_id IN number DEFAULT null,
in_nextsiblingpk_tx IN varchar2 DEFAULT null)
Creates a new row in the datasource and returns its row ID.

Developers may use either in_nextSiblingRow_id or in_nextSiblingPK_tx to specify where the new row is going to be placed in the datasource.

Parameters:
in_datasourcename_tx - The name of datasource
in_nextsiblingrow_id - The ID of the row that the new row is going to be placed before. The default value of this input parameter is null . If both in_nextSiblingRow_id and in_nextSiblingPK_tx are null then new row is going to be appended to the end of the data source.
in_nextsiblingpk_tx - The primary key of the row that the new row is going to be placed before. The default value of this input parameter is null meaning that the new row is going to be appended to the end of the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


createrowbyrownumber

public number createrowbyrownumber(in_datasourcename_tx IN varchar2, 
in_rownumberinpage_nr IN number,
in_page_nr IN number DEFAULT null)
Creates a new row in the data and returns the datasource row ID of the newly created row.

The new row can be added to any page at any index.

Parameters:
in_datasourcename_tx - The name of datasource
in_rownumberinpage_nr - The row number in page
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidpagenumber - Raised when specified page number does not exist in the datasource.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


deletecurrentrow

public  deletecurrentrow(in_datasourcename_tx IN varchar2)
Deletes selected row of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_nocurrentrow - Raised when there is no current row in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

Deprecated:
Use deleteRow instead.


deleterow

public  deleterow(in_datasourcename_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Deletes the row from the datasource. If no datasource row ID is specified, current row in the datasource is deleted. If ALL_ROWS is given for in_row_id parameter, then all rows of the datasource is deleted
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row. If the value of this input parameter is null, then the current row is deleted. If it equals ALL_ROWS then all of the rows in the datasource is deleted.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
ALL_ROWS
deleterowbypk(varchar2,varchar2)

deleterowbyid

public  deleterowbyid(in_datasourcename_tx IN varchar2, 
in_row_id IN number)
Deletes a row from datasource that is specified by row ID. If ALL_ROWS is given for in_row_id parameter, then all rows of the datasource will be deleted
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

Deprecated:
Use deleteRow instead.

See also:
ALL_ROWS

deleterowbyorarowid

public  deleterowbyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid)
Deletes the row from the datasource using its Oracle row id.
Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
deleterow(varchar2,number)

deleterowbypk

public  deleterowbypk(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2)
Deletes the row from the datasource using the rows primary key.
Parameters:
in_datasourcename_tx - The name of datasource
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
deleterow(varchar2,number)

docommit

public  docommit(in_datasourcename_tx IN varchar2)
Commits specified datasource. Note that current database session is also committed.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


docommit

public  docommit(in_datasourcenames_tt IN tt_datasourcenames)
Commits specified 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.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


download

public  download(in_datasourcedotcolumn_tx IN varchar2, 
in_filename_tx IN varchar2,
in_row_id IN number DEFAULT null)
Downloads specified BLOB as a file.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_filename_tx - Name of the downloaded file.
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidfilename - Raised when the file name is invalid.
e_invaliddatatype - Raised when the column’s data type is not BLOB.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.


executequery

public  executequery(in_datasourcename_tx IN varchar2, 
in_page_nr IN number DEFAULT null,
in_rowsperpage_nr IN number DEFAULT -1,
in_whereclause_tx IN varchar2 DEFAULT keep_current_value,
in_orderbyclause_tx IN varchar2 DEFAULT keep_current_value)
Runs the query of the datasource and populates it with the row set returned.
Parameters:
in_datasourcename_tx - The name of datasource
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
in_rowsperpage_nr - The number of rows in each page. The default value for this input parameters -1
in_whereclause_tx - The where clause for the datasource filter. The default value for this input parameters is KEEP_CURRENT_VALUE
in_orderbyclause_tx - The order by clause for the datasource filter. The default value for this input parameters is KEEP_CURRENT_VALUE
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.

See also:
setcurrentrow(varchar2,number)

firstrow

public  firstrow(in_datasourcename_tx IN varchar2)
Sets first row of the datasource as the current row.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.


getbindvarvaluedt

public date getbindvarvaluedt(in_datasourcedotbindvar_tx IN varchar2)
Returns the bind variable value as Date.
Parameters:
in_datasourcedotbindvar_tx - The name of datasource and its bindvar name ('datasource.bindvar')
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidbindvarname - Raised when the bindvar name is not found in datasource.


getbindvarvaluenr

public number getbindvarvaluenr(in_datasourcedotbindvar_tx IN varchar2)
Returns the bind variable value as Number.
Parameters:
in_datasourcedotbindvar_tx - The name of datasource and its bindvar name ('datasource.bindvar')
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidbindvarname - Raised when the bindvar name is not found in datasource.


getbindvarvaluetx

public varchar2 getbindvarvaluetx(in_datasourcedotbindvar_tx IN varchar2)
Returns the bind variable value as Varchar2.
Parameters:
in_datasourcedotbindvar_tx - The name of datasource and its bindvar name ('datasource.bindvar')
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidbindvarname - Raised when the bindvar name is not found in datasource.


getcolumnnames

public tt_columns getcolumnnames(in_datasourcename_tx IN varchar2)
Returns the table of column names and datatypes
Parameters:
in_datasourcename_tx - The name of datasource
Returns:
The table of column names and datatypes. Valid Constants for the datatypes are: DATATYPE_VARCHAR2, DATATYPE_NUMBER, DATATYPE_DATE, DATATYPE_CLOB, DATATYPE_BLOB.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getcolumnvaluebl

public blob getcolumnvaluebl(in_datasourcedotcolumn_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the value of the row's BLOB column. If no datasource row ID is specified the API executes for the current row of the datasource.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidrowid - Raised when the row ID is not found in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvalueblbyorarowid

public blob getcolumnvalueblbyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns the value of the row's BLOB column using the row's Oracle row id.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvalueblbypk

public blob getcolumnvalueblbypk(in_datasourcedotcolumn_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns the value of the row's BLOB column using the row's primary key.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluecl

public clob getcolumnvaluecl(in_datasourcedotcolumn_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the value of the row's CLOB column. If no datasource row ID is specified the API executes for the current row of the datasource.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidrowid - Raised when the row ID is not found in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvalueclbyorarowid

public clob getcolumnvalueclbyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns the value of the row's CLOB column using the row's Oracle row id.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvalueclbypk

public clob getcolumnvalueclbypk(in_datasourcedotcolumn_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns the value of the row's CLOB column using the row's primary key.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluedt

public date getcolumnvaluedt(in_datasourcedotcolumn_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the value of the row's Date column. If no datasource row ID is specified the API executes for the current row of the datasource.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_row_id - Row ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidrowid - Raised when the row ID is not found in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluedtbyorarowid

public date getcolumnvaluedtbyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns the value of the row's Date column using the row's Oracle row id.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluedtbypk

public date getcolumnvaluedtbypk(in_datasourcedotcolumn_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns the value of the row's Date column using the row's primary key.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluenr

public number getcolumnvaluenr(in_datasourcedotcolumn_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the value of the row's Number column. If no datasource row ID is specified the API executes for the current row of the datasource.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidrowid - Raised when the row ID is not found in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluenrbyorarowid

public number getcolumnvaluenrbyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns the value of the row's Number column using the row's Oracle row id.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluenrbypk

public number getcolumnvaluenrbypk(in_datasourcedotcolumn_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns the value of the row's Number column using the row's primary key.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluetx

public varchar2 getcolumnvaluetx(in_datasourcedotcolumn_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the value of the row's Varchar2 column. If no datasource row ID is specified the API executes for the current row of the datasource.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidrowid - Raised when the row ID is not found in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluetxbyorarowid

public varchar2 getcolumnvaluetxbyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns the value of the row's Varchar2 column using the row's Oracle row id.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcolumnvaluetxbypk

public varchar2 getcolumnvaluetxbypk(in_datasourcedotcolumn_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns the value of the row's Varchar2 column using the row's primary key.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getcompleterowcount

public number getcompleterowcount(in_datasourcename_tx IN varchar2)
Returns the number of rows by executing a select count(*) using the query of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getcurrentpage

public number getcurrentpage(in_datasourcename_tx IN varchar2)
Returns the current page number the datasource is on. If there is no paging, the current page value is always 1.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getcurrentrowid

public number getcurrentrowid(in_datasourcename_tx IN varchar2)
Returns the datasource row ID of the current row.
Parameters:
in_datasourcename_tx - The name of the datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getdefaultquery

public varchar2 getdefaultquery(in_datasourcename_tx IN varchar2)
Get the query of the datasource. If not set yet, the query defined in the Datasource Definition object is returned. If where clause or order by clause of the Datasource Definition object is defined, they will be added to the returning query string. Note that the function returns varchar2. For the returning values larger than 32K, "ORA-06502: PL/SQL: numeric or value error: character string buffer too small" error occurs.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getfilteredrowcount

public number getfilteredrowcount(in_datasourcename_tx IN varchar2)
Returns the number of row in the datasource without ignoring any filters it might have.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getfilterorderbyclause

public varchar2 getfilterorderbyclause(in_datasourcename_tx IN varchar2)
Returns the order by clause of the datasource filter.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getfilterwhereclause

public varchar2 getfilterwhereclause(in_datasourcename_tx IN varchar2)
Returns the where clause of the datasource filter.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getid

public number getid(in_datasourcename_tx IN varchar2)
Returns the run time ID of the datasource object.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getmaxrowfetch

public number getmaxrowfetch(in_datasourcename_tx IN varchar2)
Returns the maximum number of rows the datasource will fetch when its query is executed.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getorarowid

public rowid getorarowid(in_datasourcename_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the value of the datasource row's Oracle row id. If no datasource row ID is specified the API executes for the current row of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getpkcolumnname

public varchar2 getpkcolumnname(in_datasourcename_tx IN varchar2)
Returns the name of the primary key of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getpreviouscurrentrowid

public number getpreviouscurrentrowid(in_datasourcename_tx IN varchar2)
Returns the previous current row ID of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getquery

public varchar2 getquery(in_datasourcename_tx IN varchar2, 
in_includedeletedrows_yn IN varchar2 DEFAULT 'N')
Returns an SQL that bring back the rows in a datasource.

The framework adds two additional columns to the SQL. DS_ROWID represents a row's framework assigned datasource row ID and DS_ROWSTATUS indicated the current DML status of the row.

Valid values for DS_ROWSTATUS are: New for newly created rows that do not exist in the database, Updated for rows that have changed and Deleted for the rows that are discarded.

Below is an example regarding the usage of this API.

 declare
   type t_emp is record (employee_id number, employee_name varchar2(255), ds_rowid number, ds_rowStatus varchar2(255));
   type tt_emp is table of t_emp index by binary_integer;
   v_emp_t tt_emp;
 begin
   execute immediate
     'select employee_id, employee_name, ds_rowid, ds_rowStatus
      from ' || api_datasource.getQuery('ds_emp') ||'
      where employee_name=:1'
   bulk collect into v_emp_t
   using 'Testemployee';
   ...
 end;
 
Parameters:
in_includedeletedrows_yn - default 'N'
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrequiredcolumnviolations

public tt_requiredcolumnviolation getrequiredcolumnviolations(in_datasourcename_tx IN varchar2, 
in_analyzeoption_cd IN varchar2 DEFAULT analyze_all_rows)
Returns the list of rows of a datasource that have null values in their required columns.
Parameters:
in_datasourcename_tx - The name of datasource
in_analyzeoption_cd - Indicates what type of rows the framework should evaluate for violations. For apidatasource.ANALYZE_ALL, the framework evaluates every row in the datasource. For api_datasource.ANALYZE_DML_ROWS, the framework evaluates only rows that are updated and will cause the framework to issue DML statements to the database in the next api_application.doCommit.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidinputparameter - Raised when in_analyzeOption_cd value is invalid
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrow

public tt_row getrow(in_datasourcename_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns a row of the datasource disregarding any filters it may have.

The returned record has two additional columns added by the framework. DS_ROWID represents a row's framework assigned datasource row ID and DS_ROWSTATUS indicated the current DML status of the row. Valid values for DS_ROWSTATUS are: New for newly created rows that do not exist in the database, Updated for rows that have changed and Deleted for the rows that are discarded. Uppercase column names must be used to reference columns. Below is a code sample demonstrating the usage of the getRow API.

 declare
   v_row_t api_datasource.tt_row;
   v_empName_tx varchar2(255);
   v_emp_id number;
   v_row_id number;
   v_rowStatus_cd varchar2(255);
 begin
   v_row_t := api_datasource.getRow('ds_emp'); --get current row
   v_empName_tx := v_row_t('EMPLOYEE_NAME').value_tx;
   v_emp_id := v_row_t('EMPLOYEE_ID').value_nr;
   v_row_id := v_row_t('DS_ROWID').value_nr; --get oid of the row
   v_rowStatus_cd := v_row_t('DS_ROWSTATUS').value_tx; --get status of the row
   ...
 end;
 
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrowbyorarowid

public tt_row getrowbyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns a row of the datasource using the row's Oracle row id.

The returned record has two additional columns added by the framework. DS_ROWID represents a row's framework assigned datasource row ID and DS_ROWSTATUS indicated the current DML status of the row. Valid values for DS_ROWSTATUS are: New for newly created rows that do not exist in the database, Updated for rows that have changed and Deleted for the rows that are discarded.

Uppercase column names must be used to reference columns.

Below is a code sample demonstrating the usage of the getRowsbyPK API.

 declare
   v_row_t api_datasource.tt_row;
   v_empName_tx varchar2(255);
   v_emp_id number;
   v_row_id number;
   v_rowStatus_cd varchar2(255);
   v_oraRowID_ri rowid;
 begin
   select rowid
   into v_oraRowID_ri
   from employees
   where employee_id = 101;

   v_row_t := api_datasource.getRowByPk('ds_emp', v_oraRowID_ri); --get row with employee_id = 101
   v_empName_tx := v_row_t('EMPLOYEE_NAME').value_tx;
   v_emp_id := v_row_t('EMPLOYEE_ID').value_nr;
   v_row_id := v_row_t('DS_ROWID').value_nr; --get oid of the row
   v_rowStatus_cd := v_row_t('DS_ROWSTATUS').value_tx; --get status of the row
   ...
 end;
 
Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrowbypk

public tt_row getrowbypk(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns a row of the datasource using the row's primary key.

The returned record has two additional columns added by the framework. DS_ROWID represents a row's framework assigned datasource row ID and DS_ROWSTATUS indicated the current DML status of the row. Valid values for DS_ROWSTATUS are: New for newly created rows that do not exist in the database, Updated for rows that have changed and Deleted for the rows that are discarded.

Uppercase column names must be used to reference columns.

Below is a code sample demonstrating the usage of the getRowsbyPK API.

 declare
   v_row_t api_datasource.tt_row;
   v_empName_tx varchar2(255);
   v_emp_id number;
   v_row_id number;
   v_rowStatus_cd varchar2(255);
 begin
   v_row_t := api_datasource.getRowByPk('ds_emp','101'); --get row with employee_id = 101
   v_empName_tx := v_row_t('EMPLOYEE_NAME').value_tx;
   v_emp_id := v_row_t('EMPLOYEE_ID').value_nr;
   v_row_id := v_row_t('DS_ROWID').value_nr; --get oid of the row
   v_rowStatus_cd := v_row_t('DS_ROWSTATUS').value_tx; --get status of the row
   ...
 end;
 
Parameters:
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrowcount

public number getrowcount(in_datasourcename_tx IN varchar2)
Returns the number of rows in the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrowid

public number getrowid(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns the row ID of the row using its primary key.
Parameters:
in_datasourcename_tx - The name of datasource
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrowidbyorarowid

public number getrowidbyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns the row ID of the row using its Oracle row id.
Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrownumber

public number getrownumber(in_datasourcename_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the row number of the row. If no row ID is specified then the function returns the row number of the current row.
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.


getrownumberbyorarowid

public number getrownumberbyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns the row number of the row using its Oracle row id.
Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in its source table.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrownumberbypk

public number getrownumberbypk(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns the row number of the row using its primary key.
Parameters:
in_datasourcename_tx - The name of datasource
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrownumberinpage

public number getrownumberinpage(in_datasourcename_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the row number of the row in the page. If no row ID is specified then the function returns the row number of the current row in the page.
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrownumberinpagebyorarowid

public number getrownumberinpagebyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid)
Gets row number in page of the record that is specified by Oracle row id value.
Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.


getrownumberinpagebypk

public number getrownumberinpagebypk(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2)
Gets row number in page of the record that is specified by PK value.
Parameters:
in_datasourcename_tx - The name of datasource
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.


getrows

public  getrows(in_datasourcename_tx IN varchar2, 
io_rows_t IN OUT NOCOPY tt_rows,
in_includedeletedrows_yn IN varchar2 DEFAULT 'N')
Returns the rows in a datasource.

The returned PL/SQL table has two additional columns added by the framework. DS_ROWID represents a row's framework assigned datasource row ID and DS_ROWSTATUS indicated the current DML status of the row. Valid values for DS_ROWSTATUS are: New for newly created rows that do not exist in the database, Updated for rows that have changed and Deleted for the rows that are discarded.

Uppercase column names must be used to reference columns.

Below is a code sample demonstrating the usage of the getRows API.

 declare
   v_rows_t api_datasource.tt_rows;
   v_empName_tx varchar2(255);
   v_emp_id number;
   v_row_id number;
   v_rowStatus_cd varchar2(255);
 begin
   api_datasource.getRows('ds_emp', v_rows_t);
   for i in 1..v_rows_t.count loop
     v_empName_tx := v_rows_t(i)('EMPLOYEE_NAME').value_tx;
     v_emp_id := v_rows_t(i)('EMPLOYEE_ID').value_nr;
     v_row_id := v_rows_t(i)('DS_ROWID').value_nr;
     v_rowStatus_cd := v_rows_t(i)('DS_ROWSTATUS').value_tx;
     ...
   end loop;
 end;
 
Parameters:
in_datasourcename_tx - The name of datasource
io_rows_t - In out parameters that returns the datasource rows.
in_includedeletedrows_yn - Indicated whether deleted rows should be returned by the API. Default value is N.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrowsperpage

public number getrowsperpage(in_datasourcename_tx IN varchar2)
Gets # of rows of this datasource.If there is no paging, current page is 1.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


getrowstatus

public varchar2 getrowstatus(in_datasourcename_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Returns the update status of the row. It returns

ROW_STATUS_DELETED for deleted rows

ROW_STATUS_TEMP for newly created rows

ROW_STATUS_NEW for newly created and updated rows

ROW_STATUS_UPDATED for changed rows a

ROW_STATUS_NULL Null status indicates that the row is just queried from the database and no update or delete operation is preformed yet. If input parameter row ID is not specified, the function returns the status of the current row.

Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrowstatusbyorarowid

public varchar2 getrowstatusbyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid)
Returns the update status of the using its Oracle row id.

It returns

ROW_STATUS_DELETED for deleted rows,

ROW_STATUS_TEMP for newly created rows

ROW_STATUS_NEW for newly created and updated rows

ROW_STATUS_UPDATED for changed rows.

Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getrowstatusbypk

public varchar2 getrowstatusbypk(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2)
Returns the update status of the using its primary key.

It returns

ROW_STATUS_DELETED for deleted rows,

ROW_STATUS_TEMP for newly created rows

ROW_STATUS_NEW for newly created and updated rows

ROW_STATUS_UPDATED for changed rows.

Parameters:
in_datasourcename_tx - The name of datasource
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


getwhereclause

public clob getwhereclause(in_datasourcename_tx IN varchar2)
Returns the current parsed where clasue for the data source.
Parameters:
in_datasourcename_tx - The name of the datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


importfromfile

public  importfromfile(in_datasourcename_tx IN varchar2, 
in_file_bl IN blob,
in_fileformat_cd IN varchar2,
in_datasourcecolumnnames_t IN tt_datasourcecolumnnames)
Imports data existing in the given file to the specified datasource. Below is an example regarding the usage of this API for importing data to the employees table of HR schema. Consider that the import file is in xls format with the following data; Donald 2,600.00 21/06/1999 Douglas 2,600.00 13/01/2000 Jennifer 4,400.00 17/09/1987 Michael 13,000.00 17/02/1996 Pat 6,000.00 17/08/1997 Susan 6,500.00 07/06/1994 Hermann 10,000.00 07/06/1994 .....
 declare
   v_datasourceColumnNames_t api_datasource.tt_datasourceColumnNames;
   v_bl blob;
 begin
   v_datasourceColumnNames_t(1) := 'FIRST_NAME';
   v_datasourceColumnNames_t(2) := 'SALARY';
   v_datasourceColumnNames_t(3) := 'HIRE_DATE';
   v_bl := api_component.getvaluebl('mainPanel.fileUpload'); -- consider that you are retrieving the file through the file upload component
   api_datasource.importfromfile('EMPLOYEES1', v_bl, api_datasource.FILE_FORMAT_XLS, v_datasourceColumnNames_t);
 end;
 
Parameters:
in_datasourcename_tx - The name of datasource
in_file_bl - The file from which data will be imported
in_fileformat_cd - Format of the import file. Valid constant for this input variable is: FILE_FORMAT_XLS
in_datasourcecolumnnames_t - Array holding the name of the datasource columns to import data. The order used in this array should be same with the order of the data existing in the import file.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column specified in in_datasourceColumnNames_t array does not exist in the datasource.
e_invalidinputparameter - Raised when in_fileFormat_cd value is invalid.
e_fileformatmismatch - Raised when the given file is empty or is not in the specified format.
e_datatypemismatch - Raised when the data type of the import data is not compatible with the given datasource columns.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode
e_javanotsupported - Raised when Oracle Express Edition.


isdirty

public varchar2 isdirty(in_datasourcename_tx IN varchar2)
Returns whether any rows in the datasource has changed.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


isdmlnecessary

public varchar2 isdmlnecessary(in_datasourcename_tx IN varchar2)
Returns whether the datasource has changes in it that will be applied to the database in the next api_aplication.doCommit.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


lastrow

public  lastrow(in_datasourcename_tx IN varchar2)
Sets last row of the datasource as the current row.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


loadsnapshot

public  loadsnapshot(in_datasourcename_tx IN varchar2)
Erases the current content of the datasource and loads the rows from its last snapshot.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_nosnapshotfound - Raised when no snapshot is found in the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


nextpage

public  nextpage(in_datasourcename_tx IN varchar2)
Makes the next page of rows in the datasource available to the UI. Uses the current rows per page value.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidpagenumber - Raised when specified page number does not exist in the datasource.


nextrow

public  nextrow(in_datasourcename_tx IN varchar2)
Changes the current row of the datasource to the next one.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


previouspage

public  previouspage(in_datasourcename_tx IN varchar2)
Makes the previous page of rows in the datasource available to the UI.Uses the current rows per page value.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidpagenumber - Raised when specified page number does not exist in the datasource.


previousrow

public  previousrow(in_datasourcename_tx IN varchar2)
Changes the current row of the datasource to the previous one.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


printtoexcel

public  printtoexcel(in_datasourcename_tx IN varchar2, 
in_excelcolumns_t IN tt_excelcolumns,
in_usepaging_yn IN varchar2 DEFAULT 'Y',
in_filename_tx IN varchar2 DEFAULT null,
in_fileformat_cd IN varchar2 DEFAULT file_format_xls)
Generates an excel file using specified columns of a given datasource Below is an example regarding the usage of this API for printing a datasource based on employees table of HR schema.
 declare
   v_excelCols_t api_datasource.tt_excelColumns;
 begin
   v_excelCols_t(1).datasourceColumnName_tx := 'FIRST_NAME';
   v_excelCols_t(1).label_tx := 'FIRST NAME';

   v_excelCols_t(2).datasourceColumnName_tx := 'SALARY';
   v_excelCols_t(2).label_tx := 'SALARY';
   v_excelCols_t(2).format_tx :='#,###.00#';

   v_excelCols_t(3).datasourceColumnName_tx := 'HIRE_DATE';
   v_excelCols_t(3).label_tx := 'HIRE DATE';
   v_excelCols_t(3).format_tx :='DD/MM/YYYY';

   api_datasource.printtoexcel('EMPLOYEES1', v_excelCols_t, 'N', 'employeesData', api_datasource.FILE_FORMAT_XLSX);
 end;
 
This usage will generate following excel output; FIRST NAME SALARY HIRE DATE Donald 2,600.00 21/06/1999 Douglas 2,600.00 13/01/2000 Jennifer 4,400.00 17/09/1987 Michael 13,000.00 17/02/1996 Pat 6,000.00 17/08/1997 Susan 6,500.00 07/06/1994 Hermann 10,000.00 07/06/1994 .....
Parameters:
in_datasourcename_tx - The name of datasource
in_excelcolumns_t - Array holding datasource column information to be printed.(datasource column name, label and data format to be used in excel file)
in_usepaging_yn - Indicates whether current paging settings of the dataource should be used while printing excel file data. Default value is Y, if the value is N, all paging related settings will be ignored.
in_filename_tx - Name of the generated excel file. If not specified "file_YYYYMMDD_HHMI" default name will be used
in_fileformat_cd - Format of the generated excel file. Default value is FILE_FORMAT_XLS. Valid Constants for this input variable are: FILE_FORMAT_XLS, FILE_FORMAT_XLSX.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidcolumnname - Raised when the column specified in in_excelColumns_t array does not exist in the datasource.
e_invalidinputparameter - Raised when in_fileFormat_cd value is invalid


refreshcurrentrow

public  refreshcurrentrow(in_datasourcename_tx IN varchar2)
Refreshes selected row of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidcurrentrow - Raised when the current row value set by setCurrentRow API does not actually exist in the datasource.
e_referduplicatepk - Raised when there is more then one row with same primary key in datasource.
e_nocurrentrow - Raised when there is no current row in the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

Deprecated:
Use refreshRow instead.


refreshrow

public  refreshrow(in_datasourcename_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Updates the row in the datasource from the database.If input parameter row ID is not specified the procedure updates the current row from the database.
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_referduplicatepk - Raised when there is more then one row with same primary key in datasource.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidcurrentrow - Raised when the current row value set by setCurrentRow API does not actually exist in the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
refreshrowbypk(varchar2,varchar2)

refreshrowbyid

public  refreshrowbyid(in_datasourcename_tx IN varchar2, 
in_row_id IN number DEFAULT null)
Refreshes one row of the datasource by row ID. If row ID is not defined current row of datasource will be refreshed
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_referduplicatepk - Raised when there is more then one row with same primary key in datasource.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidcurrentrow - Raised when the current row value set by setCurrentRow API does not actually exist in the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

Deprecated:
Use refreshRow instead.


refreshrowbyorarowid

public  refreshrowbyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid)
Updates the row in the datasource from the database using its Oracle row id.
Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
refreshrow(varchar2,number)

refreshrowbypk

public  refreshrowbypk(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2)
Updates the row in the datasource from the database using its primary key.
Parameters:
in_datasourcename_tx - The name of datasource
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
refreshrow(varchar2,number)

setbindvar

public  setbindvar(in_datasourcedotbindvar_tx IN varchar2, 
in_value_nr IN number)
Updates the bind variable of the datasource.
Parameters:
in_datasourcedotbindvar_tx - The name of datasource and it's bind variable('datasource.bindvar')
in_value_nr - Number value of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidbindvarname - Raised when the bindvar name is not found in datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotbindVar_tx parameter is in incorrect format.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.


setbindvar

public  setbindvar(in_datasourcedotbindvar_tx IN varchar2, 
in_value_tx IN varchar2)
Updates the bind variable of the datasource.
Parameters:
in_datasourcedotbindvar_tx - The name of datasource and it's bind variable('datasource.bindvar')
in_value_tx - Text value of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidbindvarname - Raised when the bindvar name is not found in datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotbindVar_tx parameter is in incorrect format.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.


setbindvar

public  setbindvar(in_datasourcedotbindvar_tx IN varchar2, 
in_value_dt IN date)
Updates the bind variable of the datasource.
Parameters:
in_datasourcedotbindvar_tx - The name of datasource and it's bind variable('datasource.bindvar')
in_value_dt - Date value of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidbindvarname - Raised when the bindvar name is not found in datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotbindVar_tx parameter is in incorrect format.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.


setcolumnvalue

public  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, 
in_value_tx IN varchar2,
in_row_id IN number DEFAULT null)
Updates the Varchar2 value of the column in the datasource row.

If in_row_id is not specified column of the current row is updated. If the in_row_id value equals api_datasource.ALL_ROWS then every row in the datasource will be updated.

Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_tx - Text value of column
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
ALL_ROWS

setcolumnvalue

public  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, 
in_value_nr IN number,
in_row_id IN number DEFAULT null)
Updates the Number value of the column in the datasource row.

If in_row_id is not specified column of the current row is updated. If the in_row_id value equals api_datasource.ALL_ROWS then every row in the datasource will be updated.

Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_nr - Number value of column
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
ALL_ROWS

setcolumnvalue

public  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, 
in_value_dt IN date,
in_row_id IN number DEFAULT null)
Updates the Date value of the column in the datasource row.

If in_row_id is not specified column of the current row is updated. If the in_row_id value equals api_datasource.ALL_ROWS then every row in the datasource will be updated.

Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_dt - Date value of column
in_row_id - Row ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
ALL_ROWS

setcolumnvalue

public  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, 
in_value_cl IN clob,
in_row_id IN number DEFAULT null)
Updates the CLOB value of the column in the datasource row.

If in_row_id is not specified column of the current row is updated. If the in_row_id value equals api_datasource.ALL_ROWS then every row in the datasource will be updated.

Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_cl - Clob value of column
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
ALL_ROWS

setcolumnvalue

public  setcolumnvalue(in_datasourcedotcolumn_tx IN varchar2, 
in_value_bl IN blob,
in_row_id IN number DEFAULT null)
Updates the BLOB value of the column in the datasource row.

If in_row_id is not specified column of the current row is updated. If the in_row_id value equals api_datasource.ALL_ROWS then every row in the datasource will be updated.

Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_bl - Blob value of column
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_toomanyvalues - Raised when multiple values are being attempted to be marked as selected in a SelectOne list component.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
ALL_ROWS

setcolumnvaluebyorarowid

public  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_value_tx IN varchar2,
in_orarowid_ri IN rowid)
Updates the Varchar2 value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_tx - Text value of column
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebyorarowid

public  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_value_nr IN number,
in_orarowid_ri IN rowid)
Updates the Number value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_nr - Number value of column
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebyorarowid

public  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_value_dt IN date,
in_orarowid_ri IN rowid)
Updates the Date value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_dt - Date value of column
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebyorarowid

public  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_value_cl IN clob,
in_orarowid_ri IN rowid)
Updates the CLOB value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_cl - CLOB value of column
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebyorarowid

public  setcolumnvaluebyorarowid(in_datasourcedotcolumn_tx IN varchar2, 
in_value_bl IN blob,
in_orarowid_ri IN rowid)
Updates the BLOB value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_bl - BLOB value of column
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebypk

public  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, 
in_value_tx IN varchar2,
in_pk_tx IN varchar2)
Updates the Varchar2 value of the column in the datasource row.
Parameters:
in_value_tx - Text value of column
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebypk

public  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, 
in_value_nr IN number,
in_pk_tx IN varchar2)
Updates the Number value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_nr - Number value of column
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebypk

public  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, 
in_value_dt IN date,
in_pk_tx IN varchar2)
Updates the Date value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_dt - Date value of column
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebypk

public  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, 
in_value_cl IN clob,
in_pk_tx IN varchar2)
Updates the CLOB value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_cl - Clob value of column
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcolumnvaluebypk

public  setcolumnvaluebypk(in_datasourcedotcolumn_tx IN varchar2, 
in_value_bl IN blob,
in_pk_tx IN varchar2)
Updates the BLOB value of the column in the datasource row.
Parameters:
in_datasourcedotcolumn_tx - The name of the datasource column in the datasourceName.columnName format. Example: datasource.column1
in_value_bl - Blob value of column
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_invalidcolumnname - Raised when the column does not exist in the datasource.
e_invalidinputformat - Raised when the value of the in_datasourceDotColumn_tx parameter is in incorrect format.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcurrentrow

public  setcurrentrow(in_datasourcename_tx IN varchar2, 
in_row_id IN number)
Changes the current row of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

See also:
setcurrentrowbypk(varchar2,varchar2)

setcurrentrowbyid

public  setcurrentrowbyid(in_datasourcename_tx IN varchar2, 
in_row_id IN number)
Sets row selected that is specified by given row ID.
Parameters:
in_datasourcename_tx - The name of datasource
in_row_id - ID of the datasource row.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode

Deprecated:
Use setCurrentRow instead.


setcurrentrowbyorarowid

public  setcurrentrowbyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid)
Changes the current row of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcurrentrowbypk

public  setcurrentrowbypk(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2)
Changes the current row of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_pk_tx - Primary key value of a row in the datasource.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setcurrentrowbyrownr

public  setcurrentrowbyrownr(in_datasourcename_tx IN varchar2, 
in_rownumberinpage_nr IN number,
in_page_nr IN number DEFAULT null)
Changes the current row of the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_rownumberinpage_nr - The row number in page
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidpagenumber - Raised when specified page number does not exist in the datasource.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setdefaultquery

public  setdefaultquery(in_datasourcename_tx IN varchar2, 
in_query_tx IN varchar2)
Set the query of the datasource which is defined in the Datasource Definition object. This API may be used in order to set the query of the datasource according to the values of the bind variables. The optimizer may generate more efficient query plans with a more simple where clause or hints. Set null in order to revert back to the query of the Datasource Definition.
Parameters:
in_datasourcename_tx - The name of datasource
in_query_tx - The new query. Columns of the new query should be the same with the old one. The max length of the query string should be 32K.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


setfilter

public  setfilter(in_datasourcename_tx IN varchar2, 
in_whereclause_tx IN varchar2,
in_orderbyclause_tx IN varchar2,
in_page_nr IN number DEFAULT null,
in_rowsperpage_nr IN number DEFAULT -1)
Narrows the available rows to the UI in the datasource by applying an additional where clause and reorders them with an additional order by clause.
Parameters:
in_datasourcename_tx - The name of datasource
in_whereclause_tx - The where clause of the filter.
in_orderbyclause_tx - The order by clause of the filter.
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
in_rowsperpage_nr - The number of rows in a page. Defaults to -1 which puts all rows in the datasource to the page.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setfilterorderbyclause

public  setfilterorderbyclause(in_datasourcename_tx IN varchar2, 
in_orderbyclause_tx IN varchar2,
in_page_nr IN number DEFAULT null,
in_rowsperpage_nr IN number DEFAULT -1)
Reorder the rows in the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_orderbyclause_tx - New orderByClause attribute of datasource
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
in_rowsperpage_nr - The number of rows in a page. Defaults to -1 which puts all rows in the datasource to the page.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setfilterwhereclause

public  setfilterwhereclause(in_datasourcename_tx IN varchar2, 
in_whereclause_tx IN varchar2,
in_page_nr IN number DEFAULT null,
in_rowsperpage_nr IN number DEFAULT -1)
Narrows the available rows to the UI in the datasource by applying an additional where clause.
Parameters:
in_datasourcename_tx - The name of datasource
in_whereclause_tx - New whereClause attribute of datasource
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
in_rowsperpage_nr - The number of rows in a page. Defaults to -1 which puts all rows in the datasource to the page.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setmaxrowfetch

public  setmaxrowfetch(in_datasourcename_tx IN varchar2, 
in_maxrowfetch_nr IN number)
Updates the maximum number of rows the datasource can query from the database.
Parameters:
in_datasourcename_tx - The name of datasource
in_maxrowfetch_nr - The new upper limit of rows the datasource is allowed to fetch from the database.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.


setpage

public  setpage(in_datasourcename_tx IN varchar2, 
in_page_nr IN number DEFAULT null,
in_rowsperpage_nr IN number DEFAULT -1)
Updates which interval of rows the datasource makes available to the UI. Please note that paging of rows is done among the rows in the datasource or while fetching rows to the datasource according to the datasouce "Fethc Mode" property. If Fetch Mode is Fetch All then, paging occurs on view layer. Formspider doesn't query database during paging. If Fetch Mode is Paging then, paging occurs while fetching rows to the datasource. Datasource Definition will be queried in the bound of the paging.
Parameters:
in_datasourcename_tx - The name of datasource
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
in_rowsperpage_nr - The number of rows in a page. Defaults to -1 which puts all rows in the datasource to the page.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_invalidpagenumber - Raised when specified page number does not exist in the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.


setrownumber

public  setrownumber(in_datasourcename_tx IN varchar2, 
in_rownumberinpage_nr IN number,
in_page_nr IN number DEFAULT null,
in_row_id IN number DEFAULT null)
Updates the row order in the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_rownumberinpage_nr - The row number in page
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
in_row_id - ID of the datasource row. If the value of this input parameter is null, then the order of current row is updated.
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidrowid - Raised when the row ID value does not exist in the datasource.
e_nocurrentrow - Raised when there is no current row in the datasource while the in_row_id parameter value is null.
e_invalidpagenumber - Raised when specified page number does not exist in the datasource.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setrownumberbyorarowid

public  setrownumberbyorarowid(in_datasourcename_tx IN varchar2, 
in_orarowid_ri IN rowid,
in_rownumberinpage_nr IN number,
in_page_nr IN number DEFAULT null)
Updates the row order in the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_orarowid_ri - Oracle row id value of a row in the datasource.
in_rownumberinpage_nr - The row number in page
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_orarowidnotdefined - Raised when the Oracle row id usage is not allowed for the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidorarowid - Raised when the specified Oracle row id is not found in the datasource.
e_duplicateorarowid - Raised when there is more than one row with the same Oracle row id value in the datasource.
e_invalidpagenumber - Raised when specified page number does not exist in the datasource.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setrownumberbypk

public  setrownumberbypk(in_datasourcename_tx IN varchar2, 
in_pk_tx IN varchar2,
in_rownumberinpage_nr IN number,
in_page_nr IN number DEFAULT null)
Updates the row order in the datasource.
Parameters:
in_datasourcename_tx - The name of datasource
in_pk_tx - Primary key value of a row in the datasource.
in_rownumberinpage_nr - The row number in page
in_page_nr - The page number that will be available to the UI. The default value for this input parameters null
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_primarykeynotdefined - Raised when there is no primary key definition found for the datasource.
e_notboundtodatasourcecolumn - Raised when a component is bound to the datasource but not to a datasource column.
e_invalidprimarykey - Raised when the specified primary key is not found in the datasource.
e_duplicateprimarykey - Raised when there is more than one row with the same primary key value in the datasource.
e_invalidpagenumber - Raised when specified page number does not exist in the datasource.
e_invalidrownumber - Raised when in_rowNumberInPage_nr value is not in the range of the current page. In every new page, page numbers start from 1.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


setwhereclause

public  setwhereclause(in_datasourcename_tx IN varchar2, 
in_criterionnames_t IN tt_criterionname,
in_bindvarvalues_t IN tt_bindvarvalue,
in_structure_cl IN clob DEFAULT keep_current_value)
Updates the whereclause of a datasource using the Criteria defined in the Datasource Definition.
Parameters:
in_datasourcename_tx - The name of the datasource to be updated
in_criterionnames_t - The names of the criteria to be used. Use api_datasource.ALL_CRITERIA to use every criterion.
in_bindvarvalues_t - bindvar name/value pairs to be set on the datasource.
in_structure_cl - Indicates how the criteria should be pieced together to form a valid where clause
Throws:
e_conversion - Raised when the value supplied for a bind variable cannot be casted to its data type.
e_missingmandatorycriterion - Raised when the list of criteria passed to the procedure is missing a criterion that is set as required.
e_atleastonecriterion - Raised when the setWhereClause produces a where clause that contains no criteria.
e_invaliddatasourcename - Raised when the datasource name is not found.


setwhereclause

public  setwhereclause(in_datasourcename_tx IN varchar2, 
in_criterionnames_t IN tt_criterionname,
in_structure_cl IN clob DEFAULT keep_current_value)
Updates the whereclause of a datasource using the Criteria defined in the Datasource Definition.
Parameters:
in_datasourcename_tx - The name of the datasource to be updated
in_criterionnames_t - The names of the criteria to be used. Use api_datasource.ALL_CRITERIA to use every criterion.
in_structure_cl - Indicates how the criteria should be pieced together to form a valid where clause
Throws:
e_conversion - Raised when the value supplied for a bind variable cannot be casted to its data type.
e_missingmandatorycriterion - Raised when the list of criteria passed to the procedure is missing a criterion that is set as required.
e_atleastonecriterion - Raised when the setWhereClause produces a where clause that contains no criteria.
e_invaliddatasourcename - Raised when the datasource name is not found.


setwhereclause

public  setwhereclause(in_datasourcename_tx IN varchar2, 
in_whereclause_cl IN clob)
Updates the whereclause of a datasource.
Parameters:
in_datasourcename_tx - The name of the datasource to be updated
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


takesnapshot

public  takesnapshot(in_datasourcename_tx IN varchar2)
Saves the current state (rows, row status etc....) of the datasource for later use.
Parameters:
in_datasourcename_tx - The name of datasource
Throws:
e_invaliddatasourcename - Raised when the datasource name is not found.
e_notsupportedapiforsingleton - Raised when the API is called for a datasource that uses a global data set.
e_notsupportedapiforreportmode - Raised when the API is called for a datasource that is in Reporting Mode


Formspider APIs