index

Package gb_fgacexcludedobjects

This package provides the Common Business interface for the FGAC Excluded Objects API, gb_fgacexcludedobjects.
 
GOBFEOB: (FGAC Excluded Objects)
 
Excluded objects provide a way to exempt a specific user from all FGAC processing rules (GOKFGAC package) that would otherwise be applied to the VBS and PII restrictions assigned to a user ID or to a business profile assigned to a user ID.
 
An excluded object will override all FGAC rules (VBS and PII) and allow the user full and unrestricted access to the data associated with the object.
 
When a user accesses a Banner object (form, batch process, etc.) the excluded object rules are queried to determine if the object exists for the user.
 
If it does, the GOKFGAC procedures that configure VBS and PII predicates will send back a "true" statement instead of the SQL statements coded in the FGAC VBS Group Rules and the PII table rules.


Program units
f_api_version   Returns the API version number.
f_exists   Checks to see 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
fgacexcludedobjects_rec   Entity record type.
fgacexcludedobjects_ref   Entity cursor variable type.
fgacexcludedobjects_tab   Entity table type.

Constants
M_ENTITY_NAME   Business Entity name.


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(19) := 'FGACEXCLUDEDOBJECTS';

Business Entity name.


fgacexcludedobjects_rec

TYPE fgacexcludedobjects_rec IS RECORD (
   r_object                  gobfeob.gobfeob_object%TYPE,
   r_user_id                 gobfeob.gobfeob_user_id%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type.


fgacexcludedobjects_ref

TYPE fgacexcludedobjects_ref IS REF CURSOR RETURN fgacexcludedobjects_rec;

Entity cursor variable type.


fgacexcludedobjects_tab

TYPE fgacexcludedobjects_tab IS TABLE OF fgacexcludedobjects_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_object gobfeob.gobfeob_object%TYPE,
                  p_rowid  VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_object   Object excluded from FGAC processing. Required Key
p_rowid   Database ROWID of the record to be selected. Optional

Returns
Y if found, otherwise N


f_isequal

FUNCTION f_isequal(rec_one fgacexcludedobjects_rec,
                   rec_two fgacexcludedobjects_rec) RETURN VARCHAR2

Compares two records for equality.

Parameters
rec_one   The first record to compare. Defined as type fgacexcludedobjects_rec. Required
rec_two   The second record to compare. Defined as type fgacexcludedobjects_rec. Required

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


f_query_all

FUNCTION f_query_all(p_object gobfeob.gobfeob_object%TYPE)
  RETURN fgacexcludedobjects_ref

Selects all records for the entity.

Parameters
p_object   Object excluded from FGAC processing. Required Key

Returns
A cursor variable that will fetch the set of records


f_query_one

FUNCTION f_query_one(p_object gobfeob.gobfeob_object%TYPE)
  RETURN fgacexcludedobjects_ref

Selects one record using the key.

Parameters
p_object   Object excluded from FGAC processing. 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 fgacexcludedobjects_ref

Selects one record using the ROWID.

Parameters
p_rowid   Database ROWID of the record to be selected. Required

Returns
A cursor variable that will fetch exactly one record


f_query_one_lock

FUNCTION f_query_one_lock(p_object gobfeob.gobfeob_object%TYPE,
                          p_rowid  VARCHAR2 DEFAULT NULL)
  RETURN fgacexcludedobjects_ref

Selects one record and locks it.

Parameters
p_object   Object excluded from FGAC processing. Required Key
p_rowid   Database ROWID of the record to be selected. Optional

Returns
A cursor variable for one record, locking the record


p_create

PROCEDURE p_create(p_object    gobfeob.gobfeob_object%TYPE,
                   p_user_id   gobfeob.gobfeob_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out OUT VARCHAR2)

Creates a record.

Parameters
p_object   Object excluded from FGAC processing. Required Key
p_user_id   Oracle ID of the user to create or last updated the record. Optional
p_rowid_out   Database ROWID of the record that was created. Required


p_delete

PROCEDURE p_delete(p_object gobfeob.gobfeob_object%TYPE,
                   p_rowid  VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters
p_object   Object excluded from FGAC processing. Required Key
p_rowid   Database ROWID of the record to be deleted. Optional


p_lock

PROCEDURE p_lock(p_object      gobfeob.gobfeob_object%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_object   Object excluded from FGAC processing. Required Key
p_rowid_inout   Database ROWID of the record to be locked. Required


p_update

PROCEDURE p_update(p_object  gobfeob.gobfeob_object%TYPE,
                   p_user_id gobfeob.gobfeob_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid   VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters
p_object   Object excluded from FGAC processing. Required Key
p_user_id   Oracle ID of the user who created or last updated the record. Optional
p_rowid   Database ROWID of the record to be updated. Optional