index

Package sb_facsec_access

Common Business interface for the FACSEC_ACCESS API (sb_facsec_access).

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
facsec_access_rec   Business Entity record type
facsec_access_ref   Entity cursor variable type
facsec_access_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(14) := 'FACSEC_ACCESS';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

facsec_access_rec 

TYPE facsec_access_rec IS RECORD (
  r_proc_code               sorfacs.sorfacs_proc_code%TYPE,
  r_role_cde                sorfacs.sorfacs_role_cde%TYPE,
  r_active_ind              sorfacs.sorfacs_active_ind%TYPE,
  r_all_access_ind          sorfacs.sorfacs_all_access_ind%TYPE,
  r_pin_control_ind         sorfacs.sorfacs_pin_control_ind%TYPE,
  r_relationship_ind        sorfacs.sorfacs_relationship_ind%TYPE,
  r_primary_ind             sorfacs.sorfacs_primary_ind%TYPE,
  r_attr_type_check_ind     sorfacs.sorfacs_attr_type_check_ind%TYPE,
  r_user_id                 sorfacs.sorfacs_user_id%TYPE,
  r_data_origin             sorfacs.sorfacs_data_origin%TYPE,
  r_sysreq_ind              sorfacs.sorfacs_sysreq_ind%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

facsec_access_ref 

TYPE facsec_access_ref IS REF CURSOR RETURN facsec_access_rec;

Entity cursor variable type

facsec_access_tab 

TYPE facsec_access_tab IS TABLE OF facsec_access_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_proc_code sorfacs.sorfacs_proc_code%TYPE,
                  p_role_cde  sorfacs.sorfacs_role_cde%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_proc_code   Process code to access levels for Processes. VARCHAR2(60) Required Key
p_role_cde   Role code to Access levels. VARCHAR2(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 facsec_access_rec, rec_two facsec_access_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 facsec_access_rec Required
rec_two   The second record to compare. Type facsec_access_rec Required

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

f_query_all 

Function f_query_all(p_proc_code sorfacs.sorfacs_proc_code%TYPE,
                     p_role_cde  sorfacs.sorfacs_role_cde%TYPE)
  RETURN facsec_access_ref

Selects all records for the entity.

Parameters
p_proc_code   Process code to access levels for Processes. VARCHAR2(60) Required Key
p_role_cde   Role code to Access levels. VARCHAR2(4) Required Key

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

f_query_one 

Function f_query_one(p_proc_code sorfacs.sorfacs_proc_code%TYPE,
                     p_role_cde  sorfacs.sorfacs_role_cde%TYPE)
  RETURN facsec_access_ref

Selects one record using the key.

Parameters
p_proc_code   Process code to access levels for Processes. VARCHAR2(60) Required Key
p_role_cde   Role code to Access levels. VARCHAR2(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 facsec_access_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_proc_code sorfacs.sorfacs_proc_code%TYPE,
                          p_role_cde  sorfacs.sorfacs_role_cde%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN facsec_access_ref

Selects one record and locks it.

Parameters
p_proc_code   Process code to access levels for Processes. VARCHAR2(60) Required Key
p_role_cde   Role code to Access levels. VARCHAR2(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_proc_code           sorfacs.sorfacs_proc_code%TYPE,
                   p_role_cde            sorfacs.sorfacs_role_cde%TYPE,
                   p_active_ind          sorfacs.sorfacs_active_ind%TYPE,
                   p_all_access_ind      sorfacs.sorfacs_all_access_ind%TYPE,
                   p_pin_control_ind     sorfacs.sorfacs_pin_control_ind%TYPE,
                   p_relationship_ind    sorfacs.sorfacs_relationship_ind%TYPE,
                   p_primary_ind         sorfacs.sorfacs_primary_ind%TYPE,
                   p_attr_type_check_ind sorfacs.sorfacs_attr_type_check_ind%TYPE,
                   p_user_id             sorfacs.sorfacs_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin         sorfacs.sorfacs_data_origin%TYPE DEFAULT NULL,
                   p_sysreq_ind          sorfacs.sorfacs_sysreq_ind%TYPE DEFAULT NULL,
                   p_rowid_out           OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_proc_code   Process code to access levels for Processes. VARCHAR2(60) Required Key
p_role_cde   Role code to Access levels. VARCHAR2(4) Required Key
p_active_ind   Indicates whether or not the process is active for access on self service faculty. VARCHAR2(4) Required
p_all_access_ind   Indicates whether or not all users can access the processes. VARCHAR2(4) Required
p_pin_control_ind   Indicates whether or not the faculty should enter the students PIN while accessing the process. VARCHAR2(4) Required
p_relationship_ind   Indicates whether or not the faculty should have a relation while accessing the process. VARCHAR2(4) Required
p_primary_ind   Indicates whether or not the faculty should be a primary instructor while accessing the process. VARCHAR2(4) Required
p_attr_type_check_ind   Indicates whether or not Attribute Checking should be done. VARCHAR2(4) Required
p_user_id   ID of the user who inserted or last updated the data. VARCHAR2(120) Required
p_data_origin   Source system that generated the data. VARCHAR2(120)
p_sysreq_ind   Indicates whether record is Required by the System. VARCHAR2(4)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_proc_code sorfacs.sorfacs_proc_code%TYPE,
                   p_role_cde  sorfacs.sorfacs_role_cde%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_proc_code   Process code to access levels for Processes. VARCHAR2(60) Required Key
p_role_cde   Role code to Access levels. VARCHAR2(4) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_proc_code   sorfacs.sorfacs_proc_code%TYPE,
                 p_role_cde    sorfacs.sorfacs_role_cde%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_proc_code   Process code to access levels for Processes. VARCHAR2(60) Required Key
p_role_cde   Role code to Access levels. VARCHAR2(4) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_proc_code           sorfacs.sorfacs_proc_code%TYPE,
                   p_role_cde            sorfacs.sorfacs_role_cde%TYPE,
                   p_active_ind          sorfacs.sorfacs_active_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_all_access_ind      sorfacs.sorfacs_all_access_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pin_control_ind     sorfacs.sorfacs_pin_control_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_relationship_ind    sorfacs.sorfacs_relationship_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_primary_ind         sorfacs.sorfacs_primary_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attr_type_check_ind sorfacs.sorfacs_attr_type_check_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id             sorfacs.sorfacs_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin         sorfacs.sorfacs_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sysreq_ind          sorfacs.sorfacs_sysreq_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid               gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_proc_code   Process code to access levels for Processes. VARCHAR2(60) Required Key
p_role_cde   Role code to Access levels. VARCHAR2(4) Required Key
p_active_ind   Indicates whether or not the process is active for access on self service faculty. VARCHAR2(4) Required
p_all_access_ind   Indicates whether or not all users can access the processes. VARCHAR2(4) Required
p_pin_control_ind   Indicates whether or not the faculty should enter the students PIN while accessing the process. VARCHAR2(4) Required
p_relationship_ind   Indicates whether or not the faculty should have a relation while accessing the process. VARCHAR2(4) Required
p_primary_ind   Indicates whether or not the faculty should be a primary instructor while accessing the process. VARCHAR2(4) Required
p_attr_type_check_ind   Indicates whether or not Attribute Checking should be done. VARCHAR2(4) Required
p_user_id   ID of the user who inserted or last updated the data. VARCHAR2(120) Required
p_data_origin   Source system that generated the data. VARCHAR2(120)
p_sysreq_ind   Indicates whether record is Required by the System. VARCHAR2(4)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)