Package sb_gradapp

Package sb_gradapp_graddate

This package provides the Common Business interface for the Graduation Application Graduation Date Availability API (sb_gradapp_graddate).

The graduation dates that display via the self-service graduation application are defined in the Graduation Date Availability table (SHRGADA). A start date and an end date must be defined for each availability record. This information will provide the date range for which the record is considered available.
Graduation date, term and academic year information may be specified for the record and will be displayed to the learner via self-service. If a ceremony is associated with the graduation, the ceremony indicator can be checked to indicate this.

For each display rule defined, graduation date availability information is specified. When a learner accesses the self-service graduation application, the graduation dates available for selection will be those dates associated with the display rule being used.

Program units

f_api_version

f_exists

f_isequal

f_query_all

f_query_one

f_query_by_rowid

f_query_one_lock

p_create

p_delete

p_lock

p_update

Types

gradapp_graddate_rec

gradapp_graddate_ref

gradapp_graddate_tab

Constants

M_ENTITY_NAME

M_BASE_TABLE_NAME

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(16) := 'GRADAPP_GRADDATE';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

gradapp_graddate_rec

TYPE gradapp_graddate_rec IS RECORD (
  r_gadr_code               shrgada.shrgada_gadr_code%TYPE,
  r_seqno                   shrgada.shrgada_seqno%TYPE,
  r_from_date               shrgada.shrgada_from_date%TYPE,
  r_to_date                 shrgada.shrgada_to_date%TYPE,
  r_ceremony_ind            shrgada.shrgada_ceremony_ind%TYPE,
  r_user_id                 shrgada.shrgada_user_id%TYPE,
  r_grad_date               shrgada.shrgada_grad_date%TYPE,
  r_grad_term_code          shrgada.shrgada_grad_term_code%TYPE,
  r_acyr_code               shrgada.shrgada_acyr_code%TYPE,
  r_data_origin             shrgada.shrgada_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gradapp_graddate_ref

TYPE gradapp_graddate_ref IS REF CURSOR RETURN gradapp_graddate_rec;

Entity cursor variable type

gradapp_graddate_tab

TYPE gradapp_graddate_tab IS TABLE OF gradapp_graddate_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_gadr_code shrgada.shrgada_gadr_code%TYPE,
                  p_seqno     shrgada.shrgada_seqno%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_seqno	One-up number assigned to the row for the display rule code. NUMBER(4) 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 gradapp_graddate_rec,
                   rec_two gradapp_graddate_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 gradapp_graddate_rec Required
	rec_two	The second record to compare. Type gradapp_graddate_rec Required

Returns

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

f_query_all

Function f_query_all(p_gadr_code      shrgada.shrgada_gadr_code%TYPE DEFAULT NULL,
                     p_ceremony_ind   shrgada.shrgada_ceremony_ind%TYPE DEFAULT NULL,
                     p_grad_date      shrgada.shrgada_grad_date%TYPE DEFAULT NULL,
                     p_grad_term_code shrgada.shrgada_grad_term_code%TYPE DEFAULT NULL,
                     p_acyr_code      shrgada.shrgada_acyr_code%TYPE DEFAULT NULL)
  RETURN gradapp_graddate_ref

Selects all records for the entity.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Key
	p_ceremony_ind	Indicator for whether the graduation will have a ceremony. VARCHAR2(1)
	p_grad_date	Graduation date. DATE
	p_grad_term_code	Graduation term. VARCHAR2(6)
	p_acyr_code	Graduation year. VARCHAR2(4)

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_gadr_code shrgada.shrgada_gadr_code%TYPE,
                     p_seqno     shrgada.shrgada_seqno%TYPE)
  RETURN gradapp_graddate_ref

Selects one record using the key.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_seqno	One-up number assigned to the row for the display rule code. NUMBER(4) 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 gradapp_graddate_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_gadr_code shrgada.shrgada_gadr_code%TYPE,
                          p_seqno     shrgada.shrgada_seqno%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gradapp_graddate_ref

Selects one record and locks it.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_seqno	One-up number assigned to the row for the display rule code. NUMBER(4) 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_gadr_code      shrgada.shrgada_gadr_code%TYPE,
                   p_seqno          shrgada.shrgada_seqno%TYPE,
                   p_from_date      shrgada.shrgada_from_date%TYPE,
                   p_to_date        shrgada.shrgada_to_date%TYPE,
                   p_ceremony_ind   shrgada.shrgada_ceremony_ind%TYPE,
                   p_user_id        shrgada.shrgada_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_grad_date      shrgada.shrgada_grad_date%TYPE DEFAULT NULL,
                   p_grad_term_code shrgada.shrgada_grad_term_code%TYPE DEFAULT NULL,
                   p_acyr_code      shrgada.shrgada_acyr_code%TYPE DEFAULT NULL,
                   p_data_origin    shrgada.shrgada_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_seqno	One-up number assigned to the row for the display rule code. NUMBER(4) Required Key
	p_from_date	First date that the graduation date availability record is valid. DATE Required
	p_to_date	Last date that the graduation date availability record is valid. DATE Required
	p_ceremony_ind	Indicator for whether the graduation will have a ceremony. VARCHAR2(1) Required
	p_user_id	ID of the most recent user to create or update the row in the SHRGADA table. VARCHAR2(30) Required
	p_grad_date	Graduation date. DATE
	p_grad_term_code	Graduation term. VARCHAR2(6)
	p_acyr_code	Graduation year. VARCHAR2(4)
	p_data_origin	Value of the source system that inserted or updated the row. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_gadr_code shrgada.shrgada_gadr_code%TYPE,
                   p_seqno     shrgada.shrgada_seqno%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_seqno	One-up number assigned to the row for the display rule code. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_gadr_code   shrgada.shrgada_gadr_code%TYPE,
                 p_seqno       shrgada.shrgada_seqno%TYPE,
                 p_rowid_inout IN OUT 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_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_seqno	One-up number assigned to the row for the display rule code. NUMBER(4) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_gadr_code      shrgada.shrgada_gadr_code%TYPE,
                   p_seqno          shrgada.shrgada_seqno%TYPE,
                   p_from_date      shrgada.shrgada_from_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_to_date        shrgada.shrgada_to_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_ceremony_ind   shrgada.shrgada_ceremony_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id        shrgada.shrgada_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_grad_date      shrgada.shrgada_grad_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_grad_term_code shrgada.shrgada_grad_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acyr_code      shrgada.shrgada_acyr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin    shrgada.shrgada_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_seqno	One-up number assigned to the row for the display rule code. NUMBER(4) Required Key
	p_from_date	First date that the graduation date availability record is valid. DATE Required
	p_to_date	Last date that the graduation date availability record is valid. DATE Required
	p_ceremony_ind	Indicator for whether the graduation will have a ceremony. VARCHAR2(1) Required
	p_user_id	ID of the most recent user to create or update the row in the SHRGADA table. VARCHAR2(30) Required
	p_grad_date	Graduation date. DATE
	p_grad_term_code	Graduation term. VARCHAR2(6)
	p_acyr_code	Graduation year. VARCHAR2(4)
	p_data_origin	Value of the source system that inserted or updated the row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)