DBA Data[Home] [Help]

PACKAGE: APPS.IGS_EN_SPAA_LGCY_PUB

Source


1 PACKAGE igs_en_spaa_lgcy_pub AS
2 /* $Header: IGSENA5S.pls 120.1 2006/01/17 03:34:43 rnirwani noship $ */
3 /*#
4  * The Student Award Aim Import process is a public API designed for use in populating rows with data
5  * during a system conversion.  This API is also used by the Legacy Import Process for Enrollment and
6  * Records when importing rows from the IGS_EN_LGY_SPAA_INT interface table.
7  * @rep:scope public
8  * @rep:product IGS
9  * @rep:lifecycle active
10  * @rep:displayname Import Legacy Award Aim
11  * @rep:compatibility S
12  * @rep:category BUSINESS_ENTITY IGS_STUDENT_PROGRAM
13  */
14  -- irep annotations above.
15 
16 --Start of comments
17 --      API name        : create_student_awd_aim
18 --      Type            : Public.
19 --      Function        : Inserts one record passed as parameter of TYPE awd_aim_rec_type into the table
20 --                        Award Aims after validating the values for each fields.
21 --      Pre-reqs        : None.
22 --      Parameters      :
23 --      IN              :       p_api_version           IN NUMBER       Required
24 --                              p_init_msg_list         IN VARCHAR2     Optional Default = FND_API.G_FALSE
25 --                              p_commit                IN VARCHAR2     Optional Default = FND_API.G_FALSE
26 --                              p_validation_level      IN NUMBER       Optional Default = FND_API.G_VALID_LEVEL_FULL
27 --                              p_awd_aim_rec           IN awd_aim_rec_type (this is a record type declared in the spec
28 --                                                                            contains the below mentioned fields)
29 --                  {
30 --                   person_number           :Person number of the student
31 --                   program_cd              :The program code in which the award is being studied. Must be an uppercase value.
32 --                   award_cd                :The award code being studied. Must be an uppercase value.
33 --                   start_dt                :The start date of the award.
34 --                   end_dt                  :The date the award was ended, whether completed or not.
35 --                   complete_ind            :Indicates whether the award has been completed.
36 --                   conferral_dt            :The conferral date of the student award.
37 --                   honours_level           :The honors level achieved for the student award. Must be an uppercase value.
38 --                  }
39 --
40 --      OUT             :       x_return_status         OUT     VARCHAR2(1)
41 --                              x_msg_count             OUT     NUMBER
42 --                              x_msg_data              OUT     VARCHAR2(2000)
43 --
44 --
45 --      Version : Current version       1.0
46 -- End of comments
47 --
48 -- Change History :
49 -- Who        When        What
50 -- anilk      07-Oct-2003 changes in awd_aim_rec_type for Program Completion Validation, Bug# 3129913
51 -- (reverse chronological order - newest change first)
52 
53 TYPE awd_aim_rec_type IS RECORD (
54 person_number           igs_en_lgy_spaa_int.person_number%TYPE,
55 program_cd              igs_en_lgy_spaa_int.program_cd%TYPE,
56 award_cd                igs_en_lgy_spaa_int.award_cd%TYPE,
57 start_dt                igs_en_lgy_spaa_int.start_dt%TYPE,
58 end_dt                  igs_en_lgy_spaa_int.end_dt%TYPE,
59 complete_ind            igs_en_lgy_spaa_int.complete_ind%TYPE,
60 conferral_dt            igs_en_lgy_spaa_int.conferral_dt%TYPE,
61 award_mark              igs_en_lgy_spaa_int.award_mark%TYPE,
62 award_grade             igs_en_lgy_spaa_int.award_grade%TYPE,
63 grading_schema_cd       igs_en_lgy_spaa_int.grading_schema_cd%TYPE,
64 gs_version_number       igs_en_lgy_spaa_int.gs_version_number%TYPE
65 );
66 
67 -- irep annotations below
68 /*#
69  * The Student Award Aim Import process is a public API designed for use in populating rows with data
70  * during a system conversion.  This API is also used by the Legacy Import Process for Enrollment and
71  * Records when importing rows from the IGS_EN_LGY_SPAA_INT interface table.
72  * @param p_api_version The version number will be used to compare with claim public api's current version number.Unexpected error is raised if version in-compatibility exists.
73  * @param P_init_msg_list Set to FND_API.G_TRUE to have API automatically to initialize message list.
74  * @param p_commit Set to FND_API.G_TRUE to have API to commit automatically.
75  * @param p_validation_level Public API will always perform full level of validation.
76  * @param p_awd_aim_rec Legacy Student Award Aim record type. Refer to IGS_EN_LGY_SPAA_INT for detail column descriptions.
77  * @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.
78  * @param x_msg_count Message count.
79  * @param x_msg_data Message data.
80  * @rep:scope public
81  * @rep:lifecycle active
82  * @rep:displayname Import Legacy Award Aim
83  */
84 PROCEDURE create_student_awd_aim
85 (       p_api_version       IN   NUMBER,
86         p_init_msg_list     IN   VARCHAR2 DEFAULT FND_API.G_FALSE,
87         p_commit            IN   VARCHAR2 DEFAULT FND_API.G_FALSE,
88         p_validation_level  IN   NUMBER   DEFAULT FND_API.G_VALID_LEVEL_FULL,
89         p_awd_aim_rec       IN   awd_aim_rec_type,
90         x_return_status     OUT  NOCOPY VARCHAR2,
91         x_msg_count         OUT  NOCOPY NUMBER,
92         x_msg_data          OUT  NOCOPY VARCHAR2
93 );
94 
95 END igs_en_spaa_lgcy_pub;