index

Package BANINST1.fb_vendor_type

Common Business interface for vendor type (FB_VENDOR_TYPE).


Program units
f_api_version   Return API version number
f_exists   Checks to see if record exists
f_query_all   Select all records for the entity
f_query_one   Select one record.
f_query_one_lock   Select one record and lock it.
p_create   Create record
p_delete   Delete a record
p_lock   Lock a record
p_update   Update a record

Types
vendor_type_rec   Vendor type record type
vendor_type_ref   Vendor type reference cursor
vendor_type_tab   Vendor type table type

Constants
M_ENTITY_NAME  


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(11) := 'VENDOR_TYPE';

vendor_type_rec

TYPE vendor_type_rec IS RECORD (
   r_pidm                    FTVVENT.FTVVENT_PIDM%TYPE,
   r_vtyp_code               FTVVENT.FTVVENT_VTYP_CODE%TYPE,
   r_user_id                 FTVVENT.FTVVENT_USER_ID%TYPE,
   r_data_origin             FTVVENT.FTVVENT_DATA_ORIGIN%TYPE,
   r_vtyp_desc               FTVVTYP.FTVVTYP_DESC%TYPE,
   internal_record_id      VARCHAR2(18) );

Vendor type record type


vendor_type_ref

TYPE vendor_type_ref IS REF CURSOR RETURN vendor_type_rec;

Vendor type reference cursor


vendor_type_tab

TYPE vendor_type_tab IS TABLE OF vendor_type_rec INDEX BY BINARY_INTEGER;

Vendor type table type


f_api_version

Function f_api_version RETURN PLS_INTEGER

Return API version number

Returns
Version of API signature. Changes only when signature changes.


f_exists

Function f_exists(p_pidm      ftvvent.ftvvent_pidm%TYPE,
                  p_vtyp_code ftvvent.ftvvent_vtyp_code%TYPE,
                  p_rowid     VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if record exists

Parameters
p_pidm   Personal identification number for the vendor.  Must exist on SATURN.SPRIDEN.
p_vtyp_code   Vendor type code.  Must exist on FTVVTYP.

Returns
TRUE if found, otherwise FALSE


f_query_all

Function f_query_all(p_pidm ftvvent.ftvvent_pidm%TYPE DEFAULT NULL)
  RETURN vendor_type_REF

Select all records for the entity

Parameters
p_pidm   Personal identification number for the vendor.  Must exist on SATURN.SPRIDEN.
p_vtyp_code   Vendor type code.  Must exist on FTVVTYP.

Returns
A cursor variable that will fetch the set of records


f_query_one

Function f_query_one(p_pidm      ftvvent.ftvvent_pidm%TYPE,
                     p_vtyp_code ftvvent.ftvvent_vtyp_code%TYPE)
  RETURN vendor_type_REF

Select one record.

Parameters
p_pidm   Personal identification number for the vendor.  Must exist on SATURN.SPRIDEN.
p_vtyp_code   Vendor type code.  Must exist on FTVVTYP.

Returns
A cursor variable that will fetch exactly one record


f_query_one_lock

Function f_query_one_lock(p_pidm      ftvvent.ftvvent_pidm%TYPE,
                          p_vtyp_code ftvvent.ftvvent_vtyp_code%TYPE,
                          p_rowid     VARCHAR2 DEFAULT NULL)
  RETURN vendor_type_REF

Select one record and lock it.

Parameters
p_pidm   Personal identification number for the vendor.  Must exist on SATURN.SPRIDEN.
p_vtyp_code   Vendor type code.  Must exist on FTVVTYP.

Returns
A cursor variable for one record, locking the record


p_create

Procedure p_create(p_pidm        ftvvent.ftvvent_pidm%TYPE,
                   p_vtyp_code   ftvvent.ftvvent_vtyp_code%TYPE,
                   p_user_id     ftvvent.ftvvent_user_id%TYPE,
                   p_data_origin ftvvent.ftvvent_data_origin%TYPE default NULL,
                   p_rowid_out   OUT VARCHAR2)

Create record
@throws RECORD_EXISTS Cannot create, record already exists

Parameters
p_pidm   Personal identification number for the vendor.  Must exist on SATURN.SPRIDEN.
p_vtyp_code   Vendor type code.  Must exist on FTVVTYP.
p_user_id   USER IDENTIFICATION:  The unique identification code of the user.
p_data_origin   DATA ORIGIN: Source system that generated the data.
p_rowid_out   Database rowid of record created


p_delete

Procedure p_delete(p_pidm      ftvvent.ftvvent_pidm%TYPE,
                   p_vtyp_code ftvvent.ftvvent_vtyp_code%TYPE,
                   p_rowid     VARCHAR2 DEFAULT NULL)

Delete a record
@throws P_DELETE_FAILED Cannot delete, record does not exist

Parameters
p_pidm   Personal identification number for the vendor.  Must exist on SATURN.SPRIDEN.
p_vtyp_code   Vendor type code.  Must exist on FTVVTYP.
p_rowid   Database rowid of record to delete


p_lock

Procedure p_lock(p_pidm      ftvvent.ftvvent_pidm%TYPE,
                 p_vtyp_code ftvvent.ftvvent_vtyp_code%TYPE,
                 p_rowid     VARCHAR2 DEFAULT NULL)

Lock a record

Parameters
p_pidm   Personal identification number for the vendor.  Must exist on SATURN.SPRIDEN.
p_vtyp_code   Vendor type code.  Must exist on FTVVTYP.


p_update

Procedure p_update(p_pidm        ftvvent.ftvvent_pidm%TYPE,
                   p_vtyp_code   ftvvent.ftvvent_vtyp_code%TYPE,
                   p_user_id     ftvvent.ftvvent_user_id%TYPE DEFAULT DML_COMMON.F_UNSPECIFIED_STRING,
                   p_data_origin ftvvent.ftvvent_data_origin%TYPE DEFAULT DML_COMMON.F_UNSPECIFIED_STRING,
                   p_rowid       VARCHAR2 DEFAULT NULL)

Update a record
@throws PK_NOT_FOUND Cannot find record using primary or unique key

Parameters
p_pidm   Personal identification number for the vendor.  Must exist on SATURN.SPRIDEN.
p_vtyp_code   Vendor type code.  Must exist on FTVVTYP.
p_user_id   USER IDENTIFICATION:  The unique identification code of the user.
p_rowid   Database rowid of record to update