Package sb_studypath

Package sb_studypath_enrollment

Common Business interface for the Study Path Enrollment API (sb_studypath_enrollment).

Program units

f_api_version	Returns the API version number.
f_exists	Checks if a record exists.
f_isequal	Compares two records for equality.
f_query_all	Selects all records for the entity.
f_query_one	Selects one record using the key.
f_query_by_rowid	Selects one record using the ROWID.
f_query_one_lock	Selects one record and locks it.
f_reg_eligible	Determines if student's study path is eligible for registration
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

studypath_enrollment_rec	Business Entity record type
studypath_enrollment_ref	Entity cursor variable type
studypath_enrollment_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(20) := 'STUDYPATH_ENROLLMENT';

Business Entity Name

M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'SFRENSP';

Base table name

studypath_enrollment_rec

TYPE studypath_enrollment_rec IS RECORD (
  r_term_code               sfrensp.sfrensp_term_code%TYPE,
  r_pidm                    sfrensp.sfrensp_pidm%TYPE,
  r_key_seqno               sfrensp.sfrensp_key_seqno%TYPE,
  r_ests_code               sfrensp.sfrensp_ests_code%TYPE,
  r_ests_date               sfrensp.sfrensp_ests_date%TYPE,
  r_add_date                sfrensp.sfrensp_add_date%TYPE,
  r_user                    sfrensp.sfrensp_user%TYPE,
  r_data_origin             sfrensp.sfrensp_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

studypath_enrollment_ref

TYPE studypath_enrollment_ref IS REF CURSOR RETURN studypath_enrollment_rec;

Entity cursor variable type

studypath_enrollment_tab

TYPE studypath_enrollment_tab IS TABLE OF studypath_enrollment_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version

Function f_api_version RETURN PLS_INTEGER

Returns the API version number.

Returns

Version of the API signature. Changes only when the signature changes.

f_exists

Function f_exists(p_pidm      sfrensp.sfrensp_pidm%TYPE,
                  p_term_code sfrensp.sfrensp_term_code%TYPE,
                  p_key_seqno sfrensp.sfrensp_key_seqno%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24) Required Key
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_isequal

Function f_isequal(rec_one studypath_enrollment_rec,
                   rec_two studypath_enrollment_rec) RETURN VARCHAR2

Compares two records for equality.
Tests each field of rec_one against the corresponding field of rec_two. Two null values are considered equal.

Parameters

	rec_one	The first record to compare. Type studypath_enrollment_rec Required
	rec_two	The second record to compare. Type studypath_enrollment_rec Required

Returns

Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_query_all

Function f_query_all(p_pidm      sfrensp.sfrensp_pidm%TYPE,
                     p_term_code sfrensp.sfrensp_term_code%TYPE DEFAULT NULL,
                     p_key_seqno sfrensp.sfrensp_key_seqno%TYPE DEFAULT NULL)
  RETURN studypath_enrollment_ref

Selects all records for the entity.

Parameters

	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24)
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2)

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_pidm      sfrensp.sfrensp_pidm%TYPE,
                     p_term_code sfrensp.sfrensp_term_code%TYPE,
                     p_key_seqno sfrensp.sfrensp_key_seqno%TYPE)
  RETURN studypath_enrollment_ref

Selects one record using the key.

Parameters

	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24) Required Key
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2) Required Key

Returns

A cursor variable that will fetch exactly one record.

f_query_by_rowid

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN studypath_enrollment_ref

Selects one record using the ROWID.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

Function f_query_one_lock(p_pidm      sfrensp.sfrensp_pidm%TYPE,
                          p_term_code sfrensp.sfrensp_term_code%TYPE,
                          p_key_seqno sfrensp.sfrensp_key_seqno%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN studypath_enrollment_ref

Selects one record and locks it.

Parameters

	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24) Required Key
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

f_reg_eligible

Function f_reg_eligible(p_pidm      sfrensp.sfrensp_pidm%TYPE,
                        p_term_code sfrensp.sfrensp_term_code%TYPE,
                        p_key_seqno sfrensp.sfrensp_key_seqno%TYPE,
                        p_reg_date  sfrensp.sfrensp_ests_date%TYPE,
                        p_ests_code sfrensp.sfrensp_ests_code%TYPE DEFAULT NULL)
  RETURN VARCHAR2

Determines if student's study path is eligible for registration

Parameters

	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24) Required Key
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2) Required Key
	p_reg_date	This is the registration date for which eligibility is being checked. DATE Required Key
	p_ests_code	This is the enrollment status code for which eligibility is being checked. VARCHAR2(2)

Returns

Y if eligible to register, otherwise a value indicating the reason for ineligibility.

p_create

Procedure p_create(p_term_code   sfrensp.sfrensp_term_code%TYPE,
                   p_pidm        sfrensp.sfrensp_pidm%TYPE,
                   p_key_seqno   sfrensp.sfrensp_key_seqno%TYPE,
                   p_ests_code   sfrensp.sfrensp_ests_code%TYPE,
                   p_ests_date   sfrensp.sfrensp_ests_date%TYPE,
                   p_add_date    sfrensp.sfrensp_add_date%TYPE,
                   p_user        sfrensp.sfrensp_user%TYPE,
                   p_data_origin sfrensp.sfrensp_data_origin%TYPE,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24) Required Key
	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2) Required Key
	p_ests_code	Students study path enrollment status for the term. VARCHAR2(8) Required
	p_ests_date	The date of the study path enrollment status. DATE Required
	p_add_date	The date the student originally enrolled in the study path for the term. DATE Required
	p_user	The most recent user to update a record. VARCHAR2(120) Required
	p_data_origin	Source system that generated the data. VARCHAR2(120) Required
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_pidm      sfrensp.sfrensp_pidm%TYPE,
                   p_term_code sfrensp.sfrensp_term_code%TYPE,
                   p_key_seqno sfrensp.sfrensp_key_seqno%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24) Required Key
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        sfrensp.sfrensp_pidm%TYPE,
                 p_term_code   sfrensp.sfrensp_term_code%TYPE,
                 p_key_seqno   sfrensp.sfrensp_key_seqno%TYPE,
                 p_rowid_inout IN OUT NOCOPY gb_common.internal_record_id_type)

Locks a record.
If the ROWID is not passed in, the record is located using the key values and the ROWID of the locked row is passed in p_rowid_inout.

Parameters

	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24) Required Key
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_term_code   sfrensp.sfrensp_term_code%TYPE,
                   p_pidm        sfrensp.sfrensp_pidm%TYPE,
                   p_key_seqno   sfrensp.sfrensp_key_seqno%TYPE,
                   p_ests_code   sfrensp.sfrensp_ests_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ests_date   sfrensp.sfrensp_ests_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_add_date    sfrensp.sfrensp_add_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_user        sfrensp.sfrensp_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin sfrensp.sfrensp_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_term_code	This is the term for the student study path enrollment. VARCHAR2(24) Required Key
	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_key_seqno	This is the sequence number of the Study Path. NUMBER(2) Required Key
	p_ests_code	Students study path enrollment status for the term. VARCHAR2(8) Required
	p_ests_date	The date of the study path enrollment status. DATE Required
	p_add_date	The date the student originally enrolled in the study path for the term. DATE Required
	p_user	The most recent user to update a record. VARCHAR2(120) Required
	p_data_origin	Source system that generated the data. VARCHAR2(120) Required
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)