1 PACKAGE qa_chart_pareto_pkg AS
2 /* $Header: qacprtos.pls 120.2 2006/03/20 12:06:15 bso noship $ */
3 /*#
4 * This package is currently a private API to manage
5 * Quality's Release 12 Pareto charting feature. It is used to
6 * populate create and delete Pareto chart charting data.
7 * @rep:scope private
8 * @rep:product QA
9 * @rep:displayname Pareto Chart 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 pareto charting instance.
22 * @param p_criteria_id Foreign key to qa_criteria_headers.criteria_id
23 * @param p_x_element_id Charting x-axis collection element ID
24 * @param p_y_element_id Charting y-axis collection element ID
25 * @param p_function_code y-axis aggregate function
26 * @param p_title Chart title to be displayed in the chart
27 * @param p_description Chart description for information only
28 * @param p_sql SQL string to retrieve the charting data points
29 * @param p_top_n_groups Top N groups to plot. Default to all points.
30 * @param x_chart_id Return a new chart instance header ID (from qa_chart_headers_s).
31 * @param x_row_count Return the no. of data rows created
32 * @rep:displayname Create a Pareto chart charting instance
33 */
34 PROCEDURE create_chart(
35 p_criteria_id NUMBER,
36 p_x_element_id NUMBER,
37 p_y_element_id NUMBER,
38 p_function_code NUMBER,
39 p_title VARCHAR2,
40 p_description VARCHAR2,
41 p_sql VARCHAR2,
42 p_top_n_groups NUMBER DEFAULT NULL,
43 x_chart_id OUT NOCOPY NUMBER,
44 x_row_count OUT NOCOPY NUMBER);
45
46
47 /*#
48 * This procedure creates a pareto charting instance. It performs
49 * autonomous commit.
50 * @param p_criteria_id Foreign key to qa_criteria_headers.criteria_id
51 * @param p_x_element_id Charting x-axis collection element ID
52 * @param p_y_element_id Charting y-axis collection element ID
53 * @param p_function_code y-axis aggregate function
54 * @param p_title Chart title to be displayed in the chart
55 * @param p_description Chart description for information only
56 * @param p_sql SQL string to retrieve the charting data points
57 * @param p_top_n_groups Top N groups to plot. Default to all points.
58 * @param x_chart_id Return a new chart instance header ID (from qa_chart_headers_s).
59 * @param x_row_count Return the no. of data rows created
60 * @rep:displayname Create a Pareto chart charting instance and commit autonomously
61 */
62 PROCEDURE create_chart_autonomous(
63 p_criteria_id NUMBER,
64 p_x_element_id NUMBER,
65 p_y_element_id NUMBER,
66 p_function_code NUMBER,
67 p_title VARCHAR2,
68 p_description VARCHAR2,
69 p_sql VARCHAR2,
70 p_top_n_groups NUMBER DEFAULT NULL,
71 x_chart_id OUT NOCOPY NUMBER,
72 x_row_count OUT NOCOPY NUMBER);
73
74
75 /*#
76 * This procedure deletes the Pareto chart data points.
77 * @param p_chart_id Chart instance header ID to be deleted.
78 * @rep:displayname Delete a Pareto chart's data points
79 */
80 PROCEDURE delete_data(p_chart_id NUMBER);
81
82 /*#
83 * This procedure deletes the Pareto chart data points.
84 * It performs autonomous commit.
85 * @param p_chart_id Chart instance header ID to be deleted.
86 * @rep:displayname Delete a Pareto chart's data points and commit autonomously
87 */
88 PROCEDURE delete_data_autonomous(p_chart_id NUMBER);
89
90
91 END qa_chart_pareto_pkg;
[Home] [Help]