1 PACKAGE igf_sp_assign_pub AS
2 /* $Header: IGFSP05S.pls 120.1 2006/01/17 02:49:12 svuppala noship $ */
3 /*#
4 * The Sponsorship Assignment API is a public API that is used to assign a number of students to a sponsor automatically.
5 * Oracle Student System allows you to create student-sponsor assignment records though the interface. This API is a means to automatically create multiple student-sponsor assignment records.
6 * @rep:scope public
7 * @rep:product IGF
8 * @rep:displayname Import Sponsorship Relationships
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY IGS_SPONSORSHIP
12 */
13
14 /****************************************************************************
15 Created By: Vinay Chappidi
16 Date Created By: 19-Feb-2003
17 Purpose: This procedure is the main api call.
18 Known limitations,enhancements,remarks:
19
20 Change History
21 Who When What
22 svuppala 9-Jan-2006 R12 iRep Annotation - added annotation
23 ******************************************************************************/
24
25 -- Start of comments
26 -- API name : CREATE_STDNT_SPNSR_REL
27 -- Type : Public
28 -- Pre-reqs : Complete Setup has to be done before invoking this API
29 -- Function : Creates a Student Sponsor Relationship
30 -- Parameters :
31 -- IN : p_api_version IN NUMBER Required
32 -- Current Version number of the Public API
33 --
34 -- IN : p_init_msg_list IN VARCHAR2 Optional, Default:fnd_api.g_false
35 -- Message stack initialization parameter
36 --
37 -- IN : p_commit IN VARCHAR2 Optional, Default:fnd_api.g_false
38 -- Parameter to check if the current transactions have
39 -- to be committed explicitly.
40 --
41 --
42 -- IN : p_person_id IN NUMBER Conditionally Required
43 -- Person ID of the person for creating a Student-Sponsor
44 -- relationship.
45 --
46 -- IN : p_alt_person_id_type IN VARCHAR2 Conditionally Required
47 -- User defined Person Id Type.
48 --
49 -- IN : p_api_person_id IN VARCHAR2 Conditionally Required
50 -- Alternate ID parameter in combination with derived
51 -- System defined Person ID type will be used to identify
52 -- a unique person.
53 --
54 -- IN : p_sponsor_code IN VARCHAR2 Required
55 -- Active Sponsor code pre-defined in the system for
56 -- an Award Year Calendar Instance
57 --
58 -- IN : p_awd_ci_cal_type IN VARCHAR2 Required
59 -- Award Calendar Type parameter for which the sponsor is
60 -- offering sponsorships to students.
61 --
62 -- IN : p_awd_ci_sequence_number IN NUMBER Required
63 -- Award Calendar Instance Sequence Number parameter for
64 -- which the sponsor is offering sponsorships to students.
65 --
66 -- IN : p_ld_cal_type IN VARCHAR2 Required
67 -- Load/Term Calendar Type parameter under Award Calendar
68 -- Instance for which the sponsor is offering
69 -- sponsorships to students.
70 --
71 -- IN : p_ld_ci_sequence_number IN NUMBER Required
72 -- Load/Term Calendar Instance Sequence Number parameter
73 -- for which the sponsor is offering sponsorships to students.
74 --
75 -- IN : p_amount IN NUMBER Required
76 -- Amount parameter that the sponsor is willing to sponsor
77 -- a student for a Term/Load Calendar Instance with in
78 -- an Award Calendar Instance.
79 -- OUT : x_return_status OUT VARCHAR2
80 -- Parameter to convey public API's return status.
81 --
82 -- OUT : x_msg_count OUT NUMBER
83 -- Parameter contains message count returned
84 -- by the Public API.
85 --
86 -- OUT : x_msg_data OUT VARCHAR2
87 -- Parameter contains the messages in the encoded format.
88 --
89 -- Version : Current version 1.0
90 -- Initial version 1.0
91 -- End of comments
92
93 /*#
94 * The Sponsorship Assignment API is a public API that is used to assign a number of students to a sponsor automatically.
95 * Oracle Student System allows you to create student-sponsor assignment records though the interface. This API is a means to automatically create multiple student-sponsor assignment records.
96 * @param p_api_version The version number will be used to compare with the public api's current version number. Unexpected error is raised if version in-compatibility exists.
97 * @param p_init_msg_list Set to FND_API.G_TRUE to have API automatically to initialize message list.
98 * @param p_commit Set to FND_API.G_TRUE to have API to commit automatically.
99 * @param x_return_status The return status values are as follows; Success - FND_API.G_RET_STS_SUCCESS ; Error - FND_API.G_RET_STS_ERROR ; Unexpected error - FND_API.G_RET_STS_UNEXp_ERROR
100 * @param x_msg_count The message count.
101 * @param x_msg_data The message data.
102 * @param p_person_id Person Identifier of the person for creating a Student-Sponsor relationship.
103 * @param p_alt_person_id_type User defined Person ID Type.
104 * @param p_api_person_id Alternate ID parameter in combination with derived System defined Person ID type will be used to identify a unique person.
105 * @param p_sponsor_code Active Sponsor code pre-defined in the system for an Award Year Calendar Instance
106 * @param p_awd_ci_cal_type Award Calendar Type parameter for which the sponsor is offering sponsorships to students.
107 * @param p_awd_ci_sequence_number Award Calendar Instance Sequence Number parameter for which the sponsor is offering sponsorships to students.
108 * @param p_ld_cal_type Load/Term Calendar Type parameter under Award Calendar Instance for which the sponsor is offering sponsorships to students.
109 * @param p_ld_ci_sequence_number Load/Term Calendar Instance Sequence Number parameter for which the sponsor is offering sponsorships to students.
110 * @param p_amount Amount parameter that the sponsor is willing to sponsor a student for a Term/Load Calendar Instance within an Award Calendar Instance.
111 * @rep:scope public
112 * @rep:lifecycle active
113 * @rep:displayname Import Sponsorship Relationships
114 */
115 PROCEDURE create_stdnt_spnsr_rel(p_api_version IN NUMBER,
116 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
117 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
118 x_return_status OUT NOCOPY VARCHAR2,
119 x_msg_count OUT NOCOPY NUMBER,
120 x_msg_data OUT NOCOPY VARCHAR2,
121 p_person_id IN NUMBER,
122 p_alt_person_id_type IN VARCHAR2,
123 p_api_person_id IN VARCHAR2,
124 p_sponsor_code IN VARCHAR2,
125 p_awd_ci_cal_type IN VARCHAR2,
126 p_awd_ci_sequence_number IN NUMBER,
127 p_ld_cal_type IN VARCHAR2,
128 p_ld_ci_sequence_number IN NUMBER,
129 p_amount IN NUMBER);
130 END igf_sp_assign_pub;
[Home] [Help]