1 package fnd_help as
2 /* $Header: AFMLHLPS.pls 120.2 2005/08/26 10:38:01 skghosh ship $ */
3
4
5 TYPE results_tab is TABLE of varchar2(1000)
6 index by binary_integer;
7
8 blank_search exception;
9
10 syntax_err exception;
11 pragma exception_init(syntax_err, -29902);
12
13 --
14 -- GET_URL
15 -- Gets the URL for a help document based on the target desired.
16 -- IN:
17 -- APPSNAME is the application short name for the application
18 -- of the help document
19 -- TARGET is the name of the help target or help file. For context
20 -- sensitive help an example would be "FORM.WINDOW".
21 -- HELPSYSTEM determines whether to generate a url to bring up the
22 -- entire help system or just the specified document
23 -- TARGETTYPE specifies whether the target is a help target or filename.
24 -- valid values are TARGET or FILE)
25 --
26 function Get_Url(
27 APPSNAME in varchar2,
28 TARGET in varchar2,
29 HELPSYSTEM in boolean default TRUE,
30 TARGETTYPE in varchar2 default 'TARGET')
31 return varchar2;
32
33 --
34 -- Get
35 -- Get GFM identifier for help target
36 -- IN
37 -- path - Relative path of target, in the format:
38 -- /<LANG>/<APP>/<FILE>
39 -- /<LANG>/<APP>/@<TARGET>
40 -- RETURNS
41 -- GFM-compliant string identifying file to retrieve. Syntax:
42 -- file_id=<fileid>
43 --
44 function Get(
45 path in varchar2,
46 file_id out nocopy varchar2) return boolean;
47
48
49 -- Help_Search
50 -- Implement search
51 -- IN
52 -- find_string - string to search for
53 -- IN OUT
54 -- results - array of links.
55 --
56 -- This procedure implements the Help Document search and can be called
57 -- by other folks who wish to include help documents in their own search
58 -- results. Takes the search string, parses and reshapes it behave more
59 -- like standard browser searches, finds the matching Help Documents,
60 -- and returns them as an array of links to be displayed by the caller.
61 ----------------------------------------------------------------------------
62 procedure Help_Search(
63 find_string in varchar2 default null,
64 scores in out nocopy results_tab,
65 apps in out nocopy results_tab,
66 titles in out nocopy results_tab,
67 file_names in out nocopy results_tab,
68 langpath in varchar2 default userenv('LANG'),
69 appname in varchar2 default null,
70 lang in varchar2 default null,
71 row_limit in number default null);
72
73 procedure LOAD_DOC (
74 x_file_id in varchar2,
75 x_language in varchar2,
76 x_application in varchar2,
77 x_file_name in varchar2,
78 x_custom_level in varchar2,
79 x_title in varchar2,
80 x_version in varchar2 );
81
82 procedure LOAD_TARGET (
83 x_file_id in varchar2,
84 x_target_name in varchar2 );
85
86 procedure CULL_ROW (
87 x_file_id in varchar2,
88 x_language in varchar2,
89 x_application in varchar2,
90 x_file_name in varchar2,
91 x_custom_level in varchar2 );
92
93 -----------------------------------------------------------------------------
94 -- delete_doc
95 -- Delete a document from the iHelp system
96 -- IN:
97 -- x_application - Application shortname of file owner
98 -- x_file_name - Name of file to delete
99 -- x_language - Language to delete (null for all)
100 -- x_custom_level - Custom level to delete (null for all)
101 -----------------------------------------------------------------------------
102 procedure delete_doc (
103 x_application in varchar2,
104 x_file_name in varchar2,
105 x_language in varchar2 default null,
106 x_custom_level in varchar2 default null);
107
108 end fnd_help;
[Home] [Help]