Package BANINST1.fb_grant

Package BANINST1.fb_grant_effcert

Common Business interface for the GRANT_EFFCERT API (fb_grant_effcert).

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

grant_effcert_rec	Business Entity record type
grant_effcert_ref	Entity cursor variable type
grant_effcert_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(13) := 'GRANT_EFFCERT';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

grant_effcert_rec

TYPE grant_effcert_rec IS RECORD (
  r_id                      frrgrec.frrgrec_id%TYPE,
  r_coas_code               frrgrec.frrgrec_coas_code%TYPE,
  r_grnt_code               frrgrec.frrgrec_grnt_code%TYPE,
  r_acct_element            frrgrec.frrgrec_acct_element%TYPE,
  r_acct_element_value      frrgrec.frrgrec_acct_element_value%TYPE,
  r_report_section          frrgrec.frrgrec_report_section%TYPE,
  r_charge_type             frrgrec.frrgrec_charge_type%TYPE,
  r_user_id                 frrgrec.frrgrec_user_id%TYPE,
  r_eccg_code               frrgrec.frrgrec_eccg_code%TYPE,
  r_data_origin             frrgrec.frrgrec_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

grant_effcert_ref

TYPE grant_effcert_ref IS REF CURSOR RETURN grant_effcert_rec;

Entity cursor variable type

grant_effcert_tab

TYPE grant_effcert_tab IS TABLE OF grant_effcert_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          frrgrec.frrgrec_coas_code%TYPE,
                  p_acct_element       frrgrec.frrgrec_acct_element%TYPE,
                  p_acct_element_value frrgrec.frrgrec_acct_element_value%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(4) Required Key

p_grnt_code

The user-defined or system assigned Grant identification code. VARCHAR2(36) Required

p_acct_element

Source of the value column. VARCHAR2(4) Required Key

	F	Fund
	O	Organization
	P	Program
	A	Activity
	L	Location

p_acct_element_value

A valid data enterable accounting element value. VARCHAR2(24) 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 grant_effcert_rec, rec_two grant_effcert_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 grant_effcert_rec Required
	rec_two	The second record to compare. Type grant_effcert_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          frrgrec.frrgrec_coas_code%TYPE,
                     p_acct_element       frrgrec.frrgrec_acct_element%TYPE,
                     p_acct_element_value frrgrec.frrgrec_acct_element_value%TYPE)
  RETURN grant_effcert_ref

Selects all records for the entity.

Parameters

p_coas_code

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

p_acct_element

Source of the value column. VARCHAR2(4) Required Key

	F	Fund
	O	Organization
	P	Program
	A	Activity
	L	Location

p_acct_element_value

A valid data enterable accounting element value. VARCHAR2(24) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_coas_code          frrgrec.frrgrec_coas_code%TYPE,
                     p_acct_element       frrgrec.frrgrec_acct_element%TYPE,
                     p_acct_element_value frrgrec.frrgrec_acct_element_value%TYPE)
  RETURN grant_effcert_ref

Selects one record using the key.

Parameters

p_coas_code

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

p_acct_element

Source of the value column. VARCHAR2(4) Required Key

	F	Fund
	O	Organization
	P	Program
	A	Activity
	L	Location

p_acct_element_value

A valid data enterable accounting element value. VARCHAR2(24) 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 grant_effcert_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          frrgrec.frrgrec_coas_code%TYPE,
                          p_acct_element       frrgrec.frrgrec_acct_element%TYPE,
                          p_acct_element_value frrgrec.frrgrec_acct_element_value%TYPE,
                          p_rowid              gb_common.internal_record_id_type DEFAULT NULL)
  RETURN grant_effcert_ref

Selects one record and locks it.

Parameters

p_coas_code

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

p_acct_element

Source of the value column. VARCHAR2(4) Required Key

	F	Fund
	O	Organization
	P	Program
	A	Activity
	L	Location

p_acct_element_value

A valid data enterable accounting element value. VARCHAR2(24) 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 frrgrec.frrgrec_id%TYPE)
  RETURN grant_effcert_ref

Selects one record using the surrogate key.

Parameters

p_id

NUMBER(19) Required Key

Returns

A cursor variable that will fetch exactly one record.

p_create

Procedure p_create(p_coas_code          frrgrec.frrgrec_coas_code%TYPE,
                   p_grnt_code          frrgrec.frrgrec_grnt_code%TYPE,
                   p_acct_element       frrgrec.frrgrec_acct_element%TYPE,
                   p_acct_element_value frrgrec.frrgrec_acct_element_value%TYPE,
                   p_report_section     frrgrec.frrgrec_report_section%TYPE,
                   p_charge_type        frrgrec.frrgrec_charge_type%TYPE,
                   p_user_id            frrgrec.frrgrec_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_eccg_code          frrgrec.frrgrec_eccg_code%TYPE DEFAULT NULL,
                   p_data_origin        frrgrec.frrgrec_data_origin%TYPE DEFAULT NULL,
                   p_id_out             OUT NOCOPY frrgrec.frrgrec_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(4) Required Key

p_grnt_code

The user-defined or system assigned Grant identification code. VARCHAR2(36) Required

p_acct_element

Source of the value column. VARCHAR2(4) Required Key

	F	Fund
	O	Organization
	P	Program
	A	Activity
	L	Location

p_acct_element_value

A valid data enterable accounting element value. VARCHAR2(24) Required Key

p_report_section

Section of the Effort Report where data will be reported. VARCHAR2(4) Required

	S	Sponsored
	N	Non-Sponsored
	A	Allocable

p_charge_type

Type of charge for this value.Required when report section is not allocable. VARCHAR2(4)

	C	Cost Share
	D	Direct

p_user_id

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

p_eccg_code

Identifies the major categories of faculty effort for effort reporting. Only required for Sponsored section of reports. VARCHAR2(32)

p_data_origin

Source system that created or updated the row. VARCHAR2(120)

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          frrgrec.frrgrec_coas_code%TYPE,
                   p_grnt_code          frrgrec.frrgrec_grnt_code%TYPE,
                   p_acct_element       frrgrec.frrgrec_acct_element%TYPE,
                   p_acct_element_value frrgrec.frrgrec_acct_element_value%TYPE,
                   p_rowid              gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

p_coas_code

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

p_grnt_code

The user-defined or system assigned Grant identification code. VARCHAR2(36) Required

p_acct_element

Source of the value column. VARCHAR2(4) Required Key

	F	Fund
	O	Organization
	P	Program
	A	Activity
	L	Location

p_acct_element_value

A valid data enterable accounting element value. VARCHAR2(24) Required Key

p_rowid

Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_coas_code          frrgrec.frrgrec_coas_code%TYPE,
                 p_grnt_code          frrgrec.frrgrec_grnt_code%TYPE,
                 p_acct_element       frrgrec.frrgrec_acct_element%TYPE,
                 p_acct_element_value frrgrec.frrgrec_acct_element_value%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(4) Required Key

p_grnt_code

The user-defined or system assigned Grant identification code. VARCHAR2(36) Required

p_acct_element

Source of the value column. VARCHAR2(4) Required Key

	F	Fund
	O	Organization
	P	Program
	A	Activity
	L	Location

p_acct_element_value

A valid data enterable accounting element value. VARCHAR2(24) Required Key

p_rowid_inout

Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_coas_code          frrgrec.frrgrec_coas_code%TYPE,
                   p_grnt_code          frrgrec.frrgrec_grnt_code%TYPE,
                   p_acct_element       frrgrec.frrgrec_acct_element%TYPE,
                   p_acct_element_value frrgrec.frrgrec_acct_element_value%TYPE,
                   p_report_section     frrgrec.frrgrec_report_section%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_charge_type        frrgrec.frrgrec_charge_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id            frrgrec.frrgrec_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_eccg_code          frrgrec.frrgrec_eccg_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin        frrgrec.frrgrec_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(4) Required Key

p_grnt_code

The user-defined or system assigned Grant identification code. VARCHAR2(36) Required

p_acct_element

Source of the value column. VARCHAR2(4) Required Key

	F	Fund
	O	Organization
	P	Program
	A	Activity
	L	Location

p_acct_element_value

A valid data enterable accounting element value. VARCHAR2(24) Required Key

p_eccg_code

Identifies the major categories of faculty effort for effort reporting. Only required for Sponsored section of reports. VARCHAR2(32)

p_report_section

Section of the Effort Report where data will be reported. VARCHAR2(4) Required

	S	Sponsored
	N	Non-Sponsored
	A	Allocable

p_charge_type

Type of charge for this value.Required when report section is not allocable. VARCHAR2(4)

	C	Cost Share
	D	Direct

p_user_id

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

p_data_origin

Source system that created or updated the row. VARCHAR2(120)

p_rowid

Database ROWID of the record to be updated. VARCHAR2(18)