index

Package ab_atvauxl

Standard functions and procedures for Auxiliary Code Table.


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.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
atvauxl_rec   Business Entity record type
atvauxl_ref   Entity cursor variable type
atvauxl_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(7) := 'ATVAUXL';

Business Entity name


M_BASE_TABLE_NAME

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

Base table name


atvauxl_rec

TYPE atvauxl_rec IS RECORD (
  r_code                    atvauxl.atvauxl_code%TYPE,
  r_desc                    atvauxl.atvauxl_desc%TYPE,
  r_dcpr_code               atvauxl.atvauxl_dcpr_code%TYPE,
  r_donr_ind                atvauxl.atvauxl_donr_ind%TYPE,
  r_clas_ind                atvauxl.atvauxl_clas_ind%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


atvauxl_ref

TYPE atvauxl_ref IS REF CURSOR RETURN atvauxl_rec;

Entity cursor variable type


atvauxl_tab

TYPE atvauxl_tab IS TABLE OF atvauxl_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_code  atvauxl.atvauxl_code%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_code   Auxiliary Code. VARCHAR2(20) 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 atvauxl_rec, rec_two atvauxl_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 atvauxl_rec Required
rec_two   The second record to compare. Type atvauxl_rec Required

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


f_query_all

Function f_query_all(p_code atvauxl.atvauxl_code%TYPE) RETURN atvauxl_ref

Selects all records for the entity.

Parameters
p_code   Auxiliary Code. VARCHAR2(20) Required Key

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


f_query_one

Function f_query_one(p_code atvauxl.atvauxl_code%TYPE) RETURN atvauxl_ref

Selects one record using the key.

Parameters
p_code   Auxiliary Code. VARCHAR2(20) 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 atvauxl_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_code  atvauxl.atvauxl_code%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN atvauxl_ref

Selects one record and locks it.

Parameters
p_code   Auxiliary Code. VARCHAR2(20) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

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


p_create

Procedure p_create(p_code      atvauxl.atvauxl_code%TYPE,
                   p_desc      atvauxl.atvauxl_desc%TYPE,
                   p_dcpr_code atvauxl.atvauxl_dcpr_code%TYPE DEFAULT NULL,
                   p_donr_ind  atvauxl.atvauxl_donr_ind%TYPE DEFAULT NULL,
                   p_clas_ind  atvauxl.atvauxl_clas_ind%TYPE DEFAULT NULL,
                   p_rowid_out OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_code   Auxiliary Code. VARCHAR2(20) Required Key
p_desc   Auxiliary Code Description. VARCHAR2(120) Required
p_dcpr_code   Premium Code associated with the Auxiliary Code. VARCHAR2(16)
p_donr_ind   Indicator for whether Donor Category is associated with the Auxiliary Code. VARCHAR2(4)
p_clas_ind   Indicator for whether Preferred Class is associated with the Auxiliary Code. VARCHAR2(4)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required


p_delete

Procedure p_delete(p_code  atvauxl.atvauxl_code%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_code   Auxiliary Code. VARCHAR2(20) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_lock

Procedure p_lock(p_code        atvauxl.atvauxl_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_code   Auxiliary Code. VARCHAR2(20) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required


p_update

Procedure p_update(p_code      atvauxl.atvauxl_code%TYPE,
                   p_desc      atvauxl.atvauxl_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dcpr_code atvauxl.atvauxl_dcpr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_donr_ind  atvauxl.atvauxl_donr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_clas_ind  atvauxl.atvauxl_clas_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_code   Auxiliary Code. VARCHAR2(20) Required Key
p_desc   Auxiliary Code Description. VARCHAR2(120) Required
p_dcpr_code   Premium Code associated with the Auxiliary Code. VARCHAR2(16)
p_donr_ind   Indicator for whether Donor Category is associated with the Auxiliary Code. VARCHAR2(4)
p_clas_ind   Indicator for whether Preferred Class is associated with the Auxiliary Code. VARCHAR2(4)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)