Package sb_centricperiod

Package sb_centricperiod_term

Common Business interface for the CENTRICPERIOD_TERM API (sb_centricperiod_term).

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.
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

centricperiod_term_rec	Business Entity record type
centricperiod_term_ref	Entity cursor variable type
centricperiod_term_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(18) := 'CENTRICPERIOD_TERM';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

centricperiod_term_rec

TYPE centricperiod_term_rec IS RECORD (
  r_scps_code               sorscpt.sorscpt_scps_code%TYPE,
  r_term_code               sorscpt.sorscpt_term_code%TYPE,
  r_user_id                 sorscpt.sorscpt_user_id%TYPE,
  r_data_origin             sorscpt.sorscpt_data_origin%TYPE,
  r_term_control_ind        sorscpt.sorscpt_term_control_ind%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

centricperiod_term_ref

TYPE centricperiod_term_ref IS REF CURSOR RETURN centricperiod_term_rec;

Entity cursor variable type

centricperiod_term_tab

TYPE centricperiod_term_tab IS TABLE OF centricperiod_term_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_scps_code sorscpt.sorscpt_scps_code%TYPE,
                  p_term_code sorscpt.sorscpt_term_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_scps_code	Student Centric Period. VARCHAR2(6) Required Key
	p_term_code	Term code for Student Centric Period. VARCHAR2(6) 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 centricperiod_term_rec,
                   rec_two centricperiod_term_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 centricperiod_term_rec Required
	rec_two	The second record to compare. Type centricperiod_term_rec Required

Returns

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

f_query_all

Function f_query_all(p_scps_code sorscpt.sorscpt_scps_code%TYPE,
                     p_term_code sorscpt.sorscpt_term_code%TYPE DEFAULT NULL)
  RETURN centricperiod_term_ref

Selects all records for the entity.

Parameters

	p_scps_code	Student Centric Period. VARCHAR2(6) Required Key
	p_term_code	Term code for Student Centric Period. VARCHAR2(6)

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_scps_code sorscpt.sorscpt_scps_code%TYPE,
                     p_term_code sorscpt.sorscpt_term_code%TYPE)
  RETURN centricperiod_term_ref

Selects one record using the key.

Parameters

	p_scps_code	Student Centric Period. VARCHAR2(6) Required Key
	p_term_code	Term code for Student Centric Period. VARCHAR2(6) 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 centricperiod_term_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_scps_code sorscpt.sorscpt_scps_code%TYPE,
                          p_term_code sorscpt.sorscpt_term_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN centricperiod_term_ref

Selects one record and locks it.

Parameters

	p_scps_code	Student Centric Period. VARCHAR2(6) Required Key
	p_term_code	Term code for Student Centric Period. VARCHAR2(6) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

p_create

Procedure p_create(p_scps_code        sorscpt.sorscpt_scps_code%TYPE,
                   p_term_code        sorscpt.sorscpt_term_code%TYPE,
                   p_user_id          sorscpt.sorscpt_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin      sorscpt.sorscpt_data_origin%TYPE,
                   p_term_control_ind sorscpt.sorscpt_term_control_ind%TYPE DEFAULT NULL,
                   p_rowid_out        OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_scps_code	Student Centric Period. VARCHAR2(6) Required Key
	p_term_code	Term code for Student Centric Period. VARCHAR2(6) Required Key
	p_user_id	ID of the most recent user to create or update the row in the SORSCPT table. VARCHAR2(30) Required
	p_data_origin	Source system that generated the data. VARCHAR2(30) Required
	p_term_control_ind	Indicates which term is the control term for the student centric period. VARCHAR2(4)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_scps_code sorscpt.sorscpt_scps_code%TYPE,
                   p_term_code sorscpt.sorscpt_term_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_scps_code	Student Centric Period. VARCHAR2(6) Required Key
	p_term_code	Term code for Student Centric Period. VARCHAR2(6) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_scps_code   sorscpt.sorscpt_scps_code%TYPE,
                 p_term_code   sorscpt.sorscpt_term_code%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_scps_code	Student Centric Period. VARCHAR2(6) Required Key
	p_term_code	Term code for Student Centric Period. VARCHAR2(6) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_scps_code        sorscpt.sorscpt_scps_code%TYPE,
                   p_term_code        sorscpt.sorscpt_term_code%TYPE,
                   p_user_id          sorscpt.sorscpt_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin      sorscpt.sorscpt_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_control_ind sorscpt.sorscpt_term_control_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid            gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_scps_code	Student Centric Period. VARCHAR2(6) Required Key
	p_term_code	Term code for Student Centric Period. VARCHAR2(6) Required Key
	p_user_id	ID of the most recent user to create or update the row in the SORSCPT table. VARCHAR2(30) Required
	p_data_origin	Source system that generated the data. VARCHAR2(30) Required
	p_term_control_ind	Indicates which term is the control term for the student centric period. VARCHAR2(4)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)