index

Package BANINST1.fb_circulation_header

Common Business interface for the CIRCULATION_HEADER API (fb_circulation_header).

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
circulation_header_rec   Business Entity record type
circulation_header_ref   Entity cursor variable type
circulation_header_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_HEADER';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

circulation_header_rec 

TYPE circulation_header_rec IS RECORD (
  r_id                      fobcirh.fobcirh_id%TYPE,
  r_name                    fobcirh.fobcirh_name%TYPE,
  r_type                    fobcirh.fobcirh_type%TYPE,
  r_status                  fobcirh.fobcirh_status%TYPE,
  r_owner_pidm              fobcirh.fobcirh_owner_pidm%TYPE,
  r_active_ind              fobcirh.fobcirh_active_ind%TYPE,
  r_all_organizations_ind   fobcirh.fobcirh_all_organizations_ind%TYPE,
  r_header_change_ind       fobcirh.fobcirh_header_change_ind%TYPE,
  r_routing_change_ind      fobcirh.fobcirh_routing_change_ind%TYPE,
  r_lock_object_ind         fobcirh.fobcirh_lock_object_ind%TYPE,
  r_template_ind            fobcirh.fobcirh_template_ind%TYPE,
  r_trigger_enabled_ind     fobcirh.fobcirh_trigger_enabled_ind%TYPE,
  r_user_id                 fobcirh.fobcirh_user_id%TYPE,
  r_data_origin             fobcirh.fobcirh_data_origin%TYPE,
  r_success_status          fobcirh.fobcirh_success_status%TYPE,
  r_supl_email_text         fobcirh.fobcirh_supl_email_text%TYPE,
  r_completion_date         fobcirh.fobcirh_completion_date%TYPE,
  r_start_date              fobcirh.fobcirh_start_date%TYPE,
  r_desc                    fobcirh.fobcirh_desc%TYPE,
  r_trigger_type            fobcirh.fobcirh_trigger_type%TYPE,
  r_trigger_value           fobcirh.fobcirh_trigger_value%TYPE,
  r_fobcirh_id              fobcirh.fobcirh_fobcirh_id%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

circulation_header_ref 

TYPE circulation_header_ref IS REF CURSOR RETURN circulation_header_rec;

Entity cursor variable type

circulation_header_tab 

TYPE circulation_header_tab IS TABLE OF circulation_header_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    fobcirh.fobcirh_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_header_rec,
                   rec_two circulation_header_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_header_rec Required
rec_two   The second record to compare. Type circulation_header_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 fobcirh.fobcirh_id%TYPE)
  RETURN circulation_header_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 fobcirh.fobcirh_id%TYPE)
  RETURN circulation_header_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_header_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    fobcirh.fobcirh_id%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN circulation_header_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 fobcirh.fobcirh_id%TYPE,
                   p_name                  fobcirh.fobcirh_name%TYPE,
                   p_type                  fobcirh.fobcirh_type%TYPE,
                   p_status                fobcirh.fobcirh_status%TYPE,
                   p_owner_pidm            fobcirh.fobcirh_owner_pidm%TYPE,
                   p_active_ind            fobcirh.fobcirh_active_ind%TYPE,
                   p_all_organizations_ind fobcirh.fobcirh_all_organizations_ind%TYPE,
                   p_header_change_ind     fobcirh.fobcirh_header_change_ind%TYPE,
                   p_routing_change_ind    fobcirh.fobcirh_routing_change_ind%TYPE,
                   p_lock_object_ind       fobcirh.fobcirh_lock_object_ind%TYPE,
                   p_template_ind          fobcirh.fobcirh_template_ind%TYPE,
                   p_trigger_enabled_ind   fobcirh.fobcirh_trigger_enabled_ind%TYPE,
                   p_user_id               fobcirh.fobcirh_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin           fobcirh.fobcirh_data_origin%TYPE DEFAULT NULL,
                   p_success_status        fobcirh.fobcirh_success_status%TYPE DEFAULT NULL,
                   p_supl_email_text       fobcirh.fobcirh_supl_email_text%TYPE DEFAULT NULL,
                   p_completion_date       fobcirh.fobcirh_completion_date%TYPE DEFAULT NULL,
                   p_start_date            fobcirh.fobcirh_start_date%TYPE DEFAULT NULL,
                   p_desc                  fobcirh.fobcirh_desc%TYPE DEFAULT NULL,
                   p_trigger_type          fobcirh.fobcirh_trigger_type%TYPE DEFAULT NULL,
                   p_trigger_value         fobcirh.fobcirh_trigger_value%TYPE DEFAULT NULL,
                   p_fobcirh_id            fobcirh.fobcirh_fobcirh_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_name   User-entered or system-generated name of the circulation. VARCHAR2(240) Required
p_type   Circulation object type. VARCHAR2(200) Required
p_status   Reflects the current status of the Circulation. VARCHAR2(200) Required
p_owner_pidm   the owner of the circulation. NUMBER(8).
p_active_ind   Indicates if the circulation is available for use. VARCHAR2(4) Required
p_all_organizations_ind   Determines either singular or multiple organizations for this circulation. VARCHAR2(1) Required.
p_header_change_ind   Determines if you can create a copy of the template and make modifications to the circulation. VARCHAR2(4) Required
p_routing_change_ind   Determines if you can create a copy of the template and make modifications to the circulation routing. VARCHAR2(4) Required
p_lock_object_ind   Determines if the source circulation object is locked and cannot be changed. VARCHAR2(4) Required
p_template_ind   Indicates the circulation is a template circulation or not. VARCHAR2(4) Required
p_trigger_enabled_ind   Indicates the circulation trigger is enabled 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_success_status   The Approval Status to which the object is moved when the circulation is successful. This means that there are no disapprovals encountered in the Circulation. Not valid if the type is Notification. VARCHAR2(200)
p_supl_email_text   Additional email text to be included on all emails to recipients. VARCHAR2(4000)
p_completion_date   Actual date and time that the circulation was completed. TIMESTAMP(6)
p_start_date   Actual date and time that the circulation was started. TIMESTAMP(6)
p_desc   Circulation description. VARCHAR2(1020)
p_trigger_type   The type of event that starts the Circulation. VARCHAR2(200)
p_trigger_value   The intended string value for a triggerType that would cause the circulation to be run. VARCHAR2(200)
p_fobcirh_id   Unique internal identification number of the source circulation record. NUMBER(19)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_id    fobcirh.fobcirh_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_lock 

Procedure p_lock(p_id          fobcirh.fobcirh_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                    fobcirh.fobcirh_id%TYPE,
                   p_name                  fobcirh.fobcirh_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_type                  fobcirh.fobcirh_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_status                fobcirh.fobcirh_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_owner_pidm            fobcirh.fobcirh_owner_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_active_ind            fobcirh.fobcirh_active_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_all_organizations_ind fobcirh.fobcirh_all_organizations_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_header_change_ind     fobcirh.fobcirh_header_change_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_routing_change_ind    fobcirh.fobcirh_routing_change_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lock_object_ind       fobcirh.fobcirh_lock_object_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_template_ind          fobcirh.fobcirh_template_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trigger_enabled_ind   fobcirh.fobcirh_trigger_enabled_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id               fobcirh.fobcirh_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin           fobcirh.fobcirh_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_success_status        fobcirh.fobcirh_success_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_supl_email_text       fobcirh.fobcirh_supl_email_text%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_completion_date       fobcirh.fobcirh_completion_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_start_date            fobcirh.fobcirh_start_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_desc                  fobcirh.fobcirh_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trigger_type          fobcirh.fobcirh_trigger_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trigger_value         fobcirh.fobcirh_trigger_value%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fobcirh_id            fobcirh.fobcirh_fobcirh_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_name   User-entered or system-generated name of the circulation. VARCHAR2(240) Required
p_type   Circulation object type. VARCHAR2(200) Required
p_status   Reflects the current status of the Circulation. VARCHAR2(200) Required
p_owner_pidm   The owner of the circulation. NUMBER(8)
p_active_ind   Indicates if the circulation is available for use. VARCHAR2(4) Required
p_all_organizations_ind   Determines whether this circulation applies to a singular or multiple organization. VARCHAR2(1) Required.
p_header_change_ind   Determines if you can create a copy of the template and make modifications to the circulation. VARCHAR2(4) Required
p_routing_change_ind   Determines if you can create a copy of the template and make modifications to the circulation routing. VARCHAR2(4) Required
p_lock_object_ind   Determines if the source circulation object is locked and cannot be changed. VARCHAR2(4) Required
p_template_ind   Indicates the circulation is a template circulation or not. VARCHAR2(4) Required
p_trigger_enabled_ind   Indicates the circulation trigger is enabled 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_success_status   The Approval Status to which the object is moved when the circulation is successful. This means that there are no disapprovals encountered in the Circulation. Not valid if the type is Notification. VARCHAR2(200)
p_supl_email_text   Additional email text to be included on all emails to recipients. VARCHAR2(4000)
p_completion_date   Actual date and time that the circulation was completed. TIMESTAMP(6)
p_start_date   Actual date and time that the circulation was started. TIMESTAMP(6)
p_desc   Circulation description. VARCHAR2(1020)
p_trigger_type   The type of event that starts the Circulation. VARCHAR2(200)
p_trigger_value   The intended string value for a triggerType that would cause the circulation to be run. VARCHAR2(200)
p_fobcirh_id   Unique internal identification number of the source circulation record. NUMBER(19)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)