index

Package sb_curric_status_event

Common Business interface for the API (sb_curric_status_event).


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
curric_status_event_rec   Business Entity record type
curric_status_event_ref   Entity cursor variable type
curric_status_event_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(19) := 'CURRIC_STATUS_EVENT';

Business Entity Name


M_BASE_TABLE_NAME

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

Base table name


curric_status_event_rec

TYPE curric_status_event_rec IS RECORD (
  r_csts_code               sorcsts.sorcsts_csts_code%TYPE,
  r_csts_code_trn           sorcsts.sorcsts_csts_code_trn%TYPE,
  r_user_id                 sorcsts.sorcsts_user_id%TYPE,
  r_data_origin             sorcsts.sorcsts_data_origin%TYPE,
  r_sys_req_ind             sorcsts.sorcsts_sys_req_ind%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


curric_status_event_ref

TYPE curric_status_event_ref IS REF CURSOR RETURN curric_status_event_rec;

Entity cursor variable type


curric_status_event_tab

TYPE curric_status_event_tab IS TABLE OF curric_status_event_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_csts_code sorcsts.sorcsts_csts_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_csts_code   Curriculum status code. VARCHAR2(15) 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 curric_status_event_rec,
                   rec_two curric_status_event_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 curric_status_event_rec Required
rec_two   The second record to compare. Type curric_status_event_rec Required

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


f_query_all

Function f_query_all(p_csts_code sorcsts.sorcsts_csts_code%TYPE)
  RETURN curric_status_event_ref

Selects all records for the entity.

Parameters
p_csts_code   Curriculum status code. VARCHAR2(15) Required Key

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


f_query_one

Function f_query_one(p_csts_code sorcsts.sorcsts_csts_code%TYPE)
  RETURN curric_status_event_ref

Selects one record using the key.

Parameters
p_csts_code   Curriculum status code. VARCHAR2(15) 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 curric_status_event_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_csts_code sorcsts.sorcsts_csts_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN curric_status_event_ref

Selects one record and locks it.

Parameters
p_csts_code   Curriculum status code. VARCHAR2(15) 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_csts_code     sorcsts.sorcsts_csts_code%TYPE,
                   p_csts_code_trn sorcsts.sorcsts_csts_code_trn%TYPE,
                   p_user_id       sorcsts.sorcsts_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin   sorcsts.sorcsts_data_origin%TYPE,
                   p_sys_req_ind   sorcsts.sorcsts_sys_req_ind%TYPE,
                   p_rowid_out     OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_csts_code   Curriculum status code. VARCHAR2(15) Required Key
p_csts_code_trn   Translation value to use instead of the curriculum status value. VARCHAR2(15) Required
p_user_id   Oracle user ID of the user who changed the record. VARCHAR2(30) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30) Required
p_sys_req_ind   Y/N indicator for whether the curriculum module is required. VARCHAR2(1) Required
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required


p_delete

Procedure p_delete(p_csts_code sorcsts.sorcsts_csts_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_csts_code   Curriculum status code. VARCHAR2(15) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_lock

Procedure p_lock(p_csts_code   sorcsts.sorcsts_csts_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_csts_code   Curriculum status code. VARCHAR2(15) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required


p_update

Procedure p_update(p_csts_code     sorcsts.sorcsts_csts_code%TYPE,
                   p_csts_code_trn sorcsts.sorcsts_csts_code_trn%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id       sorcsts.sorcsts_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin   sorcsts.sorcsts_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sys_req_ind   sorcsts.sorcsts_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_csts_code   Curriculum status code. VARCHAR2(15) Required Key
p_csts_code_trn   Translation value to use instead of the curriculum status value. VARCHAR2(15) Required
p_user_id   Oracle user ID of the user who changed the record. VARCHAR2(30) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30) Required
p_sys_req_ind   Y/N indicator for whether the curriculum module is required. VARCHAR2(1) Required
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)