Package nb

Package nb_proxy

This package provides the common business interface for the Proxy API (NB_PROXY).

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.

Types

proxy_rec	Business Entity record type
proxy_ref	Entity cursor variable type
proxy_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(5) := 'PROXY';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

proxy_rec

TYPE proxy_rec IS RECORD (
  r_id                      ntrprxy.ntrprxy_id%TYPE,
  r_user_id                 ntrprxy.ntrprxy_user_id%TYPE,
  r_proxy_user_id           ntrprxy.ntrprxy_proxy_user_id%TYPE,
  r_admin_id                ntrprxy.ntrprxy_admin_id%TYPE,
  r_data_origin             ntrprxy.ntrprxy_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

proxy_ref

TYPE proxy_ref IS REF CURSOR RETURN proxy_rec;

Entity cursor variable type

proxy_tab

TYPE proxy_tab IS TABLE OF proxy_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_user_id       ntrprxy.ntrprxy_user_id%TYPE,
                  p_proxy_user_id ntrprxy.ntrprxy_proxy_user_id%TYPE,
                  p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_user_id	The Oracle ID of the user who changed the record. VARCHAR2(30) Required Key.
	p_proxy_user_id	User ID of the person who will act as the proxy. VARCHAR2(30) Required Key.
	p_admin_id	Administrator User ID of the person who will change the proxy record. VARCHAR2(30).
	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 proxy_rec, rec_two proxy_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 proxy_rec Required.
	rec_two	The second record to compare. Type proxy_rec Required.

Returns

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

f_query_all

Function f_query_all(p_user_id       ntrprxy.ntrprxy_user_id%TYPE,
                     p_proxy_user_id ntrprxy.ntrprxy_proxy_user_id%TYPE DEFAULT NULL)
  RETURN proxy_ref

Selects all records for the entity.

Parameters

	p_user_id	The Oracle ID of the user who changed the record. VARCHAR2(30) Required Key.
	p_proxy_user_id	User ID of the person who will act as the proxy. VARCHAR2(30) Required Key.

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_user_id       ntrprxy.ntrprxy_user_id%TYPE,
                     p_proxy_user_id ntrprxy.ntrprxy_proxy_user_id%TYPE)
  RETURN proxy_ref

Selects one record using the key.

Parameters

	p_user_id	The Oracle ID of the user who changed the record. VARCHAR2(30) Required Key.
	p_proxy_user_id	User ID of the person who will act as the proxy. 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 proxy_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_user_id       ntrprxy.ntrprxy_user_id%TYPE,
                          p_proxy_user_id ntrprxy.ntrprxy_proxy_user_id%TYPE,
                          p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN proxy_ref

Selects one record and locks it.

Parameters

	p_user_id	The Oracle ID of the user who changed the record. VARCHAR2(30) Required Key.
	p_proxy_user_id	User ID of the person who will act as the proxy. 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 ntrprxy.ntrprxy_id%type) RETURN proxy_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_user_id       ntrprxy.ntrprxy_user_id%TYPE,
                   p_proxy_user_id ntrprxy.ntrprxy_proxy_user_id%TYPE,
                   p_admin_id      ntrprxy.ntrprxy_admin_id%TYPE DEFAULT NULL,
                   p_data_origin   ntrprxy.ntrprxy_data_origin%TYPE DEFAULT NULL,
                   p_id_out        OUT NOCOPY ntrprxy.ntrprxy_id%TYPE,
                   p_rowid_out     OUT NOCOPY gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_user_id	The Oracle ID of the user who changed the record. VARCHAR2(30) Required Key.
	p_proxy_user_id	User ID of the person who will act as the proxy. VARCHAR2(30) Required Key.
	p_admin_id	Administrator User ID of the person who will change the proxy records. VARCHAR2(30).
	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_user_id       ntrprxy.ntrprxy_user_id%TYPE,
                   p_proxy_user_id ntrprxy.ntrprxy_proxy_user_id%TYPE,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_user_id	The Oracle ID of the user who changed the record. VARCHAR2(30) Required Key.
	p_proxy_user_id	User ID of the person who will act as the proxy. VARCHAR2(30) Required Key.
	p_admin_id	Administrator User ID of the person who will change the proxy records. VARCHAR2(30).
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

Procedure p_lock(p_user_id       ntrprxy.ntrprxy_user_id%TYPE,
                 p_proxy_user_id ntrprxy.ntrprxy_proxy_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_user_id	The Oracle ID of the user who changed the record. VARCHAR2(30) Required Key.
	p_proxy_user_id	User ID of the person who will act as the proxy. VARCHAR2(30) Required Key.
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required.