1 package fnd_help AUTHID CURRENT_USER as
2 /* $Header: AFMLHLPS.pls 120.2.12010000.2 2010/02/10 07:15:25 nchiring 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 -- HELPCONTEXT when false, then help root is taken for the global help content, typically
26 -- represented by FND:LIBRARY.
27 -- When true, then system displays context sensitive help content.
28
29 --
30 function Get_Url(
31 APPSNAME in varchar2,
32 TARGET in varchar2,
33 HELPSYSTEM in boolean default TRUE,
34 TARGETTYPE in varchar2 default 'TARGET',
35 CONTEXTHELP in boolean default TRUE )
36 return varchar2;
37
38 --
39 -- Get
40 -- Get GFM identifier for help target
41 -- IN
42 -- path - Relative path of target, in the format:
43 -- /<LANG>/<APP>/<FILE>
44 -- /<LANG>/<APP>/@<TARGET>
45 -- RETURNS
46 -- GFM-compliant string identifying file to retrieve. Syntax:
47 -- file_id=<fileid>
48 --
49 function Get(
50 path in varchar2,
51 file_id out nocopy varchar2) return boolean;
52
53
54 -- Help_Search
55 -- Implement search
56 -- IN
57 -- find_string - string to search for
58 -- IN OUT
59 -- results - array of links.
60 --
61 -- This procedure implements the Help Document search and can be called
62 -- by other folks who wish to include help documents in their own search
63 -- results. Takes the search string, parses and reshapes it behave more
64 -- like standard browser searches, finds the matching Help Documents,
65 -- and returns them as an array of links to be displayed by the caller.
66 ----------------------------------------------------------------------------
67 procedure Help_Search(
68 find_string in varchar2 default null,
69 scores in out nocopy results_tab,
70 apps in out nocopy results_tab,
71 titles in out nocopy results_tab,
72 file_names in out nocopy results_tab,
73 langpath in varchar2 default userenv('LANG'),
74 appname in varchar2 default null,
75 lang in varchar2 default null,
76 row_limit in number default null);
77
78 procedure LOAD_DOC (
79 x_file_id in varchar2,
80 x_language in varchar2,
81 x_application in varchar2,
82 x_file_name in varchar2,
83 x_custom_level in varchar2,
84 x_title in varchar2,
85 x_version in varchar2 );
86
87 procedure LOAD_TARGET (
88 x_file_id in varchar2,
89 x_target_name in varchar2 );
90
91 procedure CULL_ROW (
92 x_file_id in varchar2,
93 x_language in varchar2,
94 x_application in varchar2,
95 x_file_name in varchar2,
96 x_custom_level in varchar2 );
97
98 -----------------------------------------------------------------------------
99 -- delete_doc
100 -- Delete a document from the iHelp system
101 -- IN:
102 -- x_application - Application shortname of file owner
103 -- x_file_name - Name of file to delete
104 -- x_language - Language to delete (null for all)
105 -- x_custom_level - Custom level to delete (null for all)
106 -----------------------------------------------------------------------------
107 procedure delete_doc (
108 x_application in varchar2,
109 x_file_name in varchar2,
110 x_language in varchar2 default null,
111 x_custom_level in varchar2 default null);
112
113 end fnd_help;
[Home] [Help]