Package sb_scp_continuant

Common Business interface for the SCP_CONTINUANT API (sb_scp_continuant).

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

scp_continuant_rec	Business Entity record type
scp_continuant_ref	Entity cursor variable type
scp_continuant_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(14) := 'SCP_CONTINUANT';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

scp_continuant_rec

TYPE scp_continuant_rec IS RECORD (
  r_term_code               sorcscp.sorcscp_term_code%TYPE,
  r_styp_code               sorcscp.sorcscp_styp_code%TYPE,
  r_scps_code_cont          sorcscp.sorcscp_scps_code_cont%TYPE,
  r_user                    sorcscp.sorcscp_user%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

scp_continuant_ref

TYPE scp_continuant_ref IS REF CURSOR RETURN scp_continuant_rec;

Entity cursor variable type

scp_continuant_tab

TYPE scp_continuant_tab IS TABLE OF scp_continuant_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_term_code      sorcscp.sorcscp_term_code%TYPE,
                  p_styp_code      sorcscp.sorcscp_styp_code%TYPE,
                  p_scps_code_cont sorcscp.sorcscp_scps_code_cont%TYPE,
                  p_rowid          gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_term_code	Term for which you are creating the continuing SCPs. VARCHAR2(24) Required Key
	p_styp_code	Student type for which you are creating the continuing SCPs. VARCHAR2(4) Required Key
	p_scps_code_cont	Continuing SCP. VARCHAR2(24) 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 scp_continuant_rec, rec_two scp_continuant_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 scp_continuant_rec Required
	rec_two	The second record to compare. Type scp_continuant_rec Required

Returns

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

f_query_all

Function f_query_all(p_term_code      sorcscp.sorcscp_term_code%TYPE,
                     p_styp_code      sorcscp.sorcscp_styp_code%TYPE,
                     p_scps_code_cont sorcscp.sorcscp_scps_code_cont%TYPE)
  RETURN scp_continuant_ref

Selects all records for the entity.

Parameters

	p_term_code	Term for which you are creating the continuing SCPs. VARCHAR2(24) Required Key
	p_styp_code	Student type for which you are creating the continuing SCPs. VARCHAR2(4) Required Key
	p_scps_code_cont	Continuing SCP. VARCHAR2(24) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_term_code      sorcscp.sorcscp_term_code%TYPE,
                     p_styp_code      sorcscp.sorcscp_styp_code%TYPE,
                     p_scps_code_cont sorcscp.sorcscp_scps_code_cont%TYPE)
  RETURN scp_continuant_ref

Selects one record using the key.

Parameters

	p_term_code	Term for which you are creating the continuing SCPs. VARCHAR2(24) Required Key
	p_styp_code	Student type for which you are creating the continuing SCPs. VARCHAR2(4) Required Key
	p_scps_code_cont	Continuing SCP. VARCHAR2(24) 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 scp_continuant_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_term_code      sorcscp.sorcscp_term_code%TYPE,
                          p_styp_code      sorcscp.sorcscp_styp_code%TYPE,
                          p_scps_code_cont sorcscp.sorcscp_scps_code_cont%TYPE,
                          p_rowid          gb_common.internal_record_id_type DEFAULT NULL)
  RETURN scp_continuant_ref

Selects one record and locks it.

Parameters

	p_term_code	Term for which you are creating the continuing SCPs. VARCHAR2(24) Required Key
	p_styp_code	Student type for which you are creating the continuing SCPs. VARCHAR2(4) Required Key
	p_scps_code_cont	Continuing SCP. VARCHAR2(24) 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_term_code      sorcscp.sorcscp_term_code%TYPE,
                   p_styp_code      sorcscp.sorcscp_styp_code%TYPE,
                   p_scps_code_cont sorcscp.sorcscp_scps_code_cont%TYPE,
                   p_user           sorcscp.sorcscp_user%TYPE,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_term_code	Term for which you are creating the continuing SCPs. VARCHAR2(24) Required Key
	p_styp_code	Student type for which you are creating the continuing SCPs. VARCHAR2(4) Required Key
	p_scps_code_cont	Continuing SCP. VARCHAR2(24) Required Key
	p_user	This field contains the user ID for the user who most recently added or changed the record. VARCHAR2(120) Required
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_term_code      sorcscp.sorcscp_term_code%TYPE,
                   p_styp_code      sorcscp.sorcscp_styp_code%TYPE,
                   p_scps_code_cont sorcscp.sorcscp_scps_code_cont%TYPE,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_term_code	Term for which you are creating the continuing SCPs. VARCHAR2(24) Required Key
	p_styp_code	Student type for which you are creating the continuing SCPs. VARCHAR2(4) Required Key
	p_scps_code_cont	Continuing SCP. VARCHAR2(24) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_term_code      sorcscp.sorcscp_term_code%TYPE,
                 p_styp_code      sorcscp.sorcscp_styp_code%TYPE,
                 p_scps_code_cont sorcscp.sorcscp_scps_code_cont%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_term_code	Term for which you are creating the continuing SCPs. VARCHAR2(24) Required Key
	p_styp_code	Student type for which you are creating the continuing SCPs. VARCHAR2(4) Required Key
	p_scps_code_cont	Continuing SCP. VARCHAR2(24) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_term_code      sorcscp.sorcscp_term_code%TYPE,
                   p_styp_code      sorcscp.sorcscp_styp_code%TYPE,
                   p_scps_code_cont sorcscp.sorcscp_scps_code_cont%TYPE,
                   p_user           sorcscp.sorcscp_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_term_code	Term for which you are creating the continuing SCPs. VARCHAR2(24) Required Key
	p_styp_code	Student type for which you are creating the continuing SCPs. VARCHAR2(4) Required Key
	p_scps_code_cont	Continuing SCP. VARCHAR2(24) Required Key
	p_user	This field contains the user ID for the user who most recently added or changed the record. VARCHAR2(120) Required
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)