|
Package sb_learnercurricstatus
This package provides the Common Business interface for the Learner Curriculum Status API (sb_learnercurricstatus).
SOBCACT: This is the rules table used to indicate which learner curriculum status codes are active and whether they are system-required.
|
M_ENTITY_NAME
M_ENTITY_NAME CONSTANT VARCHAR2(30) := 'LEARNERCURRICSTATUS';
Business Entity name
learnercurricstatus_rec
TYPE learnercurricstatus_rec IS RECORD (
r_cact_code sobcact.sobcact_cact_code%TYPE,
r_active_ind sobcact.sobcact_active_ind%TYPE,
r_sys_req_ind sobcact.sobcact_sys_req_ind%TYPE,
r_user_id sobcact.sobcact_user_id%TYPE,
r_internal_record_id gb_common.internal_record_id_type );
Entity record type
learnercurricstatus_ref
TYPE learnercurricstatus_ref IS REF CURSOR RETURN learnercurricstatus_rec;
Entity cursor variable type
learnercurricstatus_tab
TYPE learnercurricstatus_tab IS TABLE OF learnercurricstatus_rec
INDEX BY BINARY_INTEGER;
Entity table type
f_api_version
Function f_api_version RETURN PLS_INTEGER
Returns the API version number.
|
|
Version of the API signature. Changes only when the signature changes.
|
f_exists
Function f_exists(
p_cact_code sobcact.sobcact_cact_code%TYPE,
p_rowid VARCHAR2 DEFAULT NULL) RETURN VARCHAR2
Checks to see if a record exists.
|
|
p_cact_code
|
Activity status code for the curriculum. VARCHAR2(15) Required key.
|
f_isequal
Function f_isequal(
rec_one learnercurricstatus_rec,
rec_two learnercurricstatus_rec) RETURN VARCHAR2
Compares two records for equality. Nulls match nulls.
|
|
Y if all values in the records are equal, otherwise N. Nulls match Nulls.
|
f_query_all
Function f_query_all(
p_cact_code sobcact.sobcact_cact_code%TYPE) RETURN learnercurricstatus_ref
Selects all records for the entity.
|
|
p_cact_code
|
Activity status code for the curriculum. Wild card (%) may be used with p_cact_code. VARCHAR2(15) Required Key
|
|
|
A cursor variable that will fetch the set of records.
|
f_query_one
Function f_query_one(
p_cact_code sobcact.sobcact_cact_code%TYPE) RETURN learnercurricstatus_ref
Selects one record using the key.
|
|
p_cact_code
|
Activity status code for the curriculum. VARCHAR2(15) Required Key
|
|
|
A cursor variable that will fetch exactly one record.
|
f_query_by_rowid
Function f_query_by_rowid(p_rowid VARCHAR2) RETURN learnercurricstatus_ref
Selects one record using the ROWID.
|
|
p_rowid
|
Database ROWID of the record to selected. VARCHAR2(18) Required
|
|
|
A cursor variable that will fetch exactly one record.
|
f_query_one_lock
Function f_query_one_lock(
p_cact_code sobcact.sobcact_cact_code%TYPE,
p_rowid VARCHAR2 DEFAULT NULL) RETURN learnercurricstatus_ref
Selects one record and locks it.
|
|
p_cact_code
|
Activity status code for the curriculum. VARCHAR2(15) Required Key
|
|
|
p_rowid
|
Database ROWID of the record to be selected. VARCHAR2(18) Required
|
|
|
A cursor variable for one record, locking the record.
|
f_is_active
Function f_is_active(
p_cact_code stvcact.stvcact_code%TYPE) RETURN VARCHAR2
Checks to see if the curriculum is active.
p_create
Procedure p_create(
p_cact_code sobcact.sobcact_cact_code%TYPE ,
p_active_ind sobcact.sobcact_active_ind%TYPE DEFAULT 'N',
p_sys_req_ind sobcact.sobcact_sys_req_ind%TYPE DEFAULT 'N',
p_user_id sobcact.sobcact_user_id%TYPE
DEFAULT gb_common.f_sct_user,
p_rowid_out OUT VARCHAR2)
Creates a record.
|
|
p_cact_code
|
Activity status code for the curriculum. VARCHAR2(15) Required Key
|
|
|
p_active_ind
|
Curriculum Active indicator. VARCHAR2(1) Required
|
|
Y
|
Curriculum is active.
|
|
|
N
|
Curriculum is not active.
|
|
|
|
p_sys_req_ind
|
Curriculum Active Status System Required indicator. VARCHAR2(1) Required
|
|
Y
|
Data is required for the system.
|
|
|
N
|
Data is not required for the system.
|
|
|
|
p_user_id
|
Oracle ID of the most recent user to create or update a record. VARCHAR2(30) Required
|
|
|
p_rowid_out
|
Database ROWID of the record to be created. VARCHAR2(18) Required
|
p_delete
Procedure p_delete(
p_cact_code sobcact.sobcact_cact_code%TYPE,
p_rowid VARCHAR2 DEFAULT NULL)
Deletes a record.
|
|
p_cact_code
|
Activity status code for the curriculum. VARCHAR2(15) Required Key
|
|
|
p_rowid
|
Database ROWID of the record to be deleted. VARCHAR2(18) Required
|
p_lock
Procedure p_lock(
p_cact_code sobcact.sobcact_cact_code%TYPE,
p_rowid_inout IN OUT VARCHAR2)
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.
|
|
p_cact_code
|
Activity status code for the curriculum. VARCHAR2(15) Required Key
|
|
|
p_rowid_inout
|
Database ROWID of the record to be locked. VARCHAR2(18) Required
|
p_update
Procedure p_update(
p_cact_code sobcact.sobcact_cact_code%TYPE ,
p_active_ind sobcact.sobcact_active_ind%TYPE
DEFAULT dml_common.f_unspecified_string,
p_sys_req_ind sobcact.sobcact_sys_req_ind%TYPE
DEFAULT dml_common.f_unspecified_string,
p_user_id sobcact.sobcact_user_id%TYPE
DEFAULT gb_common.f_sct_user,
p_rowid VARCHAR2 DEFAULT NULL)
Updates a record.
|
|
p_cact_code
|
Activity status code for the curriculum. VARCHAR2(15) Required Key
|
|
|
p_active_ind
|
Curriculum Active indicator. VARCHAR2(1) Required
|
|
Y
|
Curriculum is active.
|
|
|
N
|
Curriculum is not active.
|
|
|
|
p_sys_req_ind
|
Curriculum Active Status System Required indicator. VARCHAR2(1) Required
|
|
Y
|
Data is required for the system.
|
|
|
N
|
Data is not required for the system.
|
|
|
|
p_user_id
|
Oracle ID of the most recent user to create or update a record. VARCHAR2(30) Required
|
|
|
p_rowid
|
Database ROWID of the record to be updated. VARCHAR2(18) Required
|