Package sb_mealassignment

This package provides the Common Business interface for the Meal Assignment API (sb_mealassignment).
This API provides the capability to create and maintain information with regard to an applicant's meal assignment. Meal assignments can be made for students and non-students. Meal assignments are made based on term, and the internal personal identfication number (PIDM) must have an active meal application that includes the meal assignment term.

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

p_calc_days_months_terms

Types

mealassignment_rec

mealassignment_ref

mealassignment_tab

Constants

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(14) := 'MEALASSIGNMENT';

Business Entity name

mealassignment_rec

TYPE mealassignment_rec IS RECORD (
   r_pidm                    slrmasg.slrmasg_pidm%TYPE,
   r_term_code               slrmasg.slrmasg_term_code%TYPE,
   r_mrcd_code               slrmasg.slrmasg_mrcd_code%TYPE,
   r_begin_date              slrmasg.slrmasg_begin_date%TYPE,
   r_end_date                slrmasg.slrmasg_end_date%TYPE,
   r_total_days              slrmasg.slrmasg_total_days%TYPE,
   r_total_months            slrmasg.slrmasg_total_months%TYPE,
   r_total_terms             slrmasg.slrmasg_total_terms%TYPE,
   r_mscd_code               slrmasg.slrmasg_mscd_code%TYPE,
   r_mscd_date               slrmasg.slrmasg_mscd_date%TYPE,
   r_onl_or_bat              slrmasg.slrmasg_onl_or_bat%TYPE,
   r_ar_ind                  slrmasg.slrmasg_ar_ind%TYPE,
   r_roll_ind                slrmasg.slrmasg_roll_ind%TYPE,
   r_assess_needed           slrmasg.slrmasg_assess_needed%TYPE,
   r_data_origin             slrmasg.slrmasg_data_origin%TYPE,
   r_user_id                 slrmasg.slrmasg_user_id%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

mealassignment_ref

TYPE mealassignment_ref IS REF CURSOR RETURN mealassignment_rec;

Entity cursor variable type

mealassignment_tab

TYPE mealassignment_tab IS TABLE OF mealassignment_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_rowid                     VARCHAR2) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns

Y if found, otherwise N

f_isequal

Function f_isequal(
      rec_one                     mealassignment_rec,
      rec_two                     mealassignment_rec) RETURN VARCHAR2

Compares two records for equality. Nulls match nulls.

Parameters

	rec_one	First record to compare. Defined as type mealassignment_rec.
	rec_two	Second record to compare. Defined as type mealassignment_rec.

Returns

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

f_query_all

Function f_query_all(
      p_pidm                    slrmasg.slrmasg_pidm%TYPE,
      p_term_code               slrmasg.slrmasg_term_code%TYPE DEFAULT NULL,
      p_mrcd_code               slrmasg.slrmasg_mrcd_code%TYPE DEFAULT NULL,
      p_begin_date              slrmasg.slrmasg_begin_date%TYPE DEFAULT NULL,
      p_end_date                slrmasg.slrmasg_end_date%TYPE DEFAULT NULL,
      p_total_days              slrmasg.slrmasg_total_days%TYPE DEFAULT NULL,
      p_total_months            slrmasg.slrmasg_total_months%TYPE DEFAULT NULL,
      p_total_terms             slrmasg.slrmasg_total_terms%TYPE DEFAULT NULL,
      p_mscd_code               slrmasg.slrmasg_mscd_code%TYPE DEFAULT NULL,
      p_mscd_date               slrmasg.slrmasg_mscd_date%TYPE DEFAULT NULL,
      p_onl_or_bat              slrmasg.slrmasg_onl_or_bat%TYPE DEFAULT NULL,
      p_ar_ind                  slrmasg.slrmasg_ar_ind%TYPE DEFAULT NULL,
      p_roll_ind                slrmasg.slrmasg_roll_ind%TYPE DEFAULT NULL,
      p_assess_needed           slrmasg.slrmasg_assess_needed%TYPE DEFAULT NULL,
      p_data_origin             slrmasg.slrmasg_data_origin%TYPE DEFAULT NULL,
      p_user_id                 slrmasg.slrmasg_user_id%TYPE DEFAULT NULL) RETURN mealassignment_ref

Selects all records for the entity.

Parameters

	p_pidm	Internal identifier associated with the meal assignment. NUMBER(8) Required
	p_term_code	Term code associated with the meal assignment. VARCHAR2(6)
	p_mrcd_code	Meal plan code. VARCHAR2(4)
	p_begin_date	First day of the meal assignment. DATE
	p_end_date	Last day of the meal assignment. DATE
	p_total_days	Total number of days of the meal assignment. NUMBER(9,5)
	p_total_months	Total number of months of the meal assignment. NUMBER(7,5)
	p_total_terms	Total number of terms of the meal assignment. NUMBER(7,5)
	p_mscd_code	Meal plan status code of the meal assignment. NUMBER(7,5)
	p_mscd_date	Date the meal plan status code was last updated. DATE
	p_onl_or_bat	Specifies whether the meal assignment was created online or in batch using the batch scheduler. VARCHAR2(1)
	p_ar_ind	Specifies whether the meal assignment charges have been processed. VARCHAR2(1)
	p_roll_ind	Controls whether the meal assignment can be rolled using the roll forward process. VARCHAR2(1)
	p_assess_needed	Specifies whether fee assessment is needed for the meal assignment. VARCHAR2(1)
	p_data_origin	Source system that generated the data. VARCHAR2(30)
	p_user_id	Oracle ID of the user who inserted or last updated the data. VARCHAR2(18)

Returns

A cursor variable that will fetch the set of records.

f_query_one

Function f_query_one(
      p_pidm                      slrmasg.slrmasg_pidm%TYPE,
      p_term_code                 slrmasg.slrmasg_term_code%TYPE,
      p_mrcd_code                 slrmasg.slrmasg_mrcd_code%TYPE,
      p_begin_date                slrmasg.slrmasg_begin_date%TYPE,
      p_end_date                  slrmasg.slrmasg_end_date%TYPE,
      p_total_days                slrmasg.slrmasg_total_days%TYPE,
      p_total_months              slrmasg.slrmasg_total_months%TYPE,
      p_total_terms               slrmasg.slrmasg_total_terms%TYPE,
      p_mscd_code                 slrmasg.slrmasg_mscd_code%TYPE,
      p_mscd_date                 slrmasg.slrmasg_mscd_date%TYPE,
      p_onl_or_bat                slrmasg.slrmasg_onl_or_bat%TYPE,
      p_ar_ind                    slrmasg.slrmasg_ar_ind%TYPE,
      p_roll_ind                  slrmasg.slrmasg_roll_ind%TYPE,
      p_assess_needed             slrmasg.slrmasg_assess_needed%TYPE,
      p_data_origin               slrmasg.slrmasg_data_origin%TYPE,
      p_user_id                   slrmasg.slrmasg_user_id%TYPE) RETURN mealassignment_ref

Selects one record using the key.

Parameters

	p_pidm	Internal identifier associated with the meal assignment. NUMBER(8) Required
	p_term_code	Term code associated with the meal assignment. VARCHAR2(6) Required
	p_mrcd_code	Meal plan code. VARCHAR2(4) Required
	p_begin_date	First day of the meal assignment. DATE Required
	p_end_date	Last day of the meal assignment. DATE Required
	p_total_days	Total number of days of the meal assignment. NUMBER(9,5) Required
	p_total_months	Total number of months of the meal assignment. NUMBER(7,5) Required
	p_total_terms	Total number of terms of the meal assignment. NUMBER(7,5) Required
	p_mscd_code	Meal plan status code of the meal assignment. VARCHAR2(2) Required
	p_mscd_date	Date the meal plan status code was last updated. DATE Required
	p_onl_or_bat	Specifies whether the meal assignment was created online or in batch using the batch scheduler. VARCHAR2(1) Required
	p_ar_ind	Specifies whether the meal assignment charges have been processed. VARCHAR2(1) Required
	p_roll_ind	Controls whether the meal assignment can be rolled using the roll forward process. VARCHAR2(1) Required
	p_assess_needed	Specifies whether fee assessment is needed for the meal assignment. VARCHAR2(1) Required
	p_data_origin	Source system that generated the data. VARCHAR2(30) Required
	p_user_id	Oracle ID of the user who inserted or last updated the data. VARCHAR2(30) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_by_rowid

Function f_query_by_rowid(
      p_rowid                     VARCHAR2) RETURN mealassignment_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_rowid                     VARCHAR2) RETURN mealassignment_ref

Selects one record and locks it.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns

A cursor variable for one record, locking the record.

p_create

Procedure p_create(
      p_pidm                 slrmasg.slrmasg_pidm%TYPE,
      p_term_code            slrmasg.slrmasg_term_code%TYPE,
      p_mrcd_code            slrmasg.slrmasg_mrcd_code%TYPE DEFAULT NULL,
      p_begin_date           slrmasg.slrmasg_begin_date%TYPE,
      p_end_date             slrmasg.slrmasg_end_date%TYPE,
      p_total_days           slrmasg.slrmasg_total_days%TYPE DEFAULT dml_common.f_unspecified_number,
      p_total_months         slrmasg.slrmasg_total_months%TYPE DEFAULT dml_common.f_unspecified_number,
      p_total_terms          slrmasg.slrmasg_total_terms%TYPE DEFAULT dml_common.f_unspecified_number,
      p_mscd_code            slrmasg.slrmasg_mscd_code%TYPE,
      p_mscd_date            slrmasg.slrmasg_mscd_date%TYPE,
      p_onl_or_bat           slrmasg.slrmasg_onl_or_bat%TYPE,
      p_ar_ind               slrmasg.slrmasg_ar_ind%TYPE,
      p_roll_ind             slrmasg.slrmasg_roll_ind%TYPE DEFAULT NULL,
      p_assess_needed        slrmasg.slrmasg_assess_needed%TYPE,
      p_data_origin          slrmasg.slrmasg_data_origin%TYPE DEFAULT gb_common.data_origin,
      p_user_id              slrmasg.slrmasg_user_id%TYPE DEFAULT gb_common.f_sct_user,
      p_rowid_out              OUT VARCHAR2)

Creates a record.

Parameters

	p_pidm	Internal identifier associated with the meal assignment. NUMBER(8) Required
	p_term_code	Term code associated with the meal assignment. VARCHAR2(6) Required
	p_mrcd_code	Meal plan code. VARCHAR2(4) Required
	p_begin_date	First day of the meal assignment. DATE Required
	p_end_date	Last day of the meal assignment. DATE Required
	p_total_days	Total number of days of the meal assignment. NUMBER(9,5)
	p_total_months	Total number of months of the meal assignment. NUMBER(7,5)
	p_total_terms	Total number of terms of the meal assignment. NUMBER(7,5)
	p_mscd_code	Meal plan status code of the meal assignment. VARCHAR2(2) Required
	p_mscd_date	Date the meal plan status code was last updated. DATE Required
	p_onl_or_bat	Specifies whether the meal assignment was created online or in batch using the batch scheduler. VARCHAR2(1) Required
	p_ar_ind	Specifies whether the meal assignment charges have been processed. Always N for No. VARCHAR2(1) Required
	p_roll_ind	Controls whether the meal assignment can be rolled using the roll forward process. VARCHAR2(1)
	p_assess_needed	Specifies whether fee assessment is needed for the meal assignment. Always Y for Yes. VARCHAR2(1) Required
	p_data_origin	Source system that generated the data. VARCHAR2(30)
	p_user_id	Oracle ID of the user who inserted or last updated the data. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18)

p_delete

Procedure p_delete(
      p_pidm                      slrmasg.slrmasg_pidm%TYPE DEFAULT NULL,
      p_term_code                 slrmasg.slrmasg_term_code%TYPE DEFAULT NULL,
      p_rowid                     VARCHAR2,
      p_purge_process             VARCHAR2 DEFAULT 'N')

Deletes a record.

Parameters

	p_pidm	Internal identifier associated with the meal assignment. NUMBER(8)
	p_term_code	Term code associated with the meal assignment. VARCHAR2(6)
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18) Required
	p_purge_process	Determines when deletes are allowed, Y for purge, N for not a purge process. Defaults N. VARCHAR2(1)

p_lock

Procedure p_lock(
      p_rowid_inout      IN OUT VARCHAR2)

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_rowid_inout

Database ROWID of the record to be locked.

p_update

Procedure p_update(
      p_pidm                 slrmasg.slrmasg_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
      p_term_code            slrmasg.slrmasg_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
      p_mrcd_code            slrmasg.slrmasg_mrcd_code%TYPE DEFAULT dml_common.f_unspecified_string,
      p_begin_date           slrmasg.slrmasg_begin_date%TYPE DEFAULT dml_common.f_unspecified_date,
      p_end_date             slrmasg.slrmasg_end_date%TYPE DEFAULT dml_common.f_unspecified_date,
      p_total_days           slrmasg.slrmasg_total_days%TYPE DEFAULT dml_common.f_unspecified_number,
      p_total_months         slrmasg.slrmasg_total_months%TYPE DEFAULT dml_common.f_unspecified_number,
      p_total_terms          slrmasg.slrmasg_total_terms%TYPE DEFAULT dml_common.f_unspecified_number,
      p_mscd_code            slrmasg.slrmasg_mscd_code%TYPE DEFAULT dml_common.f_unspecified_string,
      p_mscd_date            slrmasg.slrmasg_mscd_date%TYPE DEFAULT dml_common.f_unspecified_date,
      p_onl_or_bat           slrmasg.slrmasg_onl_or_bat%TYPE DEFAULT dml_common.f_unspecified_string,
      p_ar_ind               slrmasg.slrmasg_ar_ind%TYPE DEFAULT dml_common.f_unspecified_string,
      p_roll_ind             slrmasg.slrmasg_roll_ind%TYPE DEFAULT dml_common.f_unspecified_string,
      p_assess_needed        slrmasg.slrmasg_assess_needed%TYPE DEFAULT dml_common.f_unspecified_string,
      p_data_origin          slrmasg.slrmasg_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
      p_user_id              slrmasg.slrmasg_user_id%TYPE DEFAULT dml_common.f_unspecified_string,
      p_rowid                      VARCHAR2)

Updates a record.

Parameters

	p_pidm	Internal identifier associated with the meal assignment. NUMBER(8)
	p_term_code	Term code associated with the meal assignment. VARCHAR2(6)
	p_mrcd_code	Meal plan code. VARCHAR2(4)
	p_begin_date	First day of the meal assignment. DATE
	p_end_date	Last day of the meal assignment. DATE
	p_total_days	Total number of days of the meal assignment. NUMBER(9,5)
	p_total_months	Total number of months of the meal assignment. NUMBER(7,5)
	p_total_terms	Total number of terms of the meal assignment. NUMBER(7,5)
	p_mscd_code	Meal plan status code of the meal assignment. VARCHAR2(2)
	p_mscd_date	Date the meal plan status code was last updated. DATE
	p_onl_or_bat	Specifies whether the meal assignment was created online or in batch using the batch scheduler. VARCHAR2(1)
	p_ar_ind	Specifies whether the meal assignment charges have been processed. VARCHAR2(1)
	p_roll_ind	Controls whether the meal assignment can be rolled using the roll forward process. VARCHAR2(1)
	p_assess_needed	Specifies whether fee assessment is needed for the meal assignment. VARCHAR2(1)
	p_data_origin	Source system that generated the data. VARCHAR2(30)
	p_user_id	Oracle ID of the user who inserted or last updated the data. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18) Required

p_calc_days_months_terms

Procedure p_calc_days_months_terms(p_term_code slrmasg.slrmasg_term_code%TYPE,
         p_mrcd_code        slrmasg.slrmasg_mrcd_code%TYPE DEFAULT NULL,
         p_total_days       slrmasg.slrmasg_total_days%TYPE DEFAULT dml_common.f_unspecified_number,
         p_total_months     slrmasg.slrmasg_total_months%TYPE DEFAULT dml_common.f_unspecified_number,
         p_total_terms      slrmasg.slrmasg_total_terms%TYPE DEFAULT dml_common.f_unspecified_number,
         p_total_days_out   OUT slrmasg.slrmasg_total_days%TYPE,
         p_total_months_out OUT slrmasg.slrmasg_total_months%TYPE,
         p_total_terms_out  OUT slrmasg.slrmasg_total_terms%TYPE,
         p_err_msg_out      OUT gb_common_strings.err_type
)

Calculates the days, months and terms of the meal assignment.

Parameters

	p_term_code	Term code of the meal assignment. VARCHAR2(8) Required
	p_mrcd_code	Meal assignment code. VARCHAR2(4) Required
	p_total_days	Total days. NUMBER(9,5)
	p_total_months	Total months. NUMBER(7,5)
	p_total_terms	Total terms. NUMBER(7,5)
	p_total_days_out	Calculated value of the total days. NUMBER(9,5) Required
	p_total_months_out	Calculated value of the total months. NUMBER(7,5) Required
	p_total_terms_out	Calculated value of the total terms. NUMBER(7,5) Required