index

Package gb_roomdefinition

This package provides the Common Business interface for the Room Definition API (gb_roomdefinition).
Room information can be maintained for any rooms in any of the institutional buildings.  Room information can be used in various Banner modules:  Location Management, Class Schedule and Event Management.  Room information is defined by term and can be changed for an existing term at any time.  Room information can also be created for a new effective term.  A building must be defined before room information can be created.

Program units
f_api_version   Returns the API version number.
f_exists   Checks to see if a record exists.
f_exists_for_eff_term   Checks to see if a record exists for the effective term.
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_one_by_max_term   Selects one record using the key, selecting the max term record for the given 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
roomdefinition_rec   Entity record type
roomdefinition_ref   Entity cursor variable type
roomdefinition_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity name

M_ENTITY_NAME 

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

Business Entity name

roomdefinition_rec 

TYPE roomdefinition_rec IS RECORD(

   r_bldg_code                   slbrdef.slbrdef_bldg_code%TYPE,
   r_room_number                 slbrdef.slbrdef_room_number%TYPE,
   r_desc                        slbrdef.slbrdef_desc%TYPE,
   r_capacity                    slbrdef.slbrdef_capacity%TYPE,
   r_maximum_capacity            slbrdef.slbrdef_maximum_capacity%TYPE,
   r_rmst_code                   slbrdef.slbrdef_rmst_code%TYPE,
   r_rrcd_code                   slbrdef.slbrdef_rrcd_code%TYPE,
   r_prcd_code                   slbrdef.slbrdef_prcd_code%TYPE,
   r_utility_rate                slbrdef.slbrdef_utility_rate%TYPE,
   r_utility_rate_period         slbrdef.slbrdef_utility_rate_period%TYPE,
   r_phone_area                  slbrdef.slbrdef_phone_area%TYPE,
   r_phone_number                slbrdef.slbrdef_phone_number%TYPE,
   r_phone_extension             slbrdef.slbrdef_phone_extension%TYPE,
   r_bcat_code                   slbrdef.slbrdef_bcat_code%TYPE,
   r_sex                         slbrdef.slbrdef_sex%TYPE,
   r_room_type                   slbrdef.slbrdef_room_type%TYPE,
   r_priority                    slbrdef.slbrdef_priority%TYPE,
   r_coll_code                   slbrdef.slbrdef_coll_code%TYPE,
   r_dept_code                   slbrdef.slbrdef_dept_code%TYPE,
   r_key_number                  slbrdef.slbrdef_key_number%TYPE,
   r_width                       slbrdef.slbrdef_width%TYPE,
   r_length                      slbrdef.slbrdef_length%TYPE,
   r_area                        slbrdef.slbrdef_area%TYPE,
   r_term_code_eff               slbrdef.slbrdef_term_code_eff%TYPE,
   r_pars_code                   slbrdef.slbrdef_pars_code%TYPE,
   r_ctry_code_phone             slbrdef.slbrdef_ctry_code_phone%TYPE,
   r_internal_record_id          gb_common.internal_record_id_type);

Entity record type

roomdefinition_ref 

TYPE roomdefinition_ref IS REF CURSOR
   RETURN roomdefinition_rec;

Entity cursor variable type

roomdefinition_tab 

TYPE roomdefinition_tab IS TABLE OF roomdefinition_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_bldg_code     slbrdef.slbrdef_bldg_code%TYPE,
                  p_room_number   slbrdef.slbrdef_room_number%TYPE,
                  p_term_code_eff slbrdef.slbrdef_term_code_eff%TYPE,
                  p_rowid         VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(10) Required key
p_term_code_eff   Term code associated with the room. VARCHAR2(6) Required key
p_rowid   Database ROWID of the record to be selected.  VARCHAR2(18)

Returns
Y if found, otherwise N.

f_exists_for_eff_term 

FUNCTION f_exists_for_eff_term(p_bldg_code     slbrdef.slbrdef_bldg_code%TYPE,
                               p_room_number   slbrdef.slbrdef_room_number%TYPE,
                               p_term_code_eff slbrdef.slbrdef_term_code_eff%TYPE,
                               p_rowid         VARCHAR2 DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists for the effective term.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(10) Required key
p_term_code_eff   Term code associated with the room.  VARCHAR2(6) 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 roomdefinition_rec,
                   rec_two roomdefinition_rec) RETURN VARCHAR2

Compares two records for equality. Nulls match nulls.

Parameters
rec_one   First record to compare. Defined as type roomdefinition_rec.
rec_two   Second record to compare. Defined as type roomdefinition_rec.

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

f_query_all 

FUNCTION f_query_all(p_bldg_code     slbrdef.slbrdef_bldg_code%TYPE,
                     p_room_number   slbrdef.slbrdef_room_number%TYPE,
                     p_term_code_eff slbrdef.slbrdef_term_code_eff%TYPE)
  RETURN roomdefinition_ref

Selects all records for the entity.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(10) Required key
p_term_code_eff   Term code associated with the room.  VARCHAR2(6) Required key

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

f_query_one 

FUNCTION f_query_one(p_bldg_code     slbrdef.slbrdef_bldg_code%TYPE,
                     p_room_number   slbrdef.slbrdef_room_number%TYPE,
                     p_term_code_eff slbrdef.slbrdef_term_code_eff%TYPE)
  RETURN roomdefinition_ref

Selects one record using the key.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(10) Required key
p_term_code_eff   Term code associated with the room. VARCHAR2(6) Required key

Returns
A cursor variable that will fetch exactly one record.

f_query_one_by_max_term 

FUNCTION f_query_one_by_max_term(p_bldg_code     slbrdef.slbrdef_bldg_code%TYPE,
                                 p_room_number   slbrdef.slbrdef_room_number%TYPE,
                                 p_term_code_eff slbrdef.slbrdef_term_code_eff%TYPE)
  RETURN roomdefinition_ref

Selects one record using the key, selecting the max term record for the given key.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(10) Required key
p_term_code_eff   Term code associated with the room.  VARCHAR2(6) Required key

Returns
A cursor variable that will fetch exactly one record.

f_query_by_rowid 

FUNCTION f_query_by_rowid(p_rowid VARCHAR2) RETURN roomdefinition_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_bldg_code     slbrdef.slbrdef_bldg_code%TYPE,
                          p_room_number   slbrdef.slbrdef_room_number%TYPE,
                          p_term_code_eff slbrdef.slbrdef_term_code_eff%TYPE,
                          p_rowid         VARCHAR2 DEFAULT NULL)
  RETURN roomdefinition_ref

Selects one record and locks it.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(10) Required key
p_term_code_eff   Term code associated with the room.  VARCHAR2(6) 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_bldg_code           slbrdef.slbrdef_bldg_code%TYPE,
                   p_room_number         slbrdef.slbrdef_room_number%TYPE,
                   p_desc                slbrdef.slbrdef_desc%TYPE DEFAULT NULL,
                   p_capacity            slbrdef.slbrdef_capacity%TYPE,
                   p_maximum_capacity    slbrdef.slbrdef_maximum_capacity%TYPE DEFAULT NULL,
                   p_rmst_code           slbrdef.slbrdef_rmst_code%TYPE DEFAULT NULL,
                   p_rrcd_code           slbrdef.slbrdef_rrcd_code%TYPE DEFAULT NULL,
                   p_prcd_code           slbrdef.slbrdef_prcd_code%TYPE DEFAULT NULL,
                   p_utility_rate        slbrdef.slbrdef_utility_rate%TYPE DEFAULT NULL,
                   p_utility_rate_period slbrdef.slbrdef_utility_rate_period%TYPE DEFAULT NULL,
                   p_phone_area          slbrdef.slbrdef_phone_area%TYPE DEFAULT NULL,
                   p_phone_number        slbrdef.slbrdef_phone_number%TYPE DEFAULT NULL,
                   p_phone_extension     slbrdef.slbrdef_phone_extension%TYPE DEFAULT NULL,
                   p_bcat_code           slbrdef.slbrdef_bcat_code%TYPE DEFAULT NULL,
                   p_sex                 slbrdef.slbrdef_sex%TYPE DEFAULT NULL,
                   p_room_type           slbrdef.slbrdef_room_type%TYPE,
                   p_priority            slbrdef.slbrdef_priority%TYPE DEFAULT NULL,
                   p_coll_code           slbrdef.slbrdef_coll_code%TYPE DEFAULT NULL,
                   p_dept_code           slbrdef.slbrdef_dept_code%TYPE DEFAULT NULL,
                   p_key_number          slbrdef.slbrdef_key_number%TYPE DEFAULT NULL,
                   p_width               slbrdef.slbrdef_width%TYPE DEFAULT NULL,
                   p_length              slbrdef.slbrdef_length%TYPE DEFAULT NULL,
                   p_area                slbrdef.slbrdef_area%TYPE DEFAULT NULL,
                   p_term_code_eff       slbrdef.slbrdef_term_code_eff%TYPE,
                   p_pars_code           slbrdef.slbrdef_pars_code%TYPE DEFAULT NULL,
                   p_ctry_code_phone     slbrdef.slbrdef_ctry_code_phone%TYPE DEFAULT NULL,
                   p_rowid_out           OUT VARCHAR2)

Creates a record.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(6) Required key
p_desc   Description associated with the room.  VARCHAR2(50)
p_capacity   Capacity of the room.   NUMBER(5) Required
p_maximum_capacity   Maximum capacity of the room.  NUMBER(5)
p_rmst_code   Status code associated with the room. VARCHAR2(2)
p_rrcd_code   Room rate code associated with the room.  VARCHAR2(4)
p_prcd_code   Phone rate code associated with the room.  VARCHAR2(4)
p_utility_rate   Utility rate associated with the room.  NUMBER(9)
p_utility_rate_period   Time period for which the utility rate is associated with the room.  VARCHAR2(2)
p_phone_area   Area code of the room.  VARCHAR2(3)
p_phone_number   Phone number of the room. VARCHAR2(7)
p_phone_extension   Phone extension number of the room.  VARCHAR2(4)
p_bcat_code   Building category associated with the room. VARCHAR2(4)
p_sex   Gender associated with the room. VARCHAR2(1)
p_room_type   Room type of the building, for example, dorm, class, or other.  VARCHAR2(1) Required
p_priority   Priority of the room, used by the scheduler to determine which rooms are used first. VARCHAR2(8)
p_coll_code   College associated with the room.  VARCHAR2(2)
p_dept_code   Department associated with the room.  VARCHAR2(4)
p_key_number   Number of the key to the room.  VARCHAR2(5)
p_width   Width, in feet, of the room.  NUMBER(8)
p_length   Length, in feet, of the room.  NUMBER(8)
p_area   Area, in square feet, of the room.  NUMBER(12)
p_term_code_eff   Term code effective date.  VARCHAR2(6) Required key
p_pars_code   Partition code associated with the room. Partition codes define campus zones, which are categories or groupings of rooms. Partitions can be defined on buildings, rooms, subjects, courses and sections. VARCHAR2(7)
p_ctry_code_phone   Telephone code designating the region and country  VARCHAR2(4) Required
p_rowid_out   Database ROWID of the record to be created.  VARCHAR2(18)

p_delete 

PROCEDURE p_delete(p_bldg_code     slbrdef.slbrdef_bldg_code%TYPE,
                   p_room_number   slbrdef.slbrdef_room_number%TYPE,
                   p_term_code_eff slbrdef.slbrdef_term_code_eff%TYPE,
                   p_rowid         VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(6) Required key
p_term_code_eff   Term code effective date.  VARCHAR2(6) Required key
p_rowid   Database ROWID of the record to be deleted.  VARCHAR2(18)

p_lock 

PROCEDURE p_lock(p_bldg_code     slbrdef.slbrdef_bldg_code%TYPE,
                 p_room_number   slbrdef.slbrdef_room_number%TYPE,
                 p_term_code_eff slbrdef.slbrdef_term_code_eff%TYPE,
                 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_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(6) Required key
p_term_code_eff   Term code effective date.  VARCHAR2(6) Required key
p_rowid_inout   Database ROWID of the record to be locked.  VARCHAR2(18)

p_update 

PROCEDURE p_update(p_bldg_code           slbrdef.slbrdef_bldg_code%TYPE,
                   p_room_number         slbrdef.slbrdef_room_number%TYPE,
                   p_desc                slbrdef.slbrdef_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_capacity            slbrdef.slbrdef_capacity%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_maximum_capacity    slbrdef.slbrdef_maximum_capacity%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rmst_code           slbrdef.slbrdef_rmst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rrcd_code           slbrdef.slbrdef_rrcd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prcd_code           slbrdef.slbrdef_prcd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_utility_rate        slbrdef.slbrdef_utility_rate%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_utility_rate_period slbrdef.slbrdef_utility_rate_period%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_phone_area          slbrdef.slbrdef_phone_area%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_phone_number        slbrdef.slbrdef_phone_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_phone_extension     slbrdef.slbrdef_phone_extension%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bcat_code           slbrdef.slbrdef_bcat_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sex                 slbrdef.slbrdef_sex%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_room_type           slbrdef.slbrdef_room_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_priority            slbrdef.slbrdef_priority%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coll_code           slbrdef.slbrdef_coll_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dept_code           slbrdef.slbrdef_dept_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_key_number          slbrdef.slbrdef_key_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_width               slbrdef.slbrdef_width%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_length              slbrdef.slbrdef_length%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_area                slbrdef.slbrdef_area%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_term_code_eff       slbrdef.slbrdef_term_code_eff%TYPE,
                   p_pars_code           slbrdef.slbrdef_pars_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ctry_code_phone     slbrdef.slbrdef_ctry_code_phone%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid               VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters
p_bldg_code   Building code associated with the room.  VARCHAR2(6) Required key
p_room_number   Room number associated with the room.  VARCHAR2(6) Required key
p_desc   Description associated with the room.  VARCHAR2(50)
p_capacity   Capacity of the room.   NUMBER(5) Required
p_maximum_capacity   Maximum capacity of the room.  NUMBER(5)
p_rmst_code   Status code associated with the room. VARCHAR2(2)
p_rrcd_code   Room rate code associated with the room.  VARCHAR2(4)
p_prcd_code   Phone rate code associated with the room.  VARCHAR2(4)
p_utility_rate   Utility rate associated with the room.  NUMBER(9)
p_utility_rate_period   Time period for which the utility rate is associated with the room.  VARCHAR2(2)
p_phone_area   Area code of the room.  VARCHAR2(3)
p_phone_number   Phone number of the room. VARCHAR2(7)
p_phone_extension   Phone extension number of the room.  VARCHAR2(4)
p_bcat_code   Building category associated with the room. VARCHAR2(4)
p_sex   Gender associated with the room. VARCHAR2(1)
p_room_type   Room type of the building, for example, dorm, class, or other.  VARCHAR2(1) Required
p_priority   Priority of the room, used by the scheduler to determine which rooms are used first. VARCHAR2(8)
p_coll_code   College associated with the room.  VARCHAR2(2)
p_dept_code   Department associated with the room.  VARCHAR2(4)
p_key_number   Number of the key to the room.  VARCHAR2(5)
p_width   Width, in feet, of the room.  NUMBER(8)
p_length   Length, in feet, of the room.  NUMBER(8)
p_area   Area, in square feet, of the room.  NUMBER(12)
p_term_code_eff   Term code effective date.  VARCHAR2(6) Required key
p_pars_code   Partition code associated with the room. Partition codes define campus zones, which are categories or groupings of rooms. Partitions can be defined on buildings, rooms, subjects, courses and sections. VARCHAR2(7)
p_ctry_code_phone   Telephone code designating the region and country  VARCHAR2(4) Required
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)