Package nb_queue_participant

This package provides the common business interface for the Effort Certification Routing Queue Participant Rule API (NB_QUEUE_PARTICIPANT).

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

queue_participant_rec	Business Entity record type
queue_participant_ref	Entity cursor variable type
queue_participant_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(17) := 'QUEUE_PARTICIPANT';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

queue_participant_rec

TYPE queue_participant_rec IS RECORD (
  r_id                      ntrqprt.ntrqprt_id%TYPE,
  r_coas_code               ntrqprt.ntrqprt_coas_code%TYPE,
  r_qprt_code               ntrqprt.ntrqprt_qprt_code%TYPE,
  r_data_source_type        ntrqprt.ntrqprt_data_source_type%TYPE,
  r_catch_all_group_ind     ntrqprt.ntrqprt_catch_all_group_ind%TYPE,
  r_user_id                 ntrqprt.ntrqprt_user_id%TYPE,
  r_personnel_id            ntrqprt.ntrqprt_personnel_id%TYPE,
  r_data_origin             ntrqprt.ntrqprt_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

queue_participant_ref

TYPE queue_participant_ref IS REF CURSOR RETURN queue_participant_rec;

Entity cursor variable type

queue_participant_tab

TYPE queue_participant_tab IS TABLE OF queue_participant_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_coas_code ntrqprt.ntrqprt_coas_code%TYPE,
                  p_qprt_code ntrqprt.ntrqprt_qprt_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_qprt_code	Code for the routing queue participant. VARCHAR2(8) 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 queue_participant_rec,
                   rec_two queue_participant_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 queue_participant_rec Required.
	rec_two	The second record to compare. Type queue_participant_rec Required.

Returns

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

f_query_all

Function f_query_all(p_coas_code ntrqprt.ntrqprt_coas_code%TYPE,
                     p_qprt_code ntrqprt.ntrqprt_qprt_code%TYPE DEFAULT NULL)
  RETURN queue_participant_ref

Selects all records for the entity.

Parameters

	p_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_qprt_code	Code for the routing queue participant. VARCHAR2(8).

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_coas_code ntrqprt.ntrqprt_coas_code%TYPE,
                     p_qprt_code ntrqprt.ntrqprt_qprt_code%TYPE)
  RETURN queue_participant_ref

Selects one record using the key.

Parameters

	p_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_qprt_code	Code for the routing queue participant. VARCHAR2(8) 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 queue_participant_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_coas_code ntrqprt.ntrqprt_coas_code%TYPE,
                          p_qprt_code ntrqprt.ntrqprt_qprt_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN queue_participant_ref

Selects one record and locks it.

Parameters

	p_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_qprt_code	Code for the routing queue participant. VARCHAR2(8) 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 ntrqprt.ntrqprt_id%type)
  RETURN queue_participant_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_coas_code           ntrqprt.ntrqprt_coas_code%TYPE,
                   p_qprt_code           ntrqprt.ntrqprt_qprt_code%TYPE,
                   p_data_source_type    ntrqprt.ntrqprt_data_source_type%TYPE,
                   p_catch_all_group_ind ntrqprt.ntrqprt_catch_all_group_ind%TYPE,
                   p_user_id             ntrqprt.ntrqprt_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_personnel_id        ntrqprt.ntrqprt_personnel_id%TYPE DEFAULT NULL,
                   p_data_origin         ntrqprt.ntrqprt_data_origin%TYPE DEFAULT NULL,
                   p_id_out              OUT NOCOPY ntrqprt.ntrqprt_id%TYPE,
                   p_rowid_out           OUT NOCOPY gb_common.internal_record_id_type)

Creates a record.

Parameters

p_coas_code

Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.

p_qprt_code

Code for the routing queue participant. VARCHAR2(8) Required Key.

p_data_source_type

Data source for the participant information. VARCHAR2(1) Required.

	G	Grant
	F	Fund
	O	Organization
	M	Group

p_catch_all_group_ind

Indicator that controls the routing of a labor distribution document to a group, in the event that no default or additional routing queue has been created. VARCHAR2(1) Required.

	Y	Yes
	N	No

p_user_id

The Oracle ID of the user who changed the record. VARCHAR2(30) Required.

p_personnel_id

User definable identifier of the type of ID stored. The indicator located on the Personnel tab on the Finance Grant Maintenance form. VARCHAR2(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_coas_code ntrqprt.ntrqprt_coas_code%TYPE,
                   p_qprt_code ntrqprt.ntrqprt_qprt_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_qprt_code	Code for the routing queue participant. VARCHAR2(8) Required Key.
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

Procedure p_lock(p_coas_code   ntrqprt.ntrqprt_coas_code%TYPE,
                 p_qprt_code   ntrqprt.ntrqprt_qprt_code%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_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_qprt_code	Code for the routing queue participant. VARCHAR2(8) Required Key.
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required.

p_update

Procedure p_update(p_coas_code           ntrqprt.ntrqprt_coas_code%TYPE,
                   p_qprt_code           ntrqprt.ntrqprt_qprt_code%TYPE,
                   p_data_source_type    ntrqprt.ntrqprt_data_source_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_catch_all_group_ind ntrqprt.ntrqprt_catch_all_group_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id             ntrqprt.ntrqprt_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_personnel_id        ntrqprt.ntrqprt_personnel_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin         ntrqprt.ntrqprt_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid               gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

p_coas_code

Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.

p_qprt_code

Code for the routing queue participant. VARCHAR2(8) Required Key.

p_data_source_type

Data source for the participant information. VARCHAR2(1) Required.

	G	Grant
	F	Fund
	O	Organization
	M	Group

p_catch_all_group_ind

Indicator that controls the routing of a labor distribution document to a group, in the event that no default or additional routing queue has been created. VARCHAR2(1) Required.

	Y	Yes
	N	No

p_user_id

The Oracle ID of the user who changed the record. VARCHAR2(30) Required.

p_personnel_id

User definable identifier of the type of ID stored. The indicator located on the Personnel tab on the Finance Grant Maintenance form. VARCHAR2(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).