Package ab_proposal

Package ab_proposal_history

This package provides the Common Business interface for the Proposal History API (ab_proposal_history).

Each time a change is made to a Prospects Proposals Base Table (ambprop) record, the previous values will be stored in a Prospects Proposal History Base Table (ambprph) record by this package.

All data values from the record before the changes were made will be stored in these history records.
Each field in the ambprph table has an associate 'change indicator'. This field will contain a 'Y' if the value was changed on the current record and an 'N' if the field was not changed.

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

proposal_history_rec	Business Entity record type
proposal_history_ref	Entity cursor variable type
proposal_history_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) := 'PROPOSAL_HISTORY';

Business Entity name

M_BASE_TABLE_NAME

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

Base table name

proposal_history_rec

TYPE proposal_history_rec IS RECORD (
  r_pidm                    ambprph.ambprph_pidm%TYPE,
  r_prop_code               ambprph.ambprph_prop_code%TYPE,
  r_seq_no                  ambprph.ambprph_seq_no%TYPE,
  r_user_id                 ambprph.ambprph_user_id%TYPE,
  r_data_origin             ambprph.ambprph_data_origin%TYPE,
  r_prst_code_chg_ind       ambprph.ambprph_prst_code_chg_ind%TYPE,
  r_prst_code               ambprph.ambprph_prst_code%TYPE,
  r_prst_date_chg_ind       ambprph.ambprph_prst_date_chg_ind%TYPE,
  r_prst_date               ambprph.ambprph_prst_date%TYPE,
  r_staff_pidm_chg_ind      ambprph.ambprph_staff_pidm_chg_ind%TYPE,
  r_staff_pidm              ambprph.ambprph_staff_pidm%TYPE,
  r_staff_iden_chg_ind      ambprph.ambprph_staff_iden_chg_ind%TYPE,
  r_staff_iden_code         ambprph.ambprph_staff_iden_code%TYPE,
  r_due_date_chg_ind        ambprph.ambprph_due_date_chg_ind%TYPE,
  r_due_date                ambprph.ambprph_due_date%TYPE,
  r_finance_code_chg_ind    ambprph.ambprph_finance_code_chg_ind%TYPE,
  r_finance_code            ambprph.ambprph_finance_code%TYPE,
  r_ask_amount_chg_ind      ambprph.ambprph_ask_amount_chg_ind%TYPE,
  r_ask_amount              ambprph.ambprph_ask_amount%TYPE,
  r_comment_chg_ind         ambprph.ambprph_comment_chg_ind%TYPE,
  r_comment                 ambprph.ambprph_comment%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

proposal_history_ref

TYPE proposal_history_ref IS REF CURSOR RETURN proposal_history_rec;

Entity cursor variable type

proposal_history_tab

TYPE proposal_history_tab IS TABLE OF proposal_history_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      ambprph.ambprph_pidm%TYPE,
                  p_prop_code ambprph.ambprph_prop_code%TYPE,
                  p_seq_no    ambprph.ambprph_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_seq_no	The sequence number of the history for the Proposal. 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 proposal_history_rec,
                   rec_two proposal_history_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 proposal_history_rec Required
	rec_two	The second record to compare. Type proposal_history_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      ambprph.ambprph_pidm%TYPE,
                     p_prop_code ambprph.ambprph_prop_code%TYPE,
                     p_seq_no    ambprph.ambprph_seq_no%TYPE)
  RETURN proposal_history_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_seq_no	The sequence number of the history for the Proposal. NUMBER(3) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_pidm      ambprph.ambprph_pidm%TYPE,
                     p_prop_code ambprph.ambprph_prop_code%TYPE,
                     p_seq_no    ambprph.ambprph_seq_no%TYPE)
  RETURN proposal_history_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_seq_no	The sequence number of the history for the Proposal. 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 proposal_history_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      ambprph.ambprph_pidm%TYPE,
                          p_prop_code ambprph.ambprph_prop_code%TYPE,
                          p_seq_no    ambprph.ambprph_seq_no%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN proposal_history_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_seq_no	The sequence number of the history for the Proposal. 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                 ambprph.ambprph_pidm%TYPE,
                   p_prop_code            ambprph.ambprph_prop_code%TYPE,
                   p_seq_no               ambprph.ambprph_seq_no%TYPE,
                   p_user_id              ambprph.ambprph_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin          ambprph.ambprph_data_origin%TYPE,
                   p_prst_code_chg_ind    ambprph.ambprph_prst_code_chg_ind%TYPE DEFAULT NULL,
                   p_prst_code            ambprph.ambprph_prst_code%TYPE DEFAULT NULL,
                   p_prst_date_chg_ind    ambprph.ambprph_prst_date_chg_ind%TYPE DEFAULT NULL,
                   p_prst_date            ambprph.ambprph_prst_date%TYPE DEFAULT NULL,
                   p_staff_pidm_chg_ind   ambprph.ambprph_staff_pidm_chg_ind%TYPE DEFAULT NULL,
                   p_staff_pidm           ambprph.ambprph_staff_pidm%TYPE DEFAULT NULL,
                   p_staff_iden_chg_ind   ambprph.ambprph_staff_iden_chg_ind%TYPE DEFAULT NULL,
                   p_staff_iden_code      ambprph.ambprph_staff_iden_code%TYPE DEFAULT NULL,
                   p_due_date_chg_ind     ambprph.ambprph_due_date_chg_ind%TYPE DEFAULT NULL,
                   p_due_date             ambprph.ambprph_due_date%TYPE DEFAULT NULL,
                   p_finance_code_chg_ind ambprph.ambprph_finance_code_chg_ind%TYPE DEFAULT NULL,
                   p_finance_code         ambprph.ambprph_finance_code%TYPE DEFAULT NULL,
                   p_ask_amount_chg_ind   ambprph.ambprph_ask_amount_chg_ind%TYPE DEFAULT NULL,
                   p_ask_amount           ambprph.ambprph_ask_amount%TYPE DEFAULT NULL,
                   p_comment_chg_ind      ambprph.ambprph_comment_chg_ind%TYPE DEFAULT NULL,
                   p_comment              ambprph.ambprph_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_seq_no	The sequence number of the history for the Proposal. 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_prst_code_chg_ind	Change indicator for the Status Code, Y = changed, N = unchanged. VARCHAR2(4)
	p_prst_code	The Status Code of the Proposal for the Prospect. VARCHAR2(4)
	p_prst_date_chg_ind	Change indicator for the Status Date, Y = changed, N = unchanged. VARCHAR2(4)
	p_prst_date	The Date of the Proposal Status for the Prospect. DATE
	p_staff_pidm_chg_ind	Change indicator for the Staff Internal ID, Y = changed, N = unchanged. VARCHAR2(4)
	p_staff_pidm	The internal system generated ID number of the Staff. NUMBER(8)
	p_staff_iden_chg_ind	Change indicator for the Staff Identification Code, Y = changed, N = unchanged. VARCHAR2(4)
	p_staff_iden_code	The identification code of the Staff. VARCHAR2(20)
	p_due_date_chg_ind	Change indicator for the Due Date, Y = changed, N = unchanged. VARCHAR2(4)
	p_due_date	The Due Date of the Proposal. DATE
	p_finance_code_chg_ind	Change indicator for the Grant Code, Y = changed, N = unchanged. VARCHAR2(4)
	p_finance_code	Grant code associated from Banner Finance, not yet implemented. VARCHAR2(36)
	p_ask_amount_chg_ind	Change indicator for the Ask Amount, Y = changed, N = unchanged. VARCHAR2(4)
	p_ask_amount	The Ask Amount for the Proposal for this prospect. NUMBER(13,2)
	p_comment_chg_ind	Change indicator for the Proposal Comment, Y = changed, N = unchanged. VARCHAR2(4)
	p_comment	Free Format column for entry of Proposal Comments. CLOB
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_pidm      ambprph.ambprph_pidm%TYPE,
                   p_prop_code ambprph.ambprph_prop_code%TYPE,
                   p_seq_no    ambprph.ambprph_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_seq_no	The sequence number of the history for the Proposal. NUMBER(3) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        ambprph.ambprph_pidm%TYPE,
                 p_prop_code   ambprph.ambprph_prop_code%TYPE,
                 p_seq_no      ambprph.ambprph_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_seq_no	The sequence number of the history for the Proposal. 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                 ambprph.ambprph_pidm%TYPE,
                   p_prop_code            ambprph.ambprph_prop_code%TYPE,
                   p_seq_no               ambprph.ambprph_seq_no%TYPE,
                   p_user_id              ambprph.ambprph_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin          ambprph.ambprph_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prst_code_chg_ind    ambprph.ambprph_prst_code_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prst_code            ambprph.ambprph_prst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prst_date_chg_ind    ambprph.ambprph_prst_date_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prst_date            ambprph.ambprph_prst_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_staff_pidm_chg_ind   ambprph.ambprph_staff_pidm_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_staff_pidm           ambprph.ambprph_staff_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_staff_iden_chg_ind   ambprph.ambprph_staff_iden_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_staff_iden_code      ambprph.ambprph_staff_iden_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_due_date_chg_ind     ambprph.ambprph_due_date_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_due_date             ambprph.ambprph_due_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_finance_code_chg_ind ambprph.ambprph_finance_code_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_finance_code         ambprph.ambprph_finance_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ask_amount_chg_ind   ambprph.ambprph_ask_amount_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ask_amount           ambprph.ambprph_ask_amount%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_comment_chg_ind      ambprph.ambprph_comment_chg_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_comment              ambprph.ambprph_comment%TYPE DEFAULT dml_common.f_unspecified_clob,
                   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_seq_no	The sequence number of the history for the Proposal. 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_prst_code_chg_ind	Change indicator for the Status Code, Y = changed, N = unchanged. VARCHAR2(4)
	p_prst_code	The Status Code of the Proposal for the Prospect. VARCHAR2(4)
	p_prst_date_chg_ind	Change indicator for the Status Date, Y = changed, N = unchanged. VARCHAR2(4)
	p_prst_date	The Date of the Proposal Status for the Prospect. DATE
	p_staff_pidm_chg_ind	Change indicator for the Staff Internal ID, Y = changed, N = unchanged. VARCHAR2(4)
	p_staff_pidm	The internal system generated ID number of the Staff. NUMBER(8)
	p_staff_iden_chg_ind	Change indicator for the Staff Identification Code, Y = changed, N = unchanged. VARCHAR2(4)
	p_staff_iden_code	The identification code of the Staff. VARCHAR2(20)
	p_due_date_chg_ind	Change indicator for the Due Date, Y = changed, N = unchanged. VARCHAR2(4)
	p_due_date	The Due Date of the Proposal. DATE
	p_finance_code_chg_ind	Change indicator for the Grant Code, Y = changed, N = unchanged. VARCHAR2(4)
	p_finance_code	Grant code associated from Banner Finance, not yet implemented. VARCHAR2(36)
	p_ask_amount_chg_ind	Change indicator for the Ask Amount, Y = changed, N = unchanged. VARCHAR2(4)
	p_ask_amount	The Ask Amount for the Proposal for this prospect. NUMBER(13,2)
	p_comment_chg_ind	Change indicator for the Proposal Comment, Y = changed, N = unchanged. VARCHAR2(4)
	p_comment	Free Format column for entry of Proposal Comments. CLOB
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)