index

Package nb_job_enc_history

This package provides the common business interface for the Job Labor Encumbrance History API (NB_JOB_ENC_HISTORY).

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 key.
f_query_by_rowid   Selects one record using ROWID.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.

Types
job_enc_history_rec   Business Entity record type
job_enc_history_ref   Entity cursor variable type
job_enc_history_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(15) := 'JOB_ENC_HISTORY';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

job_enc_history_rec 

TYPE job_enc_history_rec IS RECORD (
  r_pidm                    nbrjleh.nbrjleh_pidm%TYPE,
  r_posn                    nbrjleh.nbrjleh_posn%TYPE,
  r_suff                    nbrjleh.nbrjleh_suff%TYPE,
  r_effective_date          nbrjleh.nbrjleh_effective_date%TYPE,
  r_capture_date            nbrjleh.nbrjleh_capture_date%TYPE,
  r_seq_no                  nbrjleh.nbrjleh_seq_no%TYPE,
  r_enc_begin_date          nbrjleh.nbrjleh_enc_begin_date%TYPE,
  r_user_id                 nbrjleh.nbrjleh_user_id%TYPE,
  r_enc_end_date            nbrjleh.nbrjleh_enc_end_date%TYPE,
  r_salary_encumbrance      nbrjleh.nbrjleh_salary_encumbrance%TYPE,
  r_future_salary_enc       nbrjleh.nbrjleh_future_salary_enc%TYPE,
  r_end_date_reason         nbrjleh.nbrjleh_end_date_reason%TYPE,
  r_data_origin             nbrjleh.nbrjleh_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

job_enc_history_ref 

TYPE job_enc_history_ref IS REF CURSOR RETURN job_enc_history_rec;

Entity cursor variable type

job_enc_history_tab 

TYPE job_enc_history_tab IS TABLE OF job_enc_history_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           nbrjleh.nbrjleh_pidm%TYPE,
                  p_posn           nbrjleh.nbrjleh_posn%TYPE,
                  p_suff           nbrjleh.nbrjleh_suff%TYPE,
                  p_effective_date nbrjleh.nbrjleh_effective_date%TYPE,
                  p_capture_date   nbrjleh.nbrjleh_capture_date%TYPE,
                  p_seq_no         nbrjleh.nbrjleh_seq_no%TYPE,
                  p_enc_begin_date nbrjleh.nbrjleh_enc_begin_date%TYPE,
                  p_rowid          gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_pidm   Internal Identification Number of the employee. NUMBER(8) Required Key
p_posn   Position Number. VARCHAR2(6) Required Key
p_suff   Suffix of the job. VARCHAR2(2) Required Key
p_effective_date   Date that the labor distribution record becomes effective. DATE Required Key
p_capture_date   The date of the Encumbrance transaction calculation. DATE Required Key
p_seq_no   Sequence number of the labor distribution. NUMBER(3) Required Key
p_enc_begin_date   Encumbrance Begin Date used in calculation. DATE 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 job_enc_history_rec,
                   rec_two job_enc_history_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 job_enc_history_rec Required
rec_two   The second record to compare. Type job_enc_history_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           nbrjleh.nbrjleh_pidm%TYPE,
                     p_posn           nbrjleh.nbrjleh_posn%TYPE,
                     p_suff           nbrjleh.nbrjleh_suff%TYPE,
                     p_effective_date nbrjleh.nbrjleh_effective_date%TYPE,
                     p_capture_date   nbrjleh.nbrjleh_capture_date%TYPE,
                     p_seq_no         nbrjleh.nbrjleh_seq_no%TYPE,
                     p_enc_begin_date nbrjleh.nbrjleh_enc_begin_date%TYPE)
  RETURN job_enc_history_ref

Selects all records for the entity.

Parameters
p_pidm   Internal Identification Number of the employee. NUMBER(8) Required Key
p_posn   Position Number. VARCHAR2(6) Required Key
p_suff   Suffix of the job. VARCHAR2(2) Required Key
p_effective_date   Date that the labor distribution record becomes effective. DATE Required Key
p_capture_date   The date of the Encumbrance transaction calculation. DATE Required Key
p_seq_no   Sequence number of the labor distribution. NUMBER(3) Required Key
p_enc_begin_date   Encumbrance Begin Date used in calculation. DATE Required Key

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

f_query_one 

Function f_query_one(p_pidm           nbrjleh.nbrjleh_pidm%TYPE,
                     p_posn           nbrjleh.nbrjleh_posn%TYPE,
                     p_suff           nbrjleh.nbrjleh_suff%TYPE,
                     p_effective_date nbrjleh.nbrjleh_effective_date%TYPE,
                     p_capture_date   nbrjleh.nbrjleh_capture_date%TYPE,
                     p_seq_no         nbrjleh.nbrjleh_seq_no%TYPE,
                     p_enc_begin_date nbrjleh.nbrjleh_enc_begin_date%TYPE)
  RETURN job_enc_history_ref

Selects one record using key.

Parameters
p_pidm   Internal Identification Number of the employee. NUMBER(8) Required Key
p_posn   Position Number. VARCHAR2(6) Required Key
p_suff   Suffix of the job. VARCHAR2(2) Required Key
p_effective_date   Date that the labor distribution record becomes effective. DATE Required Key
p_capture_date   The date of the Encumbrance transaction calculation. DATE Required Key
p_seq_no   Sequence number of the labor distribution. NUMBER(3) Required Key
p_enc_begin_date   Encumbrance Begin Date used in calculation. DATE 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 job_enc_history_ref

Selects one record using 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.

p_create 

Procedure p_create(p_pidm               nbrjleh.nbrjleh_pidm%TYPE,
                   p_posn               nbrjleh.nbrjleh_posn%TYPE,
                   p_suff               nbrjleh.nbrjleh_suff%TYPE,
                   p_effective_date     nbrjleh.nbrjleh_effective_date%TYPE,
                   p_capture_date       nbrjleh.nbrjleh_capture_date%TYPE,
                   p_seq_no             nbrjleh.nbrjleh_seq_no%TYPE,
                   p_enc_begin_date     nbrjleh.nbrjleh_enc_begin_date%TYPE,
                   p_user_id            nbrjleh.nbrjleh_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_enc_end_date       nbrjleh.nbrjleh_enc_end_date%TYPE DEFAULT NULL,
                   p_salary_encumbrance nbrjleh.nbrjleh_salary_encumbrance%TYPE DEFAULT NULL,
                   p_future_salary_enc  nbrjleh.nbrjleh_future_salary_enc%TYPE DEFAULT NULL,
                   p_end_date_reason    nbrjleh.nbrjleh_end_date_reason%TYPE DEFAULT NULL,
                   p_data_origin        nbrjleh.nbrjleh_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out          OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   Internal Identification Number of the employee. NUMBER(8) Required Key
p_posn   Position Number. VARCHAR2(6) Required Key
p_suff   Suffix of the job. VARCHAR2(2) Required Key
p_effective_date   Date that the labor distribution record becomes effective. DATE Required Key
p_capture_date   The date of the Encumbrance transaction calculation. DATE Required Key
p_seq_no   Sequence number of the labor distribution. NUMBER(3) Required Key
p_enc_begin_date   Encumbrance Begin Date used in calculation. DATE Required Key
p_user_id   The Oracle ID of the user who changed the record. VARCHAR2(30) Required
p_enc_end_date   The Encumbrance End Date used in calculation. DATE
p_salary_encumbrance   Amount of salary encumbered to this labor distribution for the active fiscal year. NUMBER(17,2)
p_future_salary_enc   Amount of salary encumbered to this labor distribution for future fiscal years. NUMBER(17,2)
p_end_date_reason   The reason for the end date used in this component of the encumbrance calculation. VARCHAR2(60)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_pidm           nbrjleh.nbrjleh_pidm%TYPE,
                   p_posn           nbrjleh.nbrjleh_posn%TYPE,
                   p_suff           nbrjleh.nbrjleh_suff%TYPE,
                   p_effective_date nbrjleh.nbrjleh_effective_date%TYPE,
                   p_capture_date   nbrjleh.nbrjleh_capture_date%TYPE,
                   p_seq_no         nbrjleh.nbrjleh_seq_no%TYPE,
                   p_enc_begin_date nbrjleh.nbrjleh_enc_begin_date%TYPE,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   Internal Identification Number of the employee. NUMBER(8) Required Key
p_posn   Position Number. VARCHAR2(6) Required Key
p_suff   Suffix of the job. VARCHAR2(2) Required Key
p_effective_date   Date that the labor distribution record becomes effective. DATE Required Key
p_capture_date   The date of the Encumbrance transaction calculation. DATE Required Key
p_seq_no   Sequence number of the labor distribution. NUMBER(3) Required Key
p_enc_begin_date   Encumbrance Begin Date used in calculation. DATE Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_pidm           nbrjleh.nbrjleh_pidm%TYPE,
                 p_posn           nbrjleh.nbrjleh_posn%TYPE,
                 p_suff           nbrjleh.nbrjleh_suff%TYPE,
                 p_effective_date nbrjleh.nbrjleh_effective_date%TYPE,
                 p_capture_date   nbrjleh.nbrjleh_capture_date%TYPE,
                 p_seq_no         nbrjleh.nbrjleh_seq_no%TYPE,
                 p_enc_begin_date nbrjleh.nbrjleh_enc_begin_date%TYPE,
                 p_rowid_inout    IN OUT gb_common.internal_record_id_type)

Locks a record.
If 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   Internal Identification Number of the employee. NUMBER(8) Required Key
p_posn   Position Number. VARCHAR2(6) Required Key
p_suff   Suffix of the job. VARCHAR2(2) Required Key
p_effective_date   Date that the labor distribution record becomes effective. DATE Required Key
p_capture_date   The date of the Encumbrance transaction calculation. DATE Required Key
p_seq_no   Sequence number of the labor distribution. NUMBER(3) Required Key
p_enc_begin_date   Encumbrance Begin Date used in calculation. DATE Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required