index

Package nb_ea_group_category

This package provides the Common Business interface for an Electronic Approvals Group Category
 
The Electronic Approvals Group Category API establishes a group of approval categories to help control the usage of EPAF approval categories when originating a transaction. For example, you will be able to create a group of approval categories that contain person and biographic/demographic information and grant access to that group to selected users.

Grouped categories also help reduce maintenance time as originators can now be assigned to a group of approval categories, versus each category individually.


Program units
f_api_version   Returns the API version number.
f_exists   Checks to see if an Electronic Approvals Group Category record exists.
f_isequal   Compares two Electronic Approvals Group Category records for equality.
f_query_all   Selects all Electronic Approvals Group Category records for the entity.
f_query_one   Selects one Electronic Approvals Group Category record using key.
f_query_by_rowid   Selects one Electronic Approvals Group Category record using ROWID.
f_query_one_lock   Selects one Electronic Approvals Group Category record and locks it.
p_create   Creates an Electronic Approvals Group Category record.
p_delete   Deletes an Electronic Approvals Group Category record.
p_lock   Locks an Electronic Approvals Group Category record.
p_update   Updates an Electronic Approvals Group Category record.

Types
ea_group_category_rec   Business Entity record type.
ea_group_category_ref   Entity cursor variable type.
ea_group_category_tab   Entity table type.

Constants
M_ENTITY_NAME   Business Entity Name.


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(17) := 'EA_GROUP_CATEGORY';

Business Entity Name.


ea_group_category_rec

TYPE ea_group_category_rec IS RECORD (
  r_agrp_code           ntragrp.ntragrp_agrp_code%TYPE,
  r_acat_code           ntragrp.ntragrp_acat_code%TYPE,
  r_user_id             ntragrp.ntragrp_user_id%TYPE,
  r_data_origin         ntragrp.ntragrp_data_origin%TYPE,
  r_internal_record_id  gb_common.internal_record_id_type);

Business Entity record type.


ea_group_category_ref

TYPE ea_group_category_ref IS REF CURSOR RETURN ea_group_category_rec;

Entity cursor variable type.


ea_group_category_tab

TYPE ea_group_category_tab IS TABLE OF ea_group_category_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_agrp_code IN ntragrp.ntragrp_agrp_code%TYPE,
                  p_acat_code IN ntragrp.ntragrp_acat_code%TYPE,
                  p_rowid     IN gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if an Electronic Approvals Group Category record exists.

Parameters
p_agrp_code   A group code that identifies a group of approval categories when originating an Electronic Approvals transaction. VARCHAR2(8) Required Key.
p_acat_code   Approval category code to be used by an originator to create an Electronic Approvals transaction. VARCHAR2(6) Required Key.
p_rowid   Database ROWID of the Electronic Approvals Group Category record to be selected. VARCHAR2(18).

Returns
Y if found, otherwise N.


f_isequal

Function f_isequal(rec_one IN ea_group_category_rec,
                   rec_two IN ea_group_category_rec) RETURN VARCHAR2

Compares two Electronic Approvals Group Category 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 ea_group_category_rec. Required.
rec_two   The second record to compare. Type ea_group_category_rec. Required.

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


f_query_all

Function f_query_all(p_agrp_code IN ntragrp.ntragrp_agrp_code%TYPE,
                     p_acat_code IN ntragrp.ntragrp_acat_code%TYPE)
  RETURN ea_group_category_ref

Selects all Electronic Approvals Group Category records for the entity.

Parameters
p_agrp_code   A group code that identifies a group of approval categories when originating an Electronic Approvals transaction. VARCHAR2(8) Required Key.
p_acat_code   Approval category code to be used by an originator to create an Electronic Approvals transaction. VARCHAR2(6) Required Key.

Returns
A cursor variable that will fetch the set of Electronic Approvals Group Category records.


f_query_one

Function f_query_one(p_agrp_code IN ntragrp.ntragrp_agrp_code%TYPE,
                     p_acat_code IN ntragrp.ntragrp_acat_code%TYPE)
  RETURN ea_group_category_ref

Selects one Electronic Approvals Group Category record using key.

Parameters
p_agrp_code   A group code that identifies a group of approval categories when originating an Electronic Approvals transaction. VARCHAR2(8) Required Key.
p_acat_code   Approval category code to be used by an originator to create an Electronic Approvals transaction. VARCHAR2(6) Required Key.

Returns
A cursor variable that will fetch exactly one Electronic Approvals Group Category record.


f_query_by_rowid

Function f_query_by_rowid(p_rowid IN gb_common.internal_record_id_type)
  RETURN ea_group_category_ref

Selects one Electronic Approvals Group Category record using ROWID.

Parameters
p_rowid   Database ROWID of the Electronic Approvals Group Category record to be selected. VARCHAR2(18) Required.

Returns
A cursor variable that will fetch exactly one Electronic Approvals Group Category record.


f_query_one_lock

Function f_query_one_lock(p_agrp_code IN ntragrp.ntragrp_agrp_code%TYPE,
                          p_acat_code IN ntragrp.ntragrp_acat_code%TYPE,
                          p_rowid     IN gb_common.internal_record_id_type DEFAULT NULL)
  RETURN ea_group_category_ref

Selects one Electronic Approvals Group Category record and locks it.

Parameters
p_agrp_code   A group code that identifies a group of approval categories when originating an Electronic Approvals transaction. VARCHAR2(8) Required Key.
p_acat_code   Approval category code to be used by an originator to create an Electronic Approvals transaction. VARCHAR2(6) Required Key.
p_rowid   Database ROWID of the Electronic Approvals Group Category record to be selected. VARCHAR2(18).

Returns
A cursor variable for one Electronic Approvals Group Category record, locking the record.


p_create

Procedure p_create(p_agrp_code   IN ntragrp.ntragrp_agrp_code%TYPE,
                   p_acat_code   IN ntragrp.ntragrp_acat_code%TYPE,
                   p_user_id     IN ntragrp.ntragrp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin IN ntragrp.ntragrp_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates an Electronic Approvals Group Category record.

Parameters
p_agrp_code   A group code that identifies a group of approval categories when originating an Electronic Approvals transaction. VARCHAR2(8) Required Key.
p_acat_code   Approval category code to be used by an originator to create an Electronic Approvals transaction. VARCHAR2(6) Required Key.
p_user_id   The Oracle ID of the person who entered the record. VARCHAR2(30).
p_data_origin   Source system that created or updated the row. VARCHAR2(30).
p_rowid_out   Database ROWID of the Electronic Approvals Group Category record to be created. VARCHAR2(18) Required.


p_delete

Procedure p_delete(p_agrp_code IN ntragrp.ntragrp_agrp_code%TYPE,
                   p_acat_code IN ntragrp.ntragrp_acat_code%TYPE,
                   p_rowid     IN gb_common.internal_record_id_type DEFAULT NULL)

Deletes an Electronic Approvals Group Category record.

Parameters
p_agrp_code   A group code that identifies a group of approval categories when originating an Electronic Approvals transaction. VARCHAR2(8) Required Key.
p_acat_code   Approval category code to be used by an originator to create an Electronic Approvals transaction. VARCHAR2(6) Required Key.
p_rowid   Database ROWID of the Electronic Approvals Group Category record to be deleted. VARCHAR2(18).


p_lock

Procedure p_lock(p_agrp_code   IN ntragrp.ntragrp_agrp_code%TYPE,
                 p_acat_code   IN ntragrp.ntragrp_acat_code%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

Locks an Electronic Approvals Group Category 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_agrp_code   A group code that identifies a group of approval categories when originating an Electronic Approvals transaction. VARCHAR2(8) Required Key.
p_acat_code   Approval category code to be used by an originator to create an Electronic Approvals transaction. VARCHAR2(6) Required Key.
p_rowid_inout   Database ROWID of the Electronic Approvals Group Category record to be locked. VARCHAR2(18) Required.


p_update

Procedure p_update(p_agrp_code   IN ntragrp.ntragrp_agrp_code%TYPE,
                   p_acat_code   IN ntragrp.ntragrp_acat_code%TYPE,
                   p_user_id     IN ntragrp.ntragrp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin IN ntragrp.ntragrp_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       IN gb_common.internal_record_id_type DEFAULT NULL)

Updates an Electronic Approvals Group Category record.

Parameters
p_agrp_code   A group code that identifies a group of approval categories when originating an Electronic Approvals transaction. VARCHAR2(8) Required Key.
p_acat_code   Approval category code to be used by an originator to create an Electronic Approvals transaction. VARCHAR2(6) Required Key.
p_user_id   The Oracle ID of the person who entered the record. VARCHAR2(30).
p_data_origin   Source system that created or updated the row. VARCHAR2(30).
p_rowid   Database ROWID of the Electronic Approvals Group Category record to be updated. VARCHAR2(18).