Package nb_effcert_addl

Package nb_effcert_addl_queue

This package provides the common business interface for the Effort Certification Additional Queue Members API (NB_EFFCERT_ADDL_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 surrogate key.
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

effcert_addl_queue_rec	Business Entity record type
effcert_addl_queue_ref	Entity cursor variable type
effcert_addl_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) := 'EFFCERT_ADDL_QUEUE';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

effcert_addl_queue_rec

TYPE effcert_addl_queue_rec IS RECORD (
  r_id                      ntrecaq.ntrecaq_id%TYPE,
  r_coas_code               ntrecaq.ntrecaq_coas_code%TYPE,
  r_orgn_code               ntrecaq.ntrecaq_orgn_code%TYPE,
  r_member_user_id          ntrecaq.ntrecaq_member_user_id%TYPE,
  r_alt_certifier_ind       ntrecaq.ntrecaq_alt_certifier_ind%TYPE,
  r_grad_cert_req_ind       ntrecaq.ntrecaq_grad_cert_req_ind%TYPE,
  r_ftyp_incl_excl_type     ntrecaq.ntrecaq_ftyp_incl_excl_type%TYPE,
  r_user_id                 ntrecaq.ntrecaq_user_id%TYPE,
  r_pre_review_action       ntrecaq.ntrecaq_pre_review_action%TYPE,
  r_post_review_action      ntrecaq.ntrecaq_post_review_action%TYPE,
  r_data_origin             ntrecaq.ntrecaq_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

effcert_addl_queue_ref

TYPE effcert_addl_queue_ref IS REF CURSOR RETURN effcert_addl_queue_rec;

Entity cursor variable type

effcert_addl_queue_tab

TYPE effcert_addl_queue_tab IS TABLE OF effcert_addl_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_coas_code      ntrecaq.ntrecaq_coas_code%TYPE,
                  p_orgn_code      ntrecaq.ntrecaq_orgn_code%TYPE,
                  p_member_user_id ntrecaq.ntrecaq_member_user_id%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_orgn_code	Banner Finance Organization Code. VARCHAR2(6) Required Key.
	p_member_user_id	User ID of a member of the routing queue. VARCHAR2(30) 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 effcert_addl_queue_rec,
                   rec_two effcert_addl_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 effcert_addl_queue_rec Required.
	rec_two	The second record to compare. Type effcert_addl_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_coas_code      ntrecaq.ntrecaq_coas_code%TYPE,
                     p_orgn_code      ntrecaq.ntrecaq_orgn_code%TYPE,
                     p_member_user_id ntrecaq.ntrecaq_member_user_id%TYPE DEFAULT NULL)
  RETURN effcert_addl_queue_ref

Selects all records for the entity.

Parameters

	p_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_orgn_code	Banner Finance Organization Code. VARCHAR2(6) Required Key.
	p_member_user_id	User ID of a member of the routing queue. VARCHAR2(30) Required Key.

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_coas_code      ntrecaq.ntrecaq_coas_code%TYPE,
                     p_orgn_code      ntrecaq.ntrecaq_orgn_code%TYPE,
                     p_member_user_id ntrecaq.ntrecaq_member_user_id%TYPE)
  RETURN effcert_addl_queue_ref

Selects one record using the key.

Parameters

	p_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_orgn_code	Banner Finance Organization Code. VARCHAR2(6) Required Key.
	p_member_user_id	User ID of a member of the routing queue. VARCHAR2(30) 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 effcert_addl_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_coas_code      ntrecaq.ntrecaq_coas_code%TYPE,
                          p_orgn_code      ntrecaq.ntrecaq_orgn_code%TYPE,
                          p_member_user_id ntrecaq.ntrecaq_member_user_id%TYPE,
                          p_rowid          gb_common.internal_record_id_type DEFAULT NULL)
  RETURN effcert_addl_queue_ref

Selects one record and locks it.

Parameters

	p_coas_code	Banner Finance Chart of Accounts. VARCHAR2(1) Required Key.
	p_orgn_code	Banner Finance Organization Code. VARCHAR2(6) Required Key.
	p_member_user_id	User ID of a member of the routing queue. VARCHAR2(30) 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 ntrecaq.ntrecaq_id%TYPE)
  RETURN effcert_addl_queue_ref

Selects one record using the surrogate key.

Parameters

p_id

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

Returns

A cursor variable that will fetch exactly one record.

p_create

Procedure p_create(p_coas_code           ntrecaq.ntrecaq_coas_code%TYPE,
                   p_orgn_code           ntrecaq.ntrecaq_orgn_code%TYPE,
                   p_member_user_id      ntrecaq.ntrecaq_member_user_id%TYPE,
                   p_alt_certifier_ind   ntrecaq.ntrecaq_alt_certifier_ind%TYPE DEFAULT 'N',
                   p_grad_cert_req_ind   ntrecaq.ntrecaq_grad_cert_req_ind%TYPE DEFAULT 'N',
                   p_ftyp_incl_excl_type ntrecaq.ntrecaq_ftyp_incl_excl_type%TYPE DEFAULT 'A',
                   p_user_id             ntrecaq.ntrecaq_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_pre_review_action   ntrecaq.ntrecaq_pre_review_action%TYPE DEFAULT 'N',
                   p_post_review_action  ntrecaq.ntrecaq_post_review_action%TYPE DEFAULT 'N',
                   p_data_origin         ntrecaq.ntrecaq_data_origin%TYPE DEFAULT NULL,
                   p_id_out              OUT NOCOPY ntrecaq.ntrecaq_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_orgn_code

Banner Finance Organization Code. VARCHAR2(6) Required Key.

p_member_user_id

User ID of a member of the routing queue. VARCHAR2(30) Required Key.

p_alt_certifier_ind

Indicator that determines if a participant is also a valid alternate certifier for the employee. VARCHAR2(1) Required.

	Y	Yes alternate certifier
	N	No, not an alternate certifier

p_grad_cert_req_ind

Indicator that determines if a participant's signature is required for all graduate student Effort Reports. VARCHAR2(1) Required.

	Y	Yes
	N	No

p_ftyp_incl_excl_type

Type that determines if a queue member will be added to funding sources associated with the fund types listed. VARCHAR2(1) Required.

	I	Include
	E	Exclude
	A	Include All

p_user_id

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

p_pre_review_action

Specifies the required pre-reviewer actions assigned to a queue member in the effort reporting queue. VARCHAR2(1) Required.

	N	None
	F	FYI
	R	Review

p_post_review_action

Specifies the required post-reviewer actions assigned to a queue member in the effort reporting queue. VARCHAR2(1) Required.

	N	None
	F	FYI
	R	Review

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      ntrecaq.ntrecaq_coas_code%TYPE,
                   p_orgn_code      ntrecaq.ntrecaq_orgn_code%TYPE,
                   p_member_user_id ntrecaq.ntrecaq_member_user_id%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_orgn_code	Banner Finance Organization Code. VARCHAR2(6) Required Key.
	p_member_user_id	User ID of a member of the routing queue. VARCHAR2(30) Required Key.
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

Procedure p_lock(p_coas_code      ntrecaq.ntrecaq_coas_code%TYPE,
                 p_orgn_code      ntrecaq.ntrecaq_orgn_code%TYPE,
                 p_member_user_id ntrecaq.ntrecaq_member_user_id%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_orgn_code	Banner Finance Organization Code. VARCHAR2(6) Required Key.
	p_member_user_id	User ID of a member of the routing queue. VARCHAR2(30) Required Key.
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required.

p_update

Procedure p_update(p_coas_code           ntrecaq.ntrecaq_coas_code%TYPE,
                   p_orgn_code           ntrecaq.ntrecaq_orgn_code%TYPE,
                   p_member_user_id      ntrecaq.ntrecaq_member_user_id%TYPE,
                   p_alt_certifier_ind   ntrecaq.ntrecaq_alt_certifier_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_grad_cert_req_ind   ntrecaq.ntrecaq_grad_cert_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ftyp_incl_excl_type ntrecaq.ntrecaq_ftyp_incl_excl_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id             ntrecaq.ntrecaq_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_pre_review_action   ntrecaq.ntrecaq_pre_review_action%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_post_review_action  ntrecaq.ntrecaq_post_review_action%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin         ntrecaq.ntrecaq_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_orgn_code

Banner Finance Organization Code. VARCHAR2(6) Required Key.

p_member_user_id

User ID of a member of the routing queue. VARCHAR2(30) Required Key.

p_alt_certifier_ind

Indicator that determines if a participant is also a valid alternate certifier for the employee. VARCHAR2(1) Required.

	Y	Yes alternate certifier
	N	No, not an alternate certifier

p_grad_cert_req_ind

Indicator that determines if a participant's signature is required for all graduate student Effort Reports. VARCHAR2(1) Required.

	Y	Yes
	N	No

p_ftyp_incl_excl_type

Type that determines if a queue member will be added to funding sources associated with the fund types listed. VARCHAR2(1) Required.

	I	Include
	E	Exclude
	A	Include All

p_user_id

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

p_pre_review_action

Specifies the required pre-reviewer actions assigned to a queue member in the effort reporting queue. VARCHAR2(1) Required.

	N	None
	F	FYI
	R	Review

p_post_review_action

Specifies the required post-reviewer actions assigned to a queue member in the effort reporting queue. VARCHAR2(1) Required.

	N	None
	F	FYI
	R	Review

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).