index

Package BANINST1.fb_circulation_recip

Common Business interface for the CIRCULATION_RECIP API (fb_circulation_recip).

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_by_forcirs_id   Selects one record using the FORCIRS_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_forcirs_id   Deletes records based upon parent record id FORCIRS_ID.
p_lock   Locks a record.
p_update   Updates a record.

Types
circulation_recip_rec   Business Entity record type
circulation_recip_ref   Entity cursor variable type
circulation_recip_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(17) := 'CIRCULATION_RECIP';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

circulation_recip_rec 

TYPE circulation_recip_rec IS RECORD (
  r_id                      forcirr.forcirr_id%TYPE,
  r_action                  forcirr.forcirr_action%TYPE,
  r_recipient_pidm          forcirr.forcirr_recipient_pidm%TYPE,
  r_forcirs_id              forcirr.forcirr_forcirs_id%TYPE,
  r_user_id                 forcirr.forcirr_user_id%TYPE,
  r_data_origin             forcirr.forcirr_data_origin%TYPE,
  r_workflow_id             forcirr.forcirr_workflow_id%TYPE,
  r_coas_code               forcirr.forcirr_coas_code%TYPE,
  r_orgn_code               forcirr.forcirr_orgn_code%TYPE,
  r_role                    forcirr.forcirr_role%TYPE,
  r_role_origin             forcirr.forcirr_role_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

circulation_recip_ref 

TYPE circulation_recip_ref IS REF CURSOR RETURN circulation_recip_rec;

Entity cursor variable type

circulation_recip_tab 

TYPE circulation_recip_tab IS TABLE OF circulation_recip_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    forcirr.forcirr_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_recip_rec,
                   rec_two circulation_recip_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_recip_rec Required
rec_two   The second record to compare. Type circulation_recip_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 forcirr.forcirr_id%TYPE)
  RETURN circulation_recip_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 forcirr.forcirr_id%TYPE)
  RETURN circulation_recip_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_recip_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_forcirs_id 

Function f_query_by_forcirs_id(p_forcirs_id forcirr.forcirr_forcirs_id%TYPE)
  RETURN circulation_recip_ref

Selects one record using the FORCIRS_ID field.

Parameters
p_forcirs_id   The FORCIRS_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    forcirr.forcirr_id%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN circulation_recip_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 forcirr.forcirr_id%TYPE,
                   p_action         forcirr.forcirr_action%TYPE,
                   p_recipient_pidm forcirr.forcirr_recipient_pidm%TYPE,
                   p_forcirs_id     forcirr.forcirr_forcirs_id%TYPE,
                   p_user_id        forcirr.forcirr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin    forcirr.forcirr_data_origin%TYPE DEFAULT NULL,
                   p_workflow_id    forcirr.forcirr_workflow_id%TYPE DEFAULT NULL,
                   p_coas_code      forcirr.forcirr_coas_code%TYPE DEFAULT NULL,
                   p_orgn_code      forcirr.forcirr_orgn_code%TYPE DEFAULT NULL,
                   p_role           forcirr.forcirr_role%TYPE DEFAULT NULL,
                   p_role_origin    forcirr.forcirr_role_origin%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_action   Indicates the type of action that the recipient needs to take. VARCHAR2(4) Required
p_recipient_pidm   Unique system assigned identification number for the user in this routing step. NUMBER(9) Required
p_forcirs_id   Unique internal identification number of the circulation record. NUMBER(19) 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_workflow_id   Unique identifier of the approval workflow associated with the routing recipient.
p_coas_code   The primary identification code for any chart of accounts that uniquely indentifies that chart from any other in a multi-chart environment. VARCHAR2(4)
p_orgn_code   Identifies the specific department to which the rule applies. VARCHAR2(24)
p_role   Role that the recipient is providing in this step of the circulation. VARCHAR2(200)
p_role_origin   Used for Circulation templates only. VARCHAR2(200)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_id    forcirr.forcirr_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_forcirs_id 

Procedure p_delete_by_forcirs_id(p_forcirs_id forcirr.forcirr_forcirs_id%TYPE)

Deletes records based upon parent record id FORCIRS_ID.

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

p_lock 

Procedure p_lock(p_id          forcirr.forcirr_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             forcirr.forcirr_id%TYPE,
                   p_action         forcirr.forcirr_action%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_recipient_pidm forcirr.forcirr_recipient_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_forcirs_id     forcirr.forcirr_forcirs_id%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id        forcirr.forcirr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin    forcirr.forcirr_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_workflow_id    forcirr.forcirr_workflow_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coas_code      forcirr.forcirr_coas_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orgn_code      forcirr.forcirr_orgn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_role           forcirr.forcirr_role%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_role_origin    forcirr.forcirr_role_origin%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_action   Indicates the type of action that the recipient needs to take. VARCHAR2(4) Required
p_recipient_pidm   Unique system assigned identification number for the user in this routing step. NUMBER(9) Required
p_forcirs_id   Unique internal identification number of the circulation record. NUMBER(19) 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_workflow_id   Unique identifier of the approval workflow associated with the routing recipient.
p_coas_code   The primary identification code for any chart of accounts that uniquely indentifies that chart from any other in a multi-chart environment. VARCHAR2(4)
p_orgn_code   Identifies the specific department to which the rule applies. VARCHAR2(24)
p_role   Role that the recipient is providing in this step of the circulation. VARCHAR2(200)
p_role_origin   Used for Circulation templates only. VARCHAR2(200)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)