1 PACKAGE jdr_custom_internal AS
2 /* $Header: JDRCTINS.pls 120.3 2005/10/26 06:15:11 akbansal noship $ */
3 -- Retrieves all active customization documents corresponding
4 -- to the given base document and customization layers.
5 --
6 -- For customization layer i, lyrtypes[i] refers to the layer
7 -- type, and lyrvalues[i] refers to its value
8 --
9 -- If a customization doc exists for a given layer, the doc name and
10 -- layer type will be retrieved in precedence order
11 -- Parameters:
12 -- baseDoc - the fully qualified name of the base document.
13 -- layerTypes - an array of customization layer types
14 -- layerValues - an array of customization layer values
15 -- validTypes - a returned array of existing customization types
16 -- custDocs - a returned array of existing customization documents
17 --
18 PROCEDURE getActiveLayers(baseDoc IN VARCHAR2,
19 lyrTypes IN jdr_stringArray,
20 lyrValues IN jdr_stringArray,
21 validTypes OUT NOCOPY /* file.sql.39 change */ jdr_stringArray,
22 custDocs OUT NOCOPY /* file.sql.39 change */ jdr_stringArray);
23 --
24 -- Retrieves a list of all customization documents corresponding to the given
25 -- base document.
26 --
27 PROCEDURE getCustomizationDocs(baseDoc IN VARCHAR2,
28 custDocs OUT NOCOPY /* file.sql.39 change */ jdr_stringArray);
29
30 -- Retrieves both active and inactive customization documents corresponding
31 -- to the given base document and customization layers.
32 --
33 -- For customization layer i, lyrtypes[i] refers to the layer
34 -- type, and lyrvalues[i] refers to its value
35 --
36 -- If a customization doc exists for a given layer, the doc name and
37 -- layer type will be retrieved in precedence order
38 -- Parameters:
39 -- baseDoc - the fully qualified name of the base document.
40 -- layerTypes - an array of customization layer types
41 -- layerValues - an array of customization layer values
42 -- validTypes - a returned array of existing customization types
43 -- custDocs - a returned array of existing customization documents
44 --
45 PROCEDURE getLayers(baseDoc IN VARCHAR2,
46 lyrTypes IN jdr_stringArray,
47 lyrValues IN jdr_stringArray,
48 validTypes OUT NOCOPY /* file.sql.39 change */ jdr_stringArray,
49 custDocs OUT NOCOPY /* file.sql.39 change */ jdr_stringArray);
50
51 --
52 -- This procedure should only be called by the customer migration
53 -- utility. It will move the shared customizations on the "region"
54 -- document, to per instance customizations on the "page" document.
55 --
56 -- The customer migration utility should call this when a region, which
57 -- previously had been inlined in a page, has been moved to its own
58 -- document; and when the new region has customizations associated with it.
59 --
60 -- The "region" document will refer to the customization document associated
61 -- with the region which has been refactored out of the page. The "page"
62 -- document will refer to the customization document associated with the
63 -- page that had previously contained the region.
64 --
65 -- This method will do the following:
66 --
67 -- (1) If the "page" document does not contain any references to the
68 -- "region" document (i.e. it does not contain any customizations
69 -- applicable to the region), then it converts the shared customizations
70 -- on the region to per instance customizations on the page.
71 --
72 -- (2) If the page document does contain references to the region document,
73 -- then the page customization document will remain unchanged.
74 --
75 -- (3) Any translations on the region document will be migrated to the
76 -- page document.
77 --
78 -- (4) Regardless of whether or not the customizations were migrated, the
79 -- region document will be deleted, as well as any translations on the
80 -- region document.
81 --
82 -- Limitations:
83 --
84 -- (1) This assumes that the customization documents follow the format of
85 -- the documents created by JRAD. Specifically, jrad tags must not be
86 -- prefaced with a namespace, but should be in the default namespace.
87 -- For example, the views tage should look like:
88 -- <views ...>
89 -- not:
90 -- <jrad:views ...>
91 --
92 -- (2) It is assumed that the extending region is not a top level
93 -- component. This will not work correctly if the extending region is
94 -- a top level component.
95 --
96 -- (3) It is assumed that the name of the region customization document
97 -- is in the old style naming.
98 --
99 -- Parameters:
100 -- regionCustDocName - the fully qualified name of the customization
101 -- document for the region
102 -- extendingRegionName - the fully qualified name of the extending region
103 --
104 PROCEDURE migrateCustomizationsToPage(regionCustDocName IN VARCHAR2,
105 extendingRegionName IN VARCHAR2);
106
107 -- Sorts an array of layer types into precedence order
108 --
109 -- result: lyrTypes.FIRST has lowest precedence
110 -- lyrTypes.LAST has highest precedence
111 PROCEDURE sortLayers(lyrTypes IN OUT NOCOPY /* file.sql.39 change */ jdr_stringArray);
112
113 END;
[Home] [Help]