index

Package ab_project_results

Common Business interface for the PROJECT_RESULTS API (ab_project_results).

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
project_results_rec   Business Entity record type
project_results_ref   Entity cursor variable type
project_results_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(15) := 'PROJECT_RESULTS';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

project_results_rec 

TYPE project_results_rec IS RECORD (
  r_pidm                    amrprrs.amrprrs_pidm%TYPE,
  r_prop_code               amrprrs.amrprrs_prop_code%TYPE,
  r_prop_seq_no             amrprrs.amrprrs_prop_seq_no%TYPE,
  r_proj_code               amrprrs.amrprrs_proj_code%TYPE,
  r_seq_no                  amrprrs.amrprrs_seq_no%TYPE,
  r_user_id                 amrprrs.amrprrs_user_id%TYPE,
  r_data_origin             amrprrs.amrprrs_data_origin%TYPE,
  r_result_date             amrprrs.amrprrs_result_date%TYPE,
  r_gift_no                 amrprrs.amrprrs_gift_no%TYPE,
  r_pledge_no               amrprrs.amrprrs_pledge_no%TYPE,
  r_campaign                amrprrs.amrprrs_campaign%TYPE,
  r_desg                    amrprrs.amrprrs_desg%TYPE,
  r_value                   amrprrs.amrprrs_value%TYPE,
  r_comment                 amrprrs.amrprrs_comment%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

project_results_ref 

TYPE project_results_ref IS REF CURSOR RETURN project_results_rec;

Entity cursor variable type

project_results_tab 

TYPE project_results_tab IS TABLE OF project_results_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_pidm        amrprrs.amrprrs_pidm%TYPE,
                  p_prop_code   amrprrs.amrprrs_prop_code%TYPE,
                  p_prop_seq_no amrprrs.amrprrs_prop_seq_no%TYPE,
                  p_proj_code   amrprrs.amrprrs_proj_code%TYPE,
                  p_seq_no      amrprrs.amrprrs_seq_no%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_pidm   The internal system generated ID number of a Prospect. NUMBER(8) Required Key
p_prop_code   The Proposal code which is being associated to the Prospect. VARCHAR2(24) Required Key
p_prop_seq_no   The sequence number of the Proposal record. NUMBER(3) Required Key
p_proj_code   The Project code which is being associated to the Proposal. VARCHAR2(24) Required Key
p_seq_no   The sequence number of the result record. NUMBER(3) 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 project_results_rec,
                   rec_two project_results_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 project_results_rec Required
rec_two   The second record to compare. Type project_results_rec Required

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

f_query_all 

Function f_query_all(p_pidm        amrprrs.amrprrs_pidm%TYPE,
                     p_prop_code   amrprrs.amrprrs_prop_code%TYPE,
                     p_prop_seq_no amrprrs.amrprrs_prop_seq_no%TYPE,
                     p_proj_code   amrprrs.amrprrs_proj_code%TYPE,
                     p_seq_no      amrprrs.amrprrs_seq_no%TYPE)
  RETURN project_results_ref

Selects all records for the entity.

Parameters
p_pidm   The internal system generated ID number of a Prospect. NUMBER(8) Required Key
p_prop_code   The Proposal code which is being associated to the Prospect. VARCHAR2(24) Required Key
p_prop_seq_no   The sequence number of the Proposal record. NUMBER(3) Required Key
p_proj_code   The Project code which is being associated to the Proposal. VARCHAR2(24) Required Key
p_seq_no   The sequence number of the result record. NUMBER(3) Required Key

Returns
A cursor variable that will fetch a set of records.

f_query_one 

Function f_query_one(p_pidm        amrprrs.amrprrs_pidm%TYPE,
                     p_prop_code   amrprrs.amrprrs_prop_code%TYPE,
                     p_prop_seq_no amrprrs.amrprrs_prop_seq_no%TYPE,
                     p_proj_code   amrprrs.amrprrs_proj_code%TYPE,
                     p_seq_no      amrprrs.amrprrs_seq_no%TYPE)
  RETURN project_results_ref

Selects one record using the key.

Parameters
p_pidm   The internal system generated ID number of a Prospect. NUMBER(8) Required Key
p_prop_code   The Proposal code which is being associated to the Prospect. VARCHAR2(24) Required Key
p_prop_seq_no   The sequence number of the Proposal record. NUMBER(3) Required Key
p_proj_code   The Project code which is being associated to the Proposal. VARCHAR2(24) Required Key
p_seq_no   The sequence number of the result record. NUMBER(3) 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 project_results_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_pidm        amrprrs.amrprrs_pidm%TYPE,
                          p_prop_code   amrprrs.amrprrs_prop_code%TYPE,
                          p_prop_seq_no amrprrs.amrprrs_prop_seq_no%TYPE,
                          p_proj_code   amrprrs.amrprrs_proj_code%TYPE,
                          p_seq_no      amrprrs.amrprrs_seq_no%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN project_results_ref

Selects one record and locks it.

Parameters
p_pidm   The internal system generated ID number of a Prospect. NUMBER(8) Required Key
p_prop_code   The Proposal code which is being associated to the Prospect. VARCHAR2(24) Required Key
p_prop_seq_no   The sequence number of the Proposal record. NUMBER(3) Required Key
p_proj_code   The Project code which is being associated to the Proposal. VARCHAR2(24) Required Key
p_seq_no   The sequence number of the result record. NUMBER(3) 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_pidm        amrprrs.amrprrs_pidm%TYPE,
                   p_prop_code   amrprrs.amrprrs_prop_code%TYPE,
                   p_prop_seq_no amrprrs.amrprrs_prop_seq_no%TYPE,
                   p_proj_code   amrprrs.amrprrs_proj_code%TYPE,
                   p_seq_no      amrprrs.amrprrs_seq_no%TYPE,
                   p_user_id     amrprrs.amrprrs_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin amrprrs.amrprrs_data_origin%TYPE,
                   p_result_date amrprrs.amrprrs_result_date%TYPE,
                   p_gift_no     amrprrs.amrprrs_gift_no%TYPE DEFAULT NULL,
                   p_pledge_no   amrprrs.amrprrs_pledge_no%TYPE DEFAULT NULL,
                   p_campaign    amrprrs.amrprrs_campaign%TYPE DEFAULT NULL,
                   p_desg        amrprrs.amrprrs_desg%TYPE DEFAULT NULL,
                   p_value       amrprrs.amrprrs_value%TYPE DEFAULT NULL,
                   p_comment     amrprrs.amrprrs_comment%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   The internal system generated ID number of a Prospect. NUMBER(8) Required Key
p_prop_code   The Proposal code which is being associated to the Prospect. VARCHAR2(24) Required Key
p_prop_seq_no   The sequence number of the Proposal record. NUMBER(3) Required Key
p_proj_code   The Project code which is being associated to the Proposal. VARCHAR2(24) Required Key
p_seq_no   The sequence number of the result record. NUMBER(3) Required Key
p_user_id   User ID of the person who created/updated the record. VARCHAR2(120) Required
p_data_origin   System maintained field specifying the origin of the data. VARCHAR2(120) Required
p_result_date   Date the result was recorded. DATE Required
p_gift_no   The Gift Number associated with the result. VARCHAR2(28)
p_pledge_no   The Pledge Number associated with the result. VARCHAR2(28)
p_campaign   The Campaign associated with the result. VARCHAR2(20)
p_desg   The Designation associated with the result. VARCHAR2(40)
p_value   The value of the result. NUMBER(17,2)
p_comment   The comment associated with the result. VARCHAR2(4000)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_pidm        amrprrs.amrprrs_pidm%TYPE,
                   p_prop_code   amrprrs.amrprrs_prop_code%TYPE,
                   p_prop_seq_no amrprrs.amrprrs_prop_seq_no%TYPE,
                   p_proj_code   amrprrs.amrprrs_proj_code%TYPE,
                   p_seq_no      amrprrs.amrprrs_seq_no%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   The internal system generated ID number of a Prospect. NUMBER(8) Required Key
p_prop_code   The Proposal code which is being associated to the Prospect. VARCHAR2(24) Required Key
p_prop_seq_no   The sequence number of the Proposal record. NUMBER(3) Required Key
p_proj_code   The Project code which is being associated to the Proposal. VARCHAR2(24) Required Key
p_seq_no   The sequence number of the result record. NUMBER(3) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_pidm        amrprrs.amrprrs_pidm%TYPE,
                 p_prop_code   amrprrs.amrprrs_prop_code%TYPE,
                 p_prop_seq_no amrprrs.amrprrs_prop_seq_no%TYPE,
                 p_proj_code   amrprrs.amrprrs_proj_code%TYPE,
                 p_seq_no      amrprrs.amrprrs_seq_no%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_pidm   The internal system generated ID number of a Prospect. NUMBER(8) Required Key
p_prop_code   The Proposal code which is being associated to the Prospect. VARCHAR2(24) Required Key
p_prop_seq_no   The sequence number of the Proposal record. NUMBER(3) Required Key
p_proj_code   The Project code which is being associated to the Proposal. VARCHAR2(24) Required Key
p_seq_no   The sequence number of the result record. NUMBER(3) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_pidm        amrprrs.amrprrs_pidm%TYPE,
                   p_prop_code   amrprrs.amrprrs_prop_code%TYPE,
                   p_prop_seq_no amrprrs.amrprrs_prop_seq_no%TYPE,
                   p_proj_code   amrprrs.amrprrs_proj_code%TYPE,
                   p_seq_no      amrprrs.amrprrs_seq_no%TYPE,
                   p_user_id     amrprrs.amrprrs_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin amrprrs.amrprrs_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_result_date amrprrs.amrprrs_result_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_gift_no     amrprrs.amrprrs_gift_no%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pledge_no   amrprrs.amrprrs_pledge_no%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_campaign    amrprrs.amrprrs_campaign%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_desg        amrprrs.amrprrs_desg%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_value       amrprrs.amrprrs_value%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_comment     amrprrs.amrprrs_comment%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_pidm   The internal system generated ID number of a Prospect. NUMBER(8) Required Key
p_prop_code   The Proposal code which is being associated to the Prospect. VARCHAR2(24) Required Key
p_prop_seq_no   The sequence number of the Proposal record. NUMBER(3) Required Key
p_proj_code   The Project code which is being associated to the Proposal. VARCHAR2(24) Required Key
p_seq_no   The sequence number of the result record. NUMBER(3) Required Key
p_user_id   User ID of the person who created/updated the record. VARCHAR2(120) Required
p_data_origin   System maintained field specifying the origin of the data. VARCHAR2(120) Required
p_result_date   Date the result was recorded. DATE Required
p_gift_no   The Gift Number associated with the result. VARCHAR2(28)
p_pledge_no   The Pledge Number associated with the result. VARCHAR2(28)
p_campaign   The Campaign associated with the result. VARCHAR2(20)
p_desg   The Designation associated with the result. VARCHAR2(40)
p_value   The value of the result. NUMBER(17,2)
p_comment   The comment associated with the result. VARCHAR2(4000)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)