GET_REPORT_OBJECT_PROPERTY Built-in
Description
Programmatically obtain a property of a report object.
Syntax
FUNCTION GET_REPORT_OBJECT_PROPERTY
(report_id REPORT_OBJECT,
property NUMBER);
FUNCTION GET_REPORT_OBJECT_PROPERTY
(report_name VARCHAR2,
property NUMBER);
Built-in Type unrestricted procedure
Returns VARCHAR2
Enter Query Mode yes
Parameters
- report_id
-
- Specifies the unique ID of the report. You can get the report ID for a particular
report using FIND_REPORT_OBJECT
.
-
- report_name
-
- Specifies the unique name of the report.
-
- property
One of the following constants:
REPORT_EXECUTION_MODE: Returns a string value of the report execution mode,
either BATCH or RUNTIME
REPORT_COMM_MODE: Returns a string value of the report communication mode,
either SYNCHRONOUS or ASYNCHRONOUS
REPORT_DESTYPE: Returns a string value of the report destination type, either
PREVIEW, FILE, PRINTER, MAIL, CACHE, SCREEN, FTP, WEBDAV, ORACLEPORTAL, ORACLEWIRELESS, SECUREPDF, or BLOBDESTINATION
REPORT_FILENAME: Returns a string value of the report filename
REPORT_SOURCE_BLOCK: Returns a string value of the report source block name
REPORT_QUERY_NAME: Returns a string value of the report query name
REPORT_DESNAME: Returns a string value of the report destination name
REPORT_DESFORMAT: Returns a string value of the report destination format
REPORT_SERVER: Returns a string value of the report server name
REPORT_OTHER: Returns a string value of the other user-specified report properties
Usage Note
- GET_REPORT_OBJECT_PROPERTY returns a string value for all properties. In
contrast, SET_REPORT_OBJECT_PROPERTY
sets properties using constant or string values. The value type depends on
the particular property being set.
GET_REPORT_OBJECT_PROPERTY
Example
DECLARE
repid REPORT_OBJECT;
report_prop VARCHAR2(20);
BEGIN
repid := find_report_object('report4');
report_prop := get_report_object_property(repid,
REPORT_EXECUTION_MODE);
message('REPORT EXECUTION MODE PROPERTY IS ' || report_prop);
report_prop := get_report_object_property(repid, REPORT_COMM_MODE);
message('REPORT COMM_MODE PROPERTY IS ' || report_prop);
report_prop := get_report_object_property(repid, REPORT_DESTYPE);
message('REPORT DESTYPE PROPERTY IS ' || report_prop);
report_prop := get_report_object_property(repid, REPORT_FILENAME);
message('REPORT_FILENAME PROPERTY IS ' || report_prop);
END;