DBA Data[Home] [Help]

PACKAGE: APPS.FND_SYSTEM_EXCEPTION

Source


1 package FND_SYSTEM_EXCEPTION AUTHID CURRENT_USER as
2 /* $Header: AFCPFSES.pls 115.3 2002/02/08 19:44:26 nbhambha noship $ */
3 
4 -- Package -   FND_SYSTEM_EXCEPTION
5 
6 -- Name : Set_Name
7 -- Description:
8 --       This call names the exception event
9 --       By associating a message name (from Fnd_Messages)with the exception
10 --       we will be able to present the System Administrator with
11 --       translated description of the exception condition instead
12 --       of showing it in the language of the session where it
13 --       occurred .
14 -- Arguments:
15 --
16 --    Message_Appl_Short_Name
17 --                - Application short name of the message
18 --    Name        - Message name
19 --    Module name     -
20 --    Severity    - ERROR/WARNING/FATAL
21 --
22 --    Returns Event_Id that you need to use with Set_Token calls .
23 
24 FUNCTION Set_Name (Message_Appl_Short_Name In Varchar2,
25 			   Message_Name    In Varchar2,
26                            Module          In Varchar2 Default Null,
27                            Severity    	   In Varchar2  Default 'Warning')
28                   return number;
29 
30 -- Name : Set_Token
31 -- Description:
32 --     Sets token name and value.
33 --     Call this procedure for everey 'token' in the set message.
34 --     Set_Name has to be called before calling Set_Token
35 -- Arguments:
36 --     Event_Id - event value for which you are setting the token.
37 --     Token    - token name
38 --     Value    - token value  (** Maximum allowed size is 2000**)
39 --     Type     - 'C' = Constant. Value is used directly in the token
40 --                       substitution.
41 --                'S' = Select. Value is a SQL statement which
42 --                      returns a single varchar2 value.
43 --                      (e.g. A translated concurrent manager name.)
44 --                      This statement is run when the
45 --                      even is retrieved, and the result is used in
46 --                      the token substitution.
47 --                      (SQL statement cannot be more than 2000 in
48 --                       length)
49 --                'T' = Translate.  Value is a message name.
50 --                      This message must belong to the same
51 --                      application as the message specified
52 --                      in the Set_Name function.
53 --                      The message text will be used in the token
54 --                      substitution.
55 
56 
57 PROCEDURE set_token(Event_Id In Number,
58 	Token    In Varchar2,
59 	Value    In Varchar2 Default Null,
60 	Type     In Varchar2 Default 'C');
61 
62 -- Name : Post
63 -- Description:
64 --     Call this function after calling Set_Name and optionally
65 --     Set_Token.
66 --     This call also captures the context in which the
67 --     exception occurred.
68 --     If successfull it returns TRUE else returns FALSE.
69 -- Arguments: Event_Id - event_id for which you want to post events.
70 
71 
72 FUNCTION Post (Event_Id In Number ) return boolean;
73 
74 
75 end FND_SYSTEM_EXCEPTION;