index

Package nb_redistr_dflt_queue

This package provides the common business interface for the Labor Redistribution Default Queue API (NB_REDISTR_DFLT_QUEUE).

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.
f_query_by_id   Selects one record using the ID.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
redistr_dflt_queue_rec   Business Entity record type
redistr_dflt_queue_ref   Entity cursor variable type
redistr_dflt_queue_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(18) := 'REDISTR_DFLT_QUEUE';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

redistr_dflt_queue_rec 

TYPE redistr_dflt_queue_rec IS RECORD (
  r_id                      ntrlrdq.ntrlrdq_id%TYPE,
  r_ntrqprt_id              ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
  r_seq_no                  ntrlrdq.ntrlrdq_seq_no%TYPE,
  r_grants_only_ind         ntrlrdq.ntrlrdq_grants_only_ind%TYPE,
  r_approver_action         ntrlrdq.ntrlrdq_approver_action%TYPE,
  r_user_id                 ntrlrdq.ntrlrdq_user_id%TYPE,
  r_elapsed_days            ntrlrdq.ntrlrdq_elapsed_days%TYPE,
  r_data_origin             ntrlrdq.ntrlrdq_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

redistr_dflt_queue_ref 

TYPE redistr_dflt_queue_ref IS REF CURSOR RETURN redistr_dflt_queue_rec;

Entity cursor variable type

redistr_dflt_queue_tab 

TYPE redistr_dflt_queue_tab IS TABLE OF redistr_dflt_queue_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_ntrqprt_id ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
                  p_seq_no     ntrlrdq.ntrlrdq_seq_no%TYPE,
                  p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_ntrqprt_id   Internally system-generated unique identification number which represents the primary key of the parent record. NUMBER(19) Required Key.
p_seq_no   A numeric value to specify an approval level. NUMBER(5,2) 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 redistr_dflt_queue_rec,
                   rec_two redistr_dflt_queue_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 redistr_dflt_queue_rec Required.
rec_two   The second record to compare. Type redistr_dflt_queue_rec Required.

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

f_query_all 

Function f_query_all(p_ntrqprt_id ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
                     p_seq_no     ntrlrdq.ntrlrdq_seq_no%TYPE DEFAULT NULL)
  RETURN redistr_dflt_queue_ref

Selects all records for the entity.

Parameters
p_ntrqprt_id   Internally system-generated unique identification number which represents the primary key of the parent record. NUMBER(19) Required Key.
p_seq_no   A numeric value to specify an approval level. NUMBER(5,2) Required Key.

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

f_query_one 

Function f_query_one(p_ntrqprt_id ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
                     p_seq_no     ntrlrdq.ntrlrdq_seq_no%TYPE)
  RETURN redistr_dflt_queue_ref

Selects one record using the key.

Parameters
p_ntrqprt_id   Internally system-generated unique identification number which represents the primary key of the parent record. NUMBER(19) Required Key.
p_seq_no   A numeric value to specify an approval level. NUMBER(5,2) 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 redistr_dflt_queue_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_ntrqprt_id ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
                          p_seq_no     ntrlrdq.ntrlrdq_seq_no%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN redistr_dflt_queue_ref

Selects one record and locks it.

Parameters
p_ntrqprt_id   Internally system-generated unique identification number which represents the primary key of the parent record. NUMBER(19) Required Key.
p_seq_no   A numeric value to specify an approval level. NUMBER(5,2) Required Key.
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18).

Returns
A cursor variable for one record, locking the record.

f_query_by_id 

Function f_query_by_id(p_id ntrlrdq.ntrlrdq_id%TYPE)
  RETURN redistr_dflt_queue_ref

Selects one record using the ID.

Parameters
p_id   Internally system-generated unique identification number which represents the primary key of the database record. NUMBER(19) Required.

Returns
A cursor variable that will fetch exactly one record.

p_create 

Procedure p_create(p_ntrqprt_id      ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
                   p_seq_no          ntrlrdq.ntrlrdq_seq_no%TYPE,
                   p_grants_only_ind ntrlrdq.ntrlrdq_grants_only_ind%TYPE,
                   p_approver_action ntrlrdq.ntrlrdq_approver_action%TYPE,
                   p_user_id         ntrlrdq.ntrlrdq_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_elapsed_days    ntrlrdq.ntrlrdq_elapsed_days%TYPE DEFAULT NULL,
                   p_data_origin     ntrlrdq.ntrlrdq_data_origin%TYPE DEFAULT NULL,
                   p_id_out          OUT NOCOPY ntrlrdq.ntrlrdq_id%TYPE,
                   p_rowid_out       OUT NOCOPY gb_common.internal_record_id_type)

Creates a record.

Parameters
p_ntrqprt_id   Internally system-generated unique identification number which represents the primary key of the parent record. NUMBER(19) Required Key.
p_seq_no   A numeric value to specify an approval level. NUMBER(5,2) Required Key.
p_grants_only_ind   Indicator that determines if a participant is only added to the queue when funding sources are associated with grants. VARCHAR2(1) Required.
Y   Yes
N   No

p_approver_action   The actions available to a participant in the labor redistribution routing queue. Default action is Approve. VARCHAR2(1) Required.
A   Approve
F   FYI

p_user_id   The Oracle ID of the user who changed the record. VARCHAR2(30) Required.
p_elapsed_days   The number of days counted from the original payroll transaction date. This can only be entered for groups. If a transaction is greater than the number of days this group should be added to the queue with the selected action. NUMBER(3).
p_data_origin   Source system that created or updated the row. VARCHAR2(30).
p_id_out   Internally system-generated unique identification number which represents the primary key of the database record. NUMBER(19) Required.
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required.

p_delete 

Procedure p_delete(p_ntrqprt_id ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
                   p_seq_no     ntrlrdq.ntrlrdq_seq_no%TYPE,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_ntrqprt_id   Internally system-generated unique identification number which represents the primary key of the parent record. NUMBER(19) Required Key.
p_seq_no   A numeric value to specify an approval level. NUMBER(5,2) Required Key.
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock 

Procedure p_lock(p_ntrqprt_id  ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
                 p_seq_no      ntrlrdq.ntrlrdq_seq_no%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_ntrqprt_id   Internally system-generated unique identification number which represents the primary key of the parent record. NUMBER(19) Required Key.
p_seq_no   A numeric value to specify an approval level. NUMBER(5,2) Required Key.
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required.

p_update 

Procedure p_update(p_ntrqprt_id      ntrlrdq.ntrlrdq_ntrqprt_id%TYPE,
                   p_seq_no          ntrlrdq.ntrlrdq_seq_no%TYPE,
                   p_grants_only_ind ntrlrdq.ntrlrdq_grants_only_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_approver_action ntrlrdq.ntrlrdq_approver_action%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         ntrlrdq.ntrlrdq_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_elapsed_days    ntrlrdq.ntrlrdq_elapsed_days%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin     ntrlrdq.ntrlrdq_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_ntrqprt_id   Internally system-generated unique identification number which represents the primary key of the parent record. NUMBER(19) Required Key.
p_seq_no   A numeric value to specify an approval level. NUMBER(5,2) Required Key.
p_grants_only_ind   Indicator that determines if a participant is only added to the queue when funding sources are associated with grants. VARCHAR2(1) Required.
Y   Yes
N   No

p_approver_action   The actions available to a participant in the labor redistribution routing queue. Default action is Approve. VARCHAR2(1) Required.
A   Approve
F   FYI

p_user_id   The Oracle ID of the user who changed the record. VARCHAR2(30) Required.
p_elapsed_days   The number of days counted from the original payroll transaction date. This can only be entered for groups. If a transaction is greater than the number of days this group should be added to the queue with the selected action. NUMBER(3).
p_data_origin   Source system that created or updated the row. VARCHAR2(30).
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18).