Package sb_centricperiod

Common Business interface for the CENTRICPERIOD API (sb_centricperiod).

Student Centric Period is a period of time within a traditional term.

Program units

f_api_version	Returns the API version number.
f_get_description	Returns the description of the code.
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_get_student_scps_code	Determine student's centric period code
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.
f_get_cycle_code_first_term	Determine the cycle code for students initial term code.
p_get_scps_term_styp
p_get_scps_tmst_code

Types

centricperiod_rec	Business Entity record type
centricperiod_ref	Entity cursor variable type
centricperiod_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(13) := 'CENTRICPERIOD';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

centricperiod_rec

TYPE centricperiod_rec IS RECORD (
  r_code                    sobscps.sobscps_code%TYPE,
  r_desc                    sobscps.sobscps_desc%TYPE,
  r_user_id                 sobscps.sobscps_user_id%TYPE,
  r_data_origin             sobscps.sobscps_data_origin%TYPE,
  r_scpc_code               sobscps.sobscps_scpc_code%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

centricperiod_ref

TYPE centricperiod_ref IS REF CURSOR RETURN centricperiod_rec;

Entity cursor variable type

centricperiod_tab

TYPE centricperiod_tab IS TABLE OF centricperiod_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_get_description

Function f_get_description(p_code sobscps.sobscps_code%TYPE)
  RETURN VARCHAR2

Returns the description of the code.

Parameters

p_code

Student Centric Period. VARCHAR2(6) Required Key

Returns

Description of the centric period code.

f_exists

Function f_exists(p_code  sobscps.sobscps_code%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_code	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_rec, rec_two centricperiod_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_rec Required
	rec_two	The second record to compare. Type centricperiod_rec Required

Returns

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

f_query_all

Function f_query_all(p_code sobscps.sobscps_code%TYPE)
  RETURN centricperiod_ref

Selects all records for the entity.

Parameters

p_code

Student Centric Period. VARCHAR2(6) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_code sobscps.sobscps_code%TYPE)
  RETURN centricperiod_ref

Selects one record using the key.

Parameters

p_code

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_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_code  sobscps.sobscps_code%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN centricperiod_ref

Selects one record and locks it.

Parameters

	p_code	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.

f_get_student_scps_code

Function f_get_student_scps_code(p_pidm      sgbstdn.sgbstdn_pidm%TYPE,
                                 p_term_code sgbstdn.sgbstdn_term_code_eff%TYPE)
  RETURN sobscps.sobscps_code%TYPE

Determine student's centric period code

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 the student record is effective. VARCHAR2(6) Required Key

Returns

student's centric period code for the given term.

p_create

Procedure p_create(p_code        sobscps.sobscps_code%TYPE,
                   p_desc        sobscps.sobscps_desc%TYPE,
                   p_user_id     sobscps.sobscps_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin sobscps.sobscps_data_origin%TYPE,
                   p_scpc_code   sobscps.sobscps_scpc_code%TYPE,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_code	Student Centric Period. VARCHAR2(6) Required Key
	p_desc	Student Centric Period Description. VARCHAR2(30) Required
	p_user_id	ID of the most recent user to create or update the row in the SOBSCPS table. VARCHAR2(30) Required
	p_data_origin	Source system that generated the data. VARCHAR2(30) Required
	p_scpc_code	Cycle Code for the student centric period. VARCHAR2(6) Required
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_code  sobscps.sobscps_code%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_code	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_code        sobscps.sobscps_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_code	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_code        sobscps.sobscps_code%TYPE,
                   p_desc        sobscps.sobscps_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     sobscps.sobscps_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin sobscps.sobscps_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_scpc_code   sobscps.sobscps_scpc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_code	Student Centric Period. VARCHAR2(6) Required Key
	p_desc	Student Centric Period Description. VARCHAR2(30) Required
	p_user_id	ID of the most recent user to create or update the row in the SOBSCPS table. VARCHAR2(30) Required
	p_data_origin	Source system that generated the data. VARCHAR2(30) Required
	p_scpc_code	Cycle Code for the student centric period. VARCHAR2(6) Required
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)

f_get_cycle_code_first_term

Function f_get_cycle_code_first_term(p_term_code sorscpt.sorscpt_term_code%TYPE)
  RETURN sobscps.sobscps_scpc_code%TYPE

Determine the cycle code for students initial term code.

Parameters

p_term_code

This is the student's first term. VARCHAR2(6) Required Key

Returns

student's centric period cycle code for the given term.

p_get_scps_term_styp

Procedure p_get_scps_term_styp(scps_code_in_out IN OUT sobscps.sobscps_code%TYPE,
                               scps_term_in_out IN OUT sgbstdn.sgbstdn_term_code_eff%TYPE,
                               scps_styp_in_out IN OUT sgbstdn.sgbstdn_styp_code%TYPE,
                               p_term_in        IN stvterm.stvterm_code%TYPE,
                               pidm_in          IN sfrstcr.sfrstcr_pidm%TYPE)

p_get_scps_tmst_code

Procedure p_get_scps_tmst_code(scps_tmst_code IN OUT sfrstsh.sfrstsh_tmst_code%TYPE,
                               scps_tmst_ind  IN OUT sfrstsh.sfrstsh_tmst_maint_ind%TYPE,
                               scps_code_in   IN sobscps.sobscps_code%TYPE,
                               pidm_in        IN sfrstcr.sfrstcr_pidm%TYPE)