index

Package sb_application_decision

Common Business interface for the Application Decision API (sb_application_decision).
 
This is the API for the Student Application Decision Table (SARAPPD).
Internal identification number, term code, application number and sequence number are the keys for each application decision.
 
Separate decision codes can be entered on multiple admission applications for the same applicant within the same term.

Program units
f_api_version   Returns the API version number.
f_exists   Checks to see 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_GetSarappdSeqno   Returns the application decision sequence number for the most current or the next (new) application decision for a person/application.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
application_decision_rec   Business Entity record type
application_decision_ref   Entity cursor variable type
application_decision_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) := 'APPLICATION_DECISION';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

application_decision_rec 

TYPE application_decision_rec IS RECORD (
  r_pidm                    sarappd.sarappd_pidm%TYPE,
  r_term_code_entry         sarappd.sarappd_term_code_entry%TYPE,
  r_appl_no                 sarappd.sarappd_appl_no%TYPE,
  r_seq_no                  sarappd.sarappd_seq_no%TYPE,
  r_apdc_date               sarappd.sarappd_apdc_date%TYPE,
  r_apdc_code               sarappd.sarappd_apdc_code%TYPE,
  r_maint_ind               sarappd.sarappd_maint_ind%TYPE,
  r_user                    sarappd.sarappd_user%TYPE,
  r_data_origin             sarappd.sarappd_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

application_decision_ref 

TYPE application_decision_ref IS REF CURSOR RETURN application_decision_rec;

Entity cursor variable type

application_decision_tab 

TYPE application_decision_tab IS TABLE OF application_decision_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            sarappd.sarappd_pidm%TYPE,
                  p_term_code_entry sarappd.sarappd_term_code_entry%TYPE,
                  p_appl_no         sarappd.sarappd_appl_no%TYPE,
                  p_seq_no          sarappd.sarappd_seq_no%TYPE,
                  p_rowid           gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2;

Checks to see if a record exists.

Parameters
p_pidm   Unique identifier of the applicant. NUMBER(8) Required Key
p_term_code_entry   Effective term of the application record. VARCHAR2(6) Required Key
p_appl_no   Application number within the effective term record. NUMBER(2) Required Key
p_seq_no   Sequence number associated with the application record. 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 application_decision_rec,
                   rec_two application_decision_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 application decision record to compare. Required
rec_two   The second application decision record to compare. Required

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

f_query_all 

FUNCTION f_query_all(p_pidm            sarappd.sarappd_pidm%TYPE,
                     p_term_code_entry sarappd.sarappd_term_code_entry%TYPE DEFAULT NULL,
                     p_appl_no         sarappd.sarappd_appl_no%TYPE DEFAULT NULL,
                     p_seq_no          sarappd.sarappd_seq_no%TYPE DEFAULT NULL)
  RETURN application_decision_ref;

Selects all records for the entity.

Parameters
p_pidm   Unique identifier of the applicant. NUMBER(8) Required Key
p_term_code_entry   Effective term of the application record. VARCHAR2(6)
p_appl_no   Application number within the effective term record. NUMBER(2)
p_seq_no   System assigned internal sequence number associated with the application record. NUMBER(2)

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

f_query_one 

FUNCTION f_query_one(p_pidm            sarappd.sarappd_pidm%TYPE,
                     p_term_code_entry sarappd.sarappd_term_code_entry%TYPE,
                     p_appl_no         sarappd.sarappd_appl_no%TYPE,
                     p_seq_no          sarappd.sarappd_seq_no%TYPE)
  RETURN application_decision_ref;

Selects one record using the key.

Parameters
p_pidm   Unique identifier of the applicant. NUMBER(8) Required Key
p_term_code_entry   Effective term of the application record. VARCHAR2(6) Required Key
p_appl_no   Application number within the effective term record. NUMBER(2) Required Key
p_seq_no   System assigned internal sequence number associated with the application record. 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 application_decision_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            sarappd.sarappd_pidm%TYPE,
                          p_term_code_entry sarappd.sarappd_term_code_entry%TYPE,
                          p_appl_no         sarappd.sarappd_appl_no%TYPE,
                          p_seq_no          sarappd.sarappd_seq_no%TYPE,
                          p_rowid           gb_common.internal_record_id_type DEFAULT NULL)
  RETURN application_decision_ref;

Selects one record and locks it.

Parameters
p_pidm   Unique identifier of the applicant. NUMBER(8) Required Key
p_term_code_entry   Effective term of the application record. VARCHAR2(6) Required Key
p_appl_no   Application number within the effective term record. NUMBER(2) Required Key
p_seq_no   System assigned internal sequence number associated with the application record. 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_GetSarappdSeqno 

FUNCTION f_GetSarappdSeqno(p_pidm         IN sarappd.sarappd_pidm%TYPE,
                           p_appl_no      IN sarappd.sarappd_appl_no%TYPE,
                           p_curr_or_next IN VARCHAR2) RETURN NUMBER;

Returns the application decision sequence number for the most current or the next (new) application decision for a person/application.

Parameters
p_pidm   Unique identifier of the applicant. NUMBER(8) Required Key
p_appl_no   Application number unique for the unique internal identifier (PIDM) regardless of term. NUMBER(2) Required Key
p_curr_or_next   Passes C to retrieve the number for the most recent application or N for the next or new application number. VARCHAR2(1) Required

Returns
An application number.

p_create 

PROCEDURE p_create(p_pidm            sarappd.sarappd_pidm%TYPE,
                   p_term_code_entry sarappd.sarappd_term_code_entry%TYPE,
                   p_appl_no         sarappd.sarappd_appl_no%TYPE,
                   p_seq_no_inout    IN OUT sarappd.sarappd_seq_no%TYPE,
                   p_apdc_date       sarappd.sarappd_apdc_date%TYPE DEFAULT SYSDATE,
                   p_apdc_code       sarappd.sarappd_apdc_code%TYPE,
                   p_maint_ind       sarappd.sarappd_maint_ind%TYPE,
                   p_user            sarappd.sarappd_user%TYPE,
                   p_data_origin     sarappd.sarappd_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out       OUT gb_common.internal_record_id_type);

Creates a record.

Parameters
p_pidm   Unique identifier of the applicant. NUMBER(8) Required Key
p_term_code_entry   Effective term of the application record. VARCHAR2(6) Required Key
p_appl_no   Application number within the effective term record. NUMBER(2) Required Key
p_seq_no   System assigned internal sequence number associated with the application record. NUMBER(2) Required Key
p_apdc_date   Date the application decision was effective. DATE Defaults to Current Date
p_apdc_code   Application decision value associated with the application decision. VARCHAR2(2) Required
p_maint_ind   Identifies whether the application decision was maintained by the system or the user. VARCHAR2(1) Required
p_user   User ID of the most recent user to create or update a record. VARCHAR2(30) Required
p_data_origin   Source system that generated the data. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

PROCEDURE p_delete(p_pidm            sarappd.sarappd_pidm%TYPE,
                   p_term_code_entry sarappd.sarappd_term_code_entry%TYPE,
                   p_appl_no         sarappd.sarappd_appl_no%TYPE,
                   p_seq_no          sarappd.sarappd_seq_no%TYPE,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters
p_pidm   Unique identifier of the applicant. NUMBER(8) Required Key
p_term_code_entry   Effective term of the application record. VARCHAR2(6) Required Key
p_appl_no   Application number within the effective term record. NUMBER(2) Required Key
p_seq_no   System assigned internal sequence number associated with the application record. NUMBER(2) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

PROCEDURE p_lock(p_pidm            sarappd.sarappd_pidm%TYPE,
                 p_term_code_entry sarappd.sarappd_term_code_entry%TYPE,
                 p_appl_no         sarappd.sarappd_appl_no%TYPE,
                 p_seq_no          sarappd.sarappd_seq_no%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   Unique identifier of the applicant. NUMBER(8) Required Key
p_term_code_entry   Effective term of the application record. VARCHAR2(6) Required Key
p_appl_no   Application number within the effective term record. NUMBER(2) Required Key
p_seq_no   System assigned internal sequence number associated with the application record. NUMBER(2) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

PROCEDURE p_update(p_pidm            sarappd.sarappd_pidm%TYPE,
                   p_term_code_entry sarappd.sarappd_term_code_entry%TYPE,
                   p_appl_no         sarappd.sarappd_appl_no%TYPE,
                   p_seq_no          sarappd.sarappd_seq_no%TYPE,
                   p_apdc_date       sarappd.sarappd_apdc_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_apdc_code       sarappd.sarappd_apdc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_maint_ind       sarappd.sarappd_maint_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user            sarappd.sarappd_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin     sarappd.sarappd_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   Unique identifier of the applicant. NUMBER(8) Required Key
p_term_code_entry   Effective term of the application record. VARCHAR2(6) Required Key
p_appl_no   Application number within the effective term record. NUMBER(2) Required Key
p_seq_no   System assigned internal sequence number associated with the application record. NUMBER(2) Required Key
p_apdc_date   Date the application decision was effective. DATE Required
p_apdc_code   Application decision value associated with the application decision. VARCHAR2(2) Required
p_maint_ind   Identifies whether the application decision was maintained by the system or the user. VARCHAR2(1) Required
p_user   User ID of the most recent user to create or update a record. VARCHAR2(30) Required
p_data_origin   Source system that generated the data. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)