index

Package sb_scp_timestatus_hist

Common Business interface for the SCP_TIMESTATUS_HIST API (sb_scp_timestatus_hist).

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_timestatus_hist_rec   Business Entity record type
scp_timestatus_hist_ref   Entity cursor variable type
scp_timestatus_hist_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) := 'SCP_TIMESTATUS_HIST';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

scp_timestatus_hist_rec 

TYPE scp_timestatus_hist_rec IS RECORD (
  r_pidm                    sfrstsh.sfrstsh_pidm%TYPE,
  r_scps_code               sfrstsh.sfrstsh_scps_code%TYPE,
  r_tmst_code               sfrstsh.sfrstsh_tmst_code%TYPE,
  r_tmst_date               sfrstsh.sfrstsh_tmst_date%TYPE,
  r_tmst_maint_ind          sfrstsh.sfrstsh_tmst_maint_ind%TYPE,
  r_user                    sfrstsh.sfrstsh_user%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

scp_timestatus_hist_ref 

TYPE scp_timestatus_hist_ref IS REF CURSOR RETURN scp_timestatus_hist_rec;

Entity cursor variable type

scp_timestatus_hist_tab 

TYPE scp_timestatus_hist_tab IS TABLE OF scp_timestatus_hist_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_rowid gb_common.internal_record_id_type)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
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_timestatus_hist_rec,
                   rec_two scp_timestatus_hist_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_timestatus_hist_rec Required
rec_two   The second record to compare. Type scp_timestatus_hist_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           sfrstsh.sfrstsh_pidm%TYPE,
                     p_scps_code      sfrstsh.sfrstsh_scps_code%TYPE,
                     p_tmst_code      sfrstsh.sfrstsh_tmst_code%TYPE,
                     p_tmst_date      sfrstsh.sfrstsh_tmst_date%TYPE,
                     p_tmst_maint_ind sfrstsh.sfrstsh_tmst_maint_ind%TYPE,
                     p_user           sfrstsh.sfrstsh_user%TYPE)
  RETURN scp_timestatus_hist_ref

Selects all records for the entity.

Parameters
p_pidm   Internal identification number of student. NUMBER(8) Required
p_scps_code   SCP code for which the student?s enrollment time status was calculated. VARCHAR2(24) Required
p_tmst_code   Time status code associated with student?s SCP enrollment time status. Validated against STVTMST. VARCHAR2(8) Required
p_tmst_date   Date student?s SCP enrollment time status was calculated. DATE Required
p_tmst_maint_ind   Indicates whether student?s SCP enrollment time status calculation was maintained by the system or overridden by a user. VARCHAR2(4) Required
p_user   The ID of the user who created the record. VARCHAR2(120)

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

f_query_one 

Function f_query_one(p_pidm           sfrstsh.sfrstsh_pidm%TYPE,
                     p_scps_code      sfrstsh.sfrstsh_scps_code%TYPE,
                     p_tmst_code      sfrstsh.sfrstsh_tmst_code%TYPE,
                     p_tmst_date      sfrstsh.sfrstsh_tmst_date%TYPE,
                     p_tmst_maint_ind sfrstsh.sfrstsh_tmst_maint_ind%TYPE,
                     p_user           sfrstsh.sfrstsh_user%TYPE)
  RETURN scp_timestatus_hist_ref

Selects one record using the key.

Parameters
p_pidm   Internal identification number of student. NUMBER(8) Required
p_scps_code   SCP code for which the student?s enrollment time status was calculated. VARCHAR2(24) Required
p_tmst_code   Time status code associated with student?s SCP enrollment time status. Validated against STVTMST. VARCHAR2(8) Required
p_tmst_date   Date student?s SCP enrollment time status was calculated. DATE Required
p_tmst_maint_ind   Indicates whether student?s SCP enrollment time status calculation was maintained by the system or overridden by a user. VARCHAR2(4) Required
p_user   The ID of the user who created the record. VARCHAR2(120)

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_timestatus_hist_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           sfrstsh.sfrstsh_pidm%TYPE,
                          p_scps_code      sfrstsh.sfrstsh_scps_code%TYPE,
                          p_tmst_code      sfrstsh.sfrstsh_tmst_code%TYPE,
                          p_tmst_date      sfrstsh.sfrstsh_tmst_date%TYPE,
                          p_tmst_maint_ind sfrstsh.sfrstsh_tmst_maint_ind%TYPE,
                          p_user           sfrstsh.sfrstsh_user%TYPE,
                          p_rowid          gb_common.internal_record_id_type)
  RETURN scp_timestatus_hist_ref

Selects one record and locks it.

Parameters
p_pidm   Internal identification number of student. NUMBER(8) Required
p_scps_code   SCP code for which the student?s enrollment time status was calculated. VARCHAR2(24) Required
p_tmst_code   Time status code associated with student?s SCP enrollment time status. Validated against STVTMST. VARCHAR2(8) Required
p_tmst_date   Date student?s SCP enrollment time status was calculated. DATE Required
p_tmst_maint_ind   Indicates whether student?s SCP enrollment time status calculation was maintained by the system or overridden by a user. VARCHAR2(4) Required
p_user   The ID of the user who created the record. VARCHAR2(120)
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           sfrstsh.sfrstsh_pidm%TYPE,
                   p_scps_code      sfrstsh.sfrstsh_scps_code%TYPE,
                   p_tmst_code      sfrstsh.sfrstsh_tmst_code%TYPE,
                   p_tmst_date      sfrstsh.sfrstsh_tmst_date%TYPE,
                   p_tmst_maint_ind sfrstsh.sfrstsh_tmst_maint_ind%TYPE,
                   p_user           sfrstsh.sfrstsh_user%TYPE DEFAULT NULL,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   Internal identification number of student. NUMBER(8) Required
p_scps_code   SCP code for which the student?s enrollment time status was calculated. VARCHAR2(24) Required
p_tmst_code   Time status code associated with student?s SCP enrollment time status. Validated against STVTMST. VARCHAR2(8) Required
p_tmst_date   Date student?s SCP enrollment time status was calculated. DATE Required
p_tmst_maint_ind   Indicates whether student?s SCP enrollment time status calculation was maintained by the system or overridden by a user. VARCHAR2(4) Required
p_user   The ID of the user who created the record. VARCHAR2(120)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_pidm           sfrstsh.sfrstsh_pidm%TYPE,
                   p_scps_code      sfrstsh.sfrstsh_scps_code%TYPE,
                   p_tmst_code      sfrstsh.sfrstsh_tmst_code%TYPE,
                   p_tmst_date      sfrstsh.sfrstsh_tmst_date%TYPE,
                   p_tmst_maint_ind sfrstsh.sfrstsh_tmst_maint_ind%TYPE,
                   p_user           sfrstsh.sfrstsh_user%TYPE,
                   p_rowid          gb_common.internal_record_id_type)

Deletes a record.

Parameters
p_pidm   Internal identification number of student. NUMBER(8) Required
p_scps_code   SCP code for which the student?s enrollment time status was calculated. VARCHAR2(24) Required
p_tmst_code   Time status code associated with student?s SCP enrollment time status. Validated against STVTMST. VARCHAR2(8) Required
p_tmst_date   Date student?s SCP enrollment time status was calculated. DATE Required
p_tmst_maint_ind   Indicates whether student?s SCP enrollment time status calculation was maintained by the system or overridden by a user. VARCHAR2(4) Required
p_user   The ID of the user who created the record. VARCHAR2(120)
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(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_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_pidm           sfrstsh.sfrstsh_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_scps_code      sfrstsh.sfrstsh_scps_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tmst_code      sfrstsh.sfrstsh_tmst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tmst_date      sfrstsh.sfrstsh_tmst_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_tmst_maint_ind sfrstsh.sfrstsh_tmst_maint_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user           sfrstsh.sfrstsh_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type)

Updates a record.

Parameters
p_pidm   Internal identification number of student. NUMBER(8) Required
p_scps_code   SCP code for which the student?s enrollment time status was calculated. VARCHAR2(24) Required
p_tmst_code   Time status code associated with student?s SCP enrollment time status. Validated against STVTMST. VARCHAR2(8) Required
p_tmst_date   Date student?s SCP enrollment time status was calculated. DATE Required
p_tmst_maint_ind   Indicates whether student?s SCP enrollment time status calculation was maintained by the system or overridden by a user. VARCHAR2(4) Required
p_user   The ID of the user who created the record. VARCHAR2(120)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)