Package BANINST1.fb_circulation

Package BANINST1.fb_circulation_notice

Common Business interface for the CIRCULATION_NOTICE API (fb_circulation_notice).

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_forcirr_id	Selects records using the FORCIRR_ID field.
p_create	Creates a record.
p_delete	Deletes a record.
p_delete_by_forcirr_id	Deletes records based upon parent record id FORCIRR_ID.
p_lock	Locks a record.
p_update	Updates a record.

Types

circulation_notice_rec	Business Entity record type
circulation_notice_ref	Entity cursor variable type
circulation_notice_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) := 'CIRCULATION_NOTICE';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

circulation_notice_rec

TYPE circulation_notice_rec IS RECORD (
  r_id                      forcirn.forcirn_id%TYPE,
  r_status                  forcirn.forcirn_status%TYPE,
  r_status_date             forcirn.forcirn_status_date%TYPE,
  r_forcirr_id              forcirn.forcirn_forcirr_id%TYPE,
  r_user_id                 forcirn.forcirn_user_id%TYPE,
  r_resolved_ind            forcirn.forcirn_resolved_ind%TYPE,
  r_data_origin             forcirn.forcirn_data_origin%TYPE,
  r_comment                 forcirn.forcirn_comment%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

circulation_notice_ref

TYPE circulation_notice_ref IS REF CURSOR RETURN circulation_notice_rec;

Entity cursor variable type

circulation_notice_tab

TYPE circulation_notice_tab IS TABLE OF circulation_notice_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_id    forcirn.forcirn_id%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_id	Unique internal identification number of the record. NUMBER(19) 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 circulation_notice_rec,
                   rec_two circulation_notice_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 circulation_notice_rec Required
	rec_two	The second record to compare. Type circulation_notice_rec Required

Returns

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

f_query_all

Function f_query_all(p_id forcirn.forcirn_id%TYPE)
  RETURN circulation_notice_ref

Selects all records for the entity.

Parameters

p_id

Unique internal identification number of the record. NUMBER(19) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_id forcirn.forcirn_id%TYPE)
  RETURN circulation_notice_ref

Selects one record using the key.

Parameters

p_id

Unique internal identification number of the record. NUMBER(19) 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 circulation_notice_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_id    forcirn.forcirn_id%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN circulation_notice_ref

Selects one record and locks it.

Parameters

	p_id	Unique internal identification number of the record. NUMBER(19) 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_forcirr_id

Function f_query_by_forcirr_id(p_forcirr_id forcirn.forcirn_forcirr_id%TYPE)
  RETURN circulation_notice_ref

Selects records using the FORCIRR_ID field.

Parameters

p_forcirr_id

The FORCIRR_ID value. NUMBER(19) Required

Returns

a cursor variable that will fetch the record.

p_create

Procedure p_create(p_id           OUT forcirn.forcirn_id%TYPE,
                   p_status       forcirn.forcirn_status%TYPE,
                   p_status_date  forcirn.forcirn_status_date%TYPE,
                   p_forcirr_id   forcirn.forcirn_forcirr_id%TYPE,
                   p_user_id      forcirn.forcirn_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_resolved_ind forcirn.forcirn_resolved_ind%TYPE,
                   p_data_origin  forcirn.forcirn_data_origin%TYPE DEFAULT NULL,
                   p_comment      forcirn.forcirn_comment%TYPE DEFAULT NULL,
                   p_rowid_out    OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_id	Unique internal identification number of the record. NUMBER(19) Required Key
	p_status	The status of the notification . VARCHAR2(200) Required
	p_status_date	The date of the status of the notification from the system activity . DATE Required
	p_forcirr_id	Unique internal identification number of the routing recipient record. NUMBER(19) Required
	p_resolved_ind	Indicates the resolved status.
	p_user_id	The unique identification code of the user who last touched this record. VARCHAR2(120) Required
	p_data_origin	Source system that created or updated the row. VARCHAR2(120)
	p_comment	Recipient comment. VARCHAR2(4000)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_id    forcirn.forcirn_id%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_id	Unique internal identification number of the record. NUMBER(19) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_delete_by_forcirr_id

Procedure p_delete_by_forcirr_id(p_forcirr_id forcirn.forcirn_forcirr_id%TYPE)

Deletes records based upon parent record id FORCIRR_ID.

Parameters

p_forcirr_id

Internal identification record of the parent record. NUMBER(19) Required Key

p_lock

Procedure p_lock(p_id          forcirn.forcirn_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_id	Unique internal identification number of the record. NUMBER(19) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_id           forcirn.forcirn_id%TYPE,
                   p_status       forcirn.forcirn_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_status_date  forcirn.forcirn_status_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_forcirr_id   forcirn.forcirn_forcirr_id%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id      forcirn.forcirn_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_resolved_ind forcirn.forcirn_resolved_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin  forcirn.forcirn_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_comment      forcirn.forcirn_comment%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid        gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_id	Unique internal identification number of the record. NUMBER(19) Required Key
	p_status	The status of the notification . VARCHAR2(200) Required
	p_status_date	The date of the status of the notification from the system activity . DATE Required
	p_forcirr_id	Unique internal identification number of the routing recipient record. NUMBER(19) Required
	p_user_id	The unique identification code of the user who last touched this record. VARCHAR2(120) Required
	p_resolved_ind	Indicates the resolved status.
	p_data_origin	Source system that created or updated the row. VARCHAR2(120)
	p_comment	Recipient comment. VARCHAR2(4000)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)