Package BANINST1.fb_circulation

Package BANINST1.fb_circulation_step

Common Business interface for the CIRCULATION_STEP API (fb_circulation_step).

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_next_nodekey	Calculates the next forcirs.order by incremented the current value by 10.
f_current_nodekey	Selects the current forcirs record.
f_query_node_owner	Select a record based upon the header identifcation, nodekey, and recipient pidm.
f_query_by_rowid	Selects one record using the ROWID.
f_query_by_fobcirh_id	Selects one record using the FOBCIRH_ID field.
f_query_one_lock	Selects one record and locks it.
p_create	Creates a record.
p_delete	Deletes a record.
p_delete_by_fobcirh_id	Deletes records based upon parent record id FOBCIRH_ID.
p_lock	Locks a record.
p_update	Updates a record.

Types

circulation_step_rec	Business Entity record type
circulation_step_ref	Entity cursor variable type
circulation_step_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(16) := 'CIRCULATION_STEP';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

circulation_step_rec

TYPE circulation_step_rec IS RECORD (
  r_id                      forcirs.forcirs_id%TYPE,
  r_fobcirh_id              forcirs.forcirs_fobcirh_id%TYPE,
  r_complete_ind            forcirs.forcirs_complete_ind%TYPE,
  r_duplicate_ind           forcirs.forcirs_duplicate_ind%TYPE,
  r_user_id                 forcirs.forcirs_user_id%TYPE,
  r_data_origin             forcirs.forcirs_data_origin%TYPE,
  r_order                   forcirs.forcirs_order%TYPE,
  r_type                    forcirs.forcirs_type%TYPE,
  r_responses_required      forcirs.forcirs_responses_required%TYPE,
  r_forcirs_id              forcirs.forcirs_forcirs_id%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

circulation_step_ref

TYPE circulation_step_ref IS REF CURSOR RETURN circulation_step_rec;

Entity cursor variable type

circulation_step_tab

TYPE circulation_step_tab IS TABLE OF circulation_step_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    forcirs.forcirs_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_step_rec,
                   rec_two circulation_step_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_step_rec Required
	rec_two	The second record to compare. Type circulation_step_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 forcirs.forcirs_id%TYPE)
  RETURN circulation_step_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 forcirs.forcirs_id%TYPE)
  RETURN circulation_step_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_next_nodekey

Function f_next_nodekey(p_fobcirh_id IN FORCIRS.FORCIRS_FOBCIRH_ID%TYPE)
  RETURN FORCIRS.FORCIRS_ORDER%TYPE

Calculates the next forcirs.order by incremented the current value by 10.

Parameters

p_fobcirh_id

The circulation header record internal identification record. NUMBER(19) Required Key

Returns

The calculated next, or incremented, order value.

f_current_nodekey

Function f_current_nodekey(p_fobcirh_id          IN FORCIRS.FORCIRS_FOBCIRH_ID%TYPE,
                           p_originating_user_id IN FORCIRS.FORCIRS_USER_ID%TYPE,
                           p_workflow_user_id    IN FORCIRS.FORCIRS_USER_ID%TYPE)
  RETURN circulation_step_ref

Selects the current forcirs record.

Parameters

p_fobcirh_id

The circulation header record internal identification record. Number(19) Required Key.

Returns

A cursor variable that will fetch exactly one record.

f_query_node_owner

Function f_query_node_owner(p_fobcirh_id     IN FORCIRS.FORCIRS_FOBCIRH_ID%TYPE,
                            p_nodekey_in     IN FORCIRS.FORCIRS_ORDER%TYPE,
                            p_recipient_pidm IN FORCIRR.FORCIRR_RECIPIENT_PIDM%TYPE)
  RETURN circulation_step_ref

Select a record based upon the header identifcation, nodekey, and recipient pidm.

Parameters

	p_fobcirh_id	The circulation header record internal identification record. Number(19) Required Key.
	p_nodekey_in	The forcirs_order indicating the step in the circulation process. Number(8) Required Key.
	p_recipient_pidm	The pidm representing the owner of the step.

f_query_by_rowid

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN circulation_step_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_by_fobcirh_id

Function f_query_by_fobcirh_id(p_fobcirh_id forcirs.forcirs_fobcirh_id%TYPE)
  RETURN circulation_step_ref

Selects one record using the FOBCIRH_ID field.

Parameters

p_fobcirh_id

The FOBCIRH_ID value. NUMBER(19) Required

Returns

a cursor variable that will fetch the record.

f_query_one_lock

Function f_query_one_lock(p_id    forcirs.forcirs_id%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN circulation_step_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.

p_create

Procedure p_create(p_id                 OUT forcirs.forcirs_id%TYPE,
                   p_fobcirh_id         forcirs.forcirs_fobcirh_id%TYPE,
                   p_complete_ind       forcirs.forcirs_complete_ind%TYPE,
                   p_duplicate_ind      forcirs.forcirs_duplicate_ind%TYPE,
                   p_user_id            forcirs.forcirs_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin        forcirs.forcirs_data_origin%TYPE DEFAULT NULL,
                   p_order              forcirs.forcirs_order%TYPE DEFAULT NULL,
                   p_type               forcirs.forcirs_type%TYPE DEFAULT NULL,
                   p_responses_required forcirs.forcirs_responses_required%TYPE DEFAULT NULL,
                   p_forcirs_id         forcirs.forcirs_forcirs_id%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_fobcirh_id	Unique internal identification number of the circulation record. NUMBER(19) Required
	p_complete_ind	Indicates if this routing step is complete or not. VARCHAR2(4) Required
	p_duplicate_ind	Indicates if this routing step is a duplicate or not. VARCHAR2(4) Required
	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_order	The order of this step in the overall Circulation. NUMBER(8)
	p_type	Person or Chain. VARCHAR2(4)
	p_responses_required	Used to establish the number of routing recipient responses required in order to declare this step complete. NUMBER(3)
	p_forcirs_id	Unique internal identification number of the circulation parent record to support hierarchical processing. NUMBER(19)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_id    forcirs.forcirs_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_fobcirh_id

Procedure p_delete_by_fobcirh_id(p_fobcirh_id forcirs.forcirs_fobcirh_id%TYPE)

Deletes records based upon parent record id FOBCIRH_ID.

Parameters

p_fobcirh_id

Internal Identification record of the parenet record. NUMBER(19) Required Key

p_lock

Procedure p_lock(p_id          forcirs.forcirs_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                 forcirs.forcirs_id%TYPE,
                   p_fobcirh_id         forcirs.forcirs_fobcirh_id%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_complete_ind       forcirs.forcirs_complete_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_duplicate_ind      forcirs.forcirs_duplicate_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id            forcirs.forcirs_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin        forcirs.forcirs_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_order              forcirs.forcirs_order%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_type               forcirs.forcirs_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_responses_required forcirs.forcirs_responses_required%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_forcirs_id         forcirs.forcirs_forcirs_id%TYPE DEFAULT dml_common.f_unspecified_number,
                   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_fobcirh_id	Unique internal identification number of the circulation record. NUMBER(19) Required
	p_complete_ind	Indicates if this routing step is complete or not. VARCHAR2(4) Required
	p_duplicate_ind	Indicates if this routing step is a duplicate or not. VARCHAR2(4) Required
	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_order	The order of this step in the overall Circulation. NUMBER(8)
	p_type	Person or Chain. VARCHAR2(4)
	p_responses_required	Used to establish the number of routing recipient responses required in order to declare this step complete. NUMBER(3)
	p_forcirs_id	Unique internal identification number of the circulation parent record to support hierarchical processing. NUMBER(19)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)