1 PACKAGE qa_chart_headers_pkg AS
2 /* $Header: qacharts.pls 120.1 2006/02/07 23:45:39 bso noship $ */
3 /*#
4 * This package is currently a private API to interface with
5 * Quality's Release 12 Charting Architecture. It is used to
6 * create and delete a chart instance (qa_chart_headers)
7 * @rep:scope private
8 * @rep:product QA
9 * @rep:displayname Chart Headers API
10 * @rep:lifecycle active
11 * @rep:category BUSINESS_ENTITY QA_RESULT
12 */
13
14 --
15 -- Tracking Bug 4939897
16 -- R12 Forms Tech Stack Upgrade - Obsolete Oracle Graphics
17 --
18
19
20 /*#
21 * This procedure creates a generic chart instance header.
22 * After calling this procedure, the user usually needs to populate
23 * the chart details (data points) by calling qa_chart_generic_pkg.
24 * Null is acceptable for all IN parameters.
25 * @param p_criteria_id Foreign key to qa_criteria_headers.criteria_id
26 * @param p_title Chart title to be displayed in the chart
27 * @param p_description Chart description for information only
28 * @param p_x_label X-axis label
29 * @param p_y_label Y-axis label
30 * @param x_chart_id Return a new chart instance header ID (from qa_chart_headers_s)
31 * @rep:displayname Create a chart instance header
32 */
33 PROCEDURE create_chart(
34 p_criteria_id NUMBER,
35 p_title VARCHAR2,
36 p_description VARCHAR2,
37 p_x_label VARCHAR2,
38 p_y_label VARCHAR2,
39 x_chart_id OUT NOCOPY NUMBER);
40
41
42 /*#
43 * This procedure creates a generic chart instance header.
44 * It is identical to create_chart except it performs
45 * autonomous commit.
46 * @param p_criteria_id Foreign key to qa_criteria_headers.criteria_id
47 * @param p_title Chart title to be displayed in the chart
48 * @param p_description Chart description for information only
49 * @param p_x_label X-axis label
50 * @param p_y_label Y-axis label
51 * @param x_chart_id Return a new chart instance header ID (from qa_chart_headers_s)
52 * @rep:displayname Create a chart instance header and commit autonomously
53 */
54 PROCEDURE create_chart_autonomous(
55 p_criteria_id NUMBER,
56 p_title VARCHAR2,
57 p_description VARCHAR2,
58 p_x_label VARCHAR2,
59 p_y_label VARCHAR2,
60 x_chart_id OUT NOCOPY NUMBER);
61
62
63 /*#
64 * This procedure deletes a chart (header and detail
65 * data points will be deleted together).
66 * @param p_chart_id Chart instance header ID to be deleted
67 * @rep:displayname Delete a chart instance
68 */
69 PROCEDURE delete_chart(p_chart_id NUMBER);
70
71
72 /*#
73 * This procedure deletes a chart (header and detail
74 * data points will be deleted together). It performs
75 * autonomous commit.
76 * @param p_chart_id Chart instance header ID to be deleted
77 * @rep:displayname Delete a chart instance and commit autonomously
78 */
79 PROCEDURE delete_chart_autonomous(p_chart_id NUMBER);
80
81
82 /*#
83 * This procedure sets the x-axis label of a chart.
84 * @param p_chart_id Chart instance header ID to be modified
85 * @param p_label New label
86 * @rep:displayname Set the x-axis label
87 */
88 PROCEDURE set_x_label(p_chart_id NUMBER, p_label VARCHAR2);
89
90
91 /*#
92 * This procedure sets the y-axis label of a chart.
93 * @param p_chart_id Chart instance header ID to be modified
94 * @param p_label New label
95 * @rep:displayname Set the y-axis label
96 */
97 PROCEDURE set_y_label(p_chart_id NUMBER, p_label VARCHAR2);
98
99
100 /*#
101 * This function returns a commonly used axis label.
102 * Very often an axis label is either a collection element name
103 * or "Function of element" if a function is specified by user.
104 * @param p_element_id Collection element ID to be used in the axis
105 * @param p_function_code Function used in axis if not null.
106 * @rep:displayname Return a common axis label
107 */
108 FUNCTION get_function_axis_label(
109 p_element_id NUMBER,
110 p_function_code NUMBER) RETURN VARCHAR2;
111
112
113 END qa_chart_headers_pkg;
[Home] [Help]