Package sb_studypath

Package sb_studypath_name

Common Business interface for the Study Path Name API (sb_studypath_name).

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_learner_study_path_name	Parses and returns the values from view SOVSPNM based on the study path rules
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

studypath_name_rec	Business Entity record type
studypath_name_ref	Entity cursor variable type
studypath_name_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(14) := 'STUDYPATH_NAME';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

studypath_name_rec

TYPE studypath_name_rec IS RECORD (
  r_seqno                   sorspnm.sorspnm_seqno%TYPE,
  r_column                  sorspnm.sorspnm_column%TYPE,
  r_separator_cde           sorspnm.sorspnm_separator_cde%TYPE,
  r_user                    sorspnm.sorspnm_user%TYPE,
  r_data_origin             sorspnm.sorspnm_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

studypath_name_ref

TYPE studypath_name_ref IS REF CURSOR RETURN studypath_name_rec;

Entity cursor variable type

studypath_name_tab

TYPE studypath_name_tab IS TABLE OF studypath_name_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_seqno sorspnm.sorspnm_seqno%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_seqno	This is the key to the record and defines the order the column will display in the name. 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_name_rec, rec_two studypath_name_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_name_rec Required
	rec_two	The second record to compare. Type studypath_name_rec Required

Returns

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

f_query_all

Function f_query_all(p_seqno sorspnm.sorspnm_seqno%TYPE DEFAULT NULL)
  RETURN studypath_name_ref

Selects all records for the entity.

Parameters

p_seqno

This is the key to the record and defines the order the column will display in the name. NUMBER(2) Optional Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_seqno sorspnm.sorspnm_seqno%TYPE)
  RETURN studypath_name_ref

Selects one record using the key.

Parameters

p_seqno

This is the key to the record and defines the order the column will display in the name. 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_name_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_seqno sorspnm.sorspnm_seqno%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN studypath_name_ref

Selects one record and locks it.

Parameters

	p_seqno	This is the key to the record and defines the order the column will display in the name. 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_learner_study_path_name

Function f_learner_study_path_name(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                                   p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                                   p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE,
                                   p_lcur_seqno    sorlcur.sorlcur_seqno%TYPE DEFAULT NULL)
  RETURN VARCHAR2

Parses and returns the values from view SOVSPNM based on the study path rules

Parameters

	p_pidm	Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
	p_term_code_eff	This is the term the student record is effective. VARCHAR2(24) Required Key
	p_key_seqno	This is the sequence number of the study path. NUMBER(2) Required Key
	p_lcur_seqno	This is the sequence number of the curriculum within the study path. NUMBER(2)

Returns

the study path name for the learner and study path

p_create

Procedure p_create(p_seqno         sorspnm.sorspnm_seqno%TYPE,
                   p_column        sorspnm.sorspnm_column%TYPE,
                   p_separator_cde sorspnm.sorspnm_separator_cde%TYPE,
                   p_user          sorspnm.sorspnm_user%TYPE,
                   p_data_origin   sorspnm.sorspnm_data_origin%TYPE,
                   p_rowid_out     OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_seqno	This is the key to the record and defines the order the column will display in the name. NUMBER(2) Required Key
	p_column	This is the column name that will be used to fill in the name. VARCHAR2(128) Required
	p_key_seqno	NUMBER(2) Required
	p_desc_ind	A Y or N value to indicate to use the code value or the description from the validation. VARCHAR2(4) Required
	p_separator_cde	The separator value for the components that make up the description of the study path. VARCHAR2(20) 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_seqno sorspnm.sorspnm_seqno%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_seqno	This is the key to the record and defines the order the column will display in the name. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_seqno       sorspnm.sorspnm_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_seqno	This is the key to the record and defines the order the column will display in the name. NUMBER(2) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_seqno         sorspnm.sorspnm_seqno%TYPE,
                   p_column        sorspnm.sorspnm_column%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_separator_cde sorspnm.sorspnm_separator_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user          sorspnm.sorspnm_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin   sorspnm.sorspnm_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_seqno	This is the key to the record and defines the order the column will display in the name. NUMBER(2) Required Key
	p_column	This is the column name that will be used to fill in the name. VARCHAR2(128) Required
	p_key_seqno	NUMBER(2) Required
	p_desc_ind	A Y or N value to indicate to use the code value or the description from the validation. VARCHAR2(4) Required
	p_separator_cde	The separator value for the components that make up the description of the study path. VARCHAR2(20) 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)