index

Package sb_highschool

This package provides the Common Business interface for the High School API (sb_highschool).
High school records are created by unique internal identifier (PIDM) and source/background institution code.  To create a new high school record, the person must exist in the person identification/name table (SPRIDEN).
The source/background institution code must exist in the source/background institution validation table (STVSBGI) and whose type is equal to 'H'.
Admission request checklist codes may be assigned to the high school record, but duplicates are not allowed. Multiple high schools may be assigned to a person, but admission request checklist codes may only be used in one high school record for a person.

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
highschool_rec   Business Entity record type
highschool_ref   Entity cursor variable type
highschool_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(10) := 'HIGHSCHOOL';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

highschool_rec 

TYPE highschool_rec IS RECORD (
  r_pidm                    sorhsch.sorhsch_pidm%TYPE,
  r_sbgi_code               sorhsch.sorhsch_sbgi_code%TYPE,
  r_graduation_date         sorhsch.sorhsch_graduation_date%TYPE,
  r_gpa                     sorhsch.sorhsch_gpa%TYPE,
  r_class_rank              sorhsch.sorhsch_class_rank%TYPE,
  r_class_size              sorhsch.sorhsch_class_size%TYPE,
  r_percentile              sorhsch.sorhsch_percentile%TYPE,
  r_dplm_code               sorhsch.sorhsch_dplm_code%TYPE,
  r_coll_prep_ind           sorhsch.sorhsch_coll_prep_ind%TYPE,
  r_trans_recv_date         sorhsch.sorhsch_trans_recv_date%TYPE,
  r_admr_code               sorhsch.sorhsch_admr_code%TYPE,
  r_user_id                 sorhsch.sorhsch_user_id%TYPE,
  r_data_origin             sorhsch.sorhsch_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

highschool_ref 

TYPE highschool_ref IS REF CURSOR RETURN highschool_rec;

Entity cursor variable type

highschool_tab 

TYPE highschool_tab IS TABLE OF highschool_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      sorhsch.sorhsch_pidm%TYPE,
                  p_sbgi_code sorhsch.sorhsch_sbgi_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_pidm   Internal identification number of the student. NUMBER(8) Required Key
p_sbgi_code   High school code of the prospect/applicant. 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 highschool_rec, rec_two highschool_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 highschool_rec Required
rec_two   The second record to compare. Type highschool_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      sorhsch.sorhsch_pidm%TYPE,
                     p_sbgi_code sorhsch.sorhsch_sbgi_code%TYPE DEFAULT NULL)
  RETURN highschool_ref

Selects all records for the entity.

Parameters
p_pidm   Internal identification number of the student. NUMBER(8) Required Key
p_sbgi_code   High school code of the prospect/applicant. VARCHAR2(6) Required Key

Returns
A cursor variable that will fetch a set of records.

f_query_one 

Function f_query_one(p_pidm      sorhsch.sorhsch_pidm%TYPE,
                     p_sbgi_code sorhsch.sorhsch_sbgi_code%TYPE)
  RETURN highschool_ref

Selects one record using the key.

Parameters
p_pidm   Internal identification number of the student. NUMBER(8) Required Key
p_sbgi_code   High school code of the prospect/applicant. 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 highschool_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      sorhsch.sorhsch_pidm%TYPE,
                          p_sbgi_code sorhsch.sorhsch_sbgi_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN highschool_ref

Selects one record and locks it.

Parameters
p_pidm   Internal identification number of the student. NUMBER(8) Required Key
p_sbgi_code   High school code of the prospect/applicant. 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_pidm            sorhsch.sorhsch_pidm%TYPE,
                   p_sbgi_code       sorhsch.sorhsch_sbgi_code%TYPE,
                   p_graduation_date sorhsch.sorhsch_graduation_date%TYPE DEFAULT NULL,
                   p_gpa             sorhsch.sorhsch_gpa%TYPE DEFAULT NULL,
                   p_class_rank      sorhsch.sorhsch_class_rank%TYPE DEFAULT NULL,
                   p_class_size      sorhsch.sorhsch_class_size%TYPE DEFAULT NULL,
                   p_percentile      sorhsch.sorhsch_percentile%TYPE DEFAULT NULL,
                   p_dplm_code       sorhsch.sorhsch_dplm_code%TYPE DEFAULT NULL,
                   p_coll_prep_ind   sorhsch.sorhsch_coll_prep_ind%TYPE DEFAULT NULL,
                   p_trans_recv_date sorhsch.sorhsch_trans_recv_date%TYPE DEFAULT NULL,
                   p_admr_code       sorhsch.sorhsch_admr_code%TYPE DEFAULT NULL,
                   p_user_id         sorhsch.sorhsch_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin     sorhsch.sorhsch_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out       OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   Internal identification number of the student. NUMBER(8) Required Key
p_sbgi_code   High school code of the prospect/applicant. VARCHAR2(6) Required Key
p_graduation_date   Prospect/applicant graduation date from high school. DATE
p_gpa   Prospect/applicant high school GPA. VARCHAR2(24)
p_class_rank   Prospect/applicant high school class rank. NUMBER(4)
p_class_size   Size of the prospect/applicant high school graduating  class size. NUMBER(4)
p_percentile   Prospect/applicant class percentile as related to     class rank and size. NUMBER(5,2)
p_dplm_code   Prospect/applicant high school diploma type, such as college prep. VARCHAR2(2)
p_coll_prep_ind   Indicator for whether the prospect/applicant high school program was college prep.  Values are "Y" or null. VARCHAR2(1)
p_trans_recv_date   Date the prospect/applicant high school transcript was received. DATE
p_admr_code   Admission checklist request item code which may be cross referenced, such as receipt of high school transcript. VARCHAR2(4)
p_user_id   Oracle ID of the user who inserted or last updated the data. VARCHAR2(30)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_pidm      sorhsch.sorhsch_pidm%TYPE,
                   p_sbgi_code sorhsch.sorhsch_sbgi_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   Internal identification number of the student. NUMBER(8) Required Key
p_sbgi_code   High school code of the prospect/applicant. VARCHAR2(6) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_pidm        sorhsch.sorhsch_pidm%TYPE,
                 p_sbgi_code   sorhsch.sorhsch_sbgi_code%TYPE,
                 p_rowid_inout IN OUT 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   Internal identification number of the student. NUMBER(8) Required Key
p_sbgi_code   High school code of the prospect/applicant. VARCHAR2(6) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_pidm            sorhsch.sorhsch_pidm%TYPE,
                   p_sbgi_code       sorhsch.sorhsch_sbgi_code%TYPE,
                   p_graduation_date sorhsch.sorhsch_graduation_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_gpa             sorhsch.sorhsch_gpa%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_class_rank      sorhsch.sorhsch_class_rank%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_class_size      sorhsch.sorhsch_class_size%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_percentile      sorhsch.sorhsch_percentile%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_dplm_code       sorhsch.sorhsch_dplm_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coll_prep_ind   sorhsch.sorhsch_coll_prep_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trans_recv_date sorhsch.sorhsch_trans_recv_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_admr_code       sorhsch.sorhsch_admr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         sorhsch.sorhsch_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin     sorhsch.sorhsch_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_pidm   Internal identification number of the student. NUMBER(8) Required Key
p_sbgi_code   High school code of the prospect/applicant. VARCHAR2(6) Required Key
p_graduation_date   Prospect/applicant graduation date from high school. DATE
p_gpa   Prospect/applicant high school GPA. VARCHAR2(24)
p_class_rank   Prospect/applicant high school class rank. NUMBER(4)
p_class_size   Size of the prospect/applicant high school graduating  class size. NUMBER(4)
p_percentile   Prospect/applicant class percentile as related to  class rank and size. NUMBER(5,2)
p_dplm_code   Prospect/applicant high school diploma type, such as college prep. VARCHAR2(2)
p_coll_prep_ind   Indicator for whether the prospect/applicant high school program was college prep.  Values are "Y" or null. VARCHAR2(1)
p_trans_recv_date   Date the prospect/applicant high school transcript was received. DATE
p_admr_code   Admission checklist request item code which may be cross referenced, such as receipt of high school transcript. VARCHAR2(4)
p_user_id   Oracle ID of the user who inserted or last updated the data. VARCHAR2(30)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)