1 PACKAGE FUN_RICH_MESSAGES_PUB AUTHID CURRENT_USER AS
2 /*$Header: FUNXTMRULRTMPUS.pls 120.3 2006/10/05 04:59:02 havvari noship $ */
3 /*
4 * This package contains the public APIs for Rich Text Messages.
5 * @rep:scope internal
6 * @rep:product FUN
7 * @rep:displayname Fun:Rich Text Message
8 * @rep:category BUSINESS_ENTITY FUN_RICH_MESSAGES
9 * @rep:lifecycle active
10 */
11
12 --------------------------------------
13 -- declaration of record type
14 --------------------------------------
15
16 TYPE rich_messages_rec_type IS RECORD (
17 application_id NUMBER,
18 message_name VARCHAR2(30),
19 created_by_module VARCHAR2(150)
20 );
21
22
23 --------------------------------------
24 -- declaration of public procedures and functions
25 --------------------------------------
26
27
28 /**
29 * Use this routine to create a Rich Text Message its related information.
30 * @rep:scope internal
31 * @rep:lifecycle active
32 * @rep:displayname Create Rich Text Messages
33 * @rep:businessevent
34 * @rep:doccd
35 * @param p_rich_messages_rec PLSQL record of the Rich Text Message
36 * @param p_message_text Text of the Rich Text Message
37 * @param x_message_name Name of the Rich Text Message
38 * @param x_rich_messages_rec PLSQL Record of the Message
39 */
40
41 PROCEDURE create_rich_messages(
42 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
43 p_rich_messages_rec IN RICH_MESSAGES_REC_TYPE,
44 p_message_text IN CLOB,
45 x_message_name OUT NOCOPY VARCHAR2,
46 x_return_status OUT NOCOPY VARCHAR2,
47 x_msg_count OUT NOCOPY NUMBER,
48 x_msg_data OUT NOCOPY VARCHAR2
49 );
50
51
52 /**
53 * Use this routine to update a Rich text Message. The API updates records in the
54 * FUN_RICH_MESSAGES table.
55 * @rep:scope internal
56 * @rep:lifecycle active
57 * @rep:displayname Update Rich Text Messages
58 * @rep:businessevent
59 * @rep:doccd
60 * @rep:displayname Update Rich message
61 * @param p_rich_messages_rec PLSQL record of the Rich Message
62 * @param p_message_text Text of the Message
63 * @param p_object_version_number Object Version Number
64 * @param x_rich_messages_rec PLSQL Record of the Message
65 */
66 PROCEDURE update_rich_messages(
67 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
68 p_rich_messages_rec IN RICH_MESSAGES_REC_TYPE,
69 p_message_text IN CLOB,
70 p_object_version_number IN OUT NOCOPY NUMBER,
71 x_return_status OUT NOCOPY VARCHAR2,
72 x_msg_count OUT NOCOPY NUMBER,
73 x_msg_data OUT NOCOPY VARCHAR2
74 );
75
76 /**
77 * Use this routine to Select a Rich Text Message. The API Select records From the
78 * FUN_RICH_MESSAGES table.
79 * @rep:scope internal
80 * @rep:lifecycle active
81 * @rep:displayname Display Rich Text Message
82 * @rep:businessevent
83 * @rep:doccd
84 * @param p_message_name Name of the Message
85 * @param x_message_text Text of the Message
86 * @param p_application_id Application id of the Message
87 * @param x_rich_messages_rec PLSQL Record of the Message
88 * @rep:displayname Get Rich message
89 */
90
91 PROCEDURE get_rich_messages_rec (
92 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
93 p_message_name IN VARCHAR2,
94 p_application_id IN NUMBER,
95 x_message_text OUT NOCOPY CLOB,
96 x_rich_messages_rec OUT NOCOPY RICH_MESSAGES_REC_TYPE,
97 x_return_status OUT NOCOPY VARCHAR2,
98 x_msg_count OUT NOCOPY NUMBER,
99 x_msg_data OUT NOCOPY VARCHAR2
100 );
101
102 /**
103 * Use this routine to delete a Rich Text Message. The API deletes records in the
104 * FUN_RICH_MESSAGES table.
105 * @rep:scope internal
106 * @rep:lifecycle active
107 * @rep:displayname Delete Rich Text Message
108 * @rep:businessevent
109 * @rep:doccd
110 * @param p_message_name Name of the Message
111 * @param p_language_code Language code of the Message
112 * @param p_application_id Application id of the Message
113 * @rep:displayname Delete Rich message
114 */
115
116 PROCEDURE delete_rich_messages(
117 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
118 p_message_name IN VARCHAR2,
119 p_language_code IN VARCHAR2,
120 p_application_id IN NUMBER,
121 x_return_status OUT NOCOPY VARCHAR2,
122 x_msg_count OUT NOCOPY NUMBER,
123 x_msg_data OUT NOCOPY VARCHAR2
124 );
125
126 END FUN_RICH_MESSAGES_PUB;
[Home] [Help]