Package BANINST1.fb

Package BANINST1.fb_ship

Common Business interface for ship (FB_SHIP).

Program units

f_current_version	Returns the current version number.
f_exists	Checks to see if a purchase order header record exists.
f_exists_active	Checks to see if an active ship record exists.
f_query_all	Selects all ship records.
f_query_one	Selects one record using unique columns.
p_lock	Locks a ship record for update.
p_delete	Deletes a ship record.
p_create	Creates a ship record.
p_update	Updates a ship record.

Types

ship_rec	Ship record type
ship_ref	Ship reference cursor
ship_tab	Ship table type

ship_rec

TYPE ship_rec IS RECORD (
   code                       FTVSHIP.FTVSHIP_CODE%TYPE,
   eff_date                   FTVSHIP.FTVSHIP_EFF_DATE%TYPE,
   activity_date              FTVSHIP.FTVSHIP_ACTIVITY_DATE%TYPE,
   user_id                    FTVSHIP.FTVSHIP_USER_ID%TYPE,
   nchg_date                  FTVSHIP.FTVSHIP_NCHG_DATE%TYPE,
   term_date                  FTVSHIP.FTVSHIP_TERM_DATE%TYPE,
   addr_line1                 FTVSHIP.FTVSHIP_ADDR_LINE1%TYPE,
   addr_line2                 FTVSHIP.FTVSHIP_ADDR_LINE2%TYPE,
   building                   FTVSHIP.FTVSHIP_BUILDING%TYPE,
   floor                      FTVSHIP.FTVSHIP_FLOOR%TYPE,
   city                       FTVSHIP.FTVSHIP_CITY%TYPE,
   state                      FTVSHIP.FTVSHIP_STATE%TYPE,
   zip_code                   FTVSHIP.FTVSHIP_ZIP_CODE%TYPE,
   contact                    FTVSHIP.FTVSHIP_CONTACT%TYPE,
   phone_area                 FTVSHIP.FTVSHIP_PHONE_AREA%TYPE,
   phone_num                  FTVSHIP.FTVSHIP_PHONE_NUM%TYPE,
   phone_ext                  FTVSHIP.FTVSHIP_PHONE_EXT%TYPE,
   coas_code                  FTVSHIP.FTVSHIP_COAS_CODE%TYPE,
   orgn_code                  FTVSHIP.FTVSHIP_ORGN_CODE%TYPE,
   route_code                 FTVSHIP.FTVSHIP_ROUTE_CODE%TYPE,
   tgrp_code                  FTVSHIP.FTVSHIP_TGRP_CODE%TYPE,
   fund_code_invtry           FTVSHIP.FTVSHIP_FUND_CODE_INVTRY%TYPE,
   acct_code_invtry           FTVSHIP.FTVSHIP_ACCT_CODE_INVTRY%TYPE,
   orgn_code_ware             FTVSHIP.FTVSHIP_ORGN_CODE_WARE%TYPE,
   profit_center_ind          FTVSHIP.FTVSHIP_PROFIT_CENTER_IND%TYPE,
   locn_type_code             FTVSHIP.FTVSHIP_LOCN_TYPE_CODE%TYPE,
   delivery_point             FTVSHIP.FTVSHIP_DELIVERY_POINT%TYPE,
   correction_digit           FTVSHIP.FTVSHIP_CORRECTION_DIGIT%TYPE,
   carrier_route              FTVSHIP.FTVSHIP_CARRIER_ROUTE%TYPE,
   prog_code_ware             FTVSHIP.FTVSHIP_PROG_CODE_WARE%TYPE,
   addr_line3                 FTVSHIP.FTVSHIP_ADDR_LINE3%TYPE,
   natn_code                  FTVSHIP.FTVSHIP_NATN_CODE%TYPE,
   ctry_code_phone            FTVSHIP.FTVSHIP_CTRY_CODE_PHONE%TYPE,
   house_number               FTVSHIP.FTVSHIP_HOUSE_NUMBER%TYPE,
   addr_line4                 FTVSHIP.FTVSHIP_ADDR_LINE4%TYPE,
   internal_record_id         VARCHAR2(18));

Ship record type

ship_ref

TYPE ship_ref IS REF CURSOR RETURN SHIP_REC;

Ship reference cursor

ship_tab

TYPE ship_tab IS TABLE OF SHIP_REC INDEX BY BINARY_INTEGER;

Ship table type

f_current_version

Function f_current_version RETURN VARCHAR2

Returns the current version number.

Returns

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

f_exists

Function f_exists(p_code     FTVSHIP.FTVSHIP_CODE%TYPE,
                  p_eff_date FTVSHIP.FTVSHIP_EFF_DATE%TYPE DEFAULT SYSDATE)
  RETURN BOOLEAN

Checks to see if a purchase order header record exists.

Parameters

	p_code	The ship code. VARCHAR2(8) Required.
	p_eff_date	The effective date. Date

Returns

TRUE if found, otherwise FALSE.

f_exists_active

Function f_exists_active(p_code     FTVSHIP.FTVSHIP_CODE%TYPE,
                         p_eff_date FTVSHIP.FTVSHIP_EFF_DATE%TYPE DEFAULT SYSDATE)
  RETURN BOOLEAN

Checks to see if an active ship record exists.

Parameters

	p_code	The ship code. VARCHAR2(6) Required.
	p_eff_date	The effective date. Date.

Returns

TRUE if found, otherwise FALSE.

f_query_all

Function f_query_all(p_eff_date FTVSHIP.FTVSHIP_EFF_DATE%TYPE DEFAULT SYSDATE)
  RETURN ship_ref

Selects all ship records.

Parameters

p_eff_date

The effective date. Date.

Returns

a cursor variable that will fetch the set of records.

f_query_one

Function f_query_one(p_code     FTVSHIP.FTVSHIP_CODE%TYPE,
                     p_eff_date FTVSHIP.FTVSHIP_EFF_DATE%TYPE DEFAULT SYSDATE)
  RETURN ship_ref

Selects one record using unique columns.

Parameters

	p_code	The ship code. VARCHAR2(6) Required.
	p_eff_date	The effective date. Date.

Returns

a cursor variable that will fetch exactly one record.

p_lock

Procedure p_lock(p_code     FTVSHIP.FTVSHIP_CODE%TYPE,
                 p_eff_date FTVSHIP.FTVSHIP_EFF_DATE%TYPE,
                 p_rowid    VARCHAR2 DEFAULT NULL)

Locks a ship record for update.

Parameters

	p_code	The ship code. VARCHAR2(8) Required.
	p_eff_date	The effective date. Date Required.
	p_rowid	Rowid of the ship recocrd. VARCHAR2.

p_delete

Procedure p_delete(p_code     FTVSHIP.FTVSHIP_CODE%TYPE,
                   p_eff_date FTVSHIP.FTVSHIP_EFF_DATE%TYPE,
                   p_rowid    VARCHAR2 DEFAULT NULL)

Deletes a ship record.

Parameters

	p_code	The ship code. VARCHAR2(8) Required.
	p_eff_date	The effective date. Date Required.
	p_rowid	Rowid of the shipr recocrd. VARCHAR2.

p_create

Procedure p_create(p_code              FTVSHIP.FTVSHIP_CODE%TYPE,
                   p_eff_date          FTVSHIP.FTVSHIP_EFF_DATE%TYPE,
                   p_activity_date     FTVSHIP.FTVSHIP_ACTIVITY_DATE%TYPE,
                   p_user_id           FTVSHIP.FTVSHIP_USER_ID%TYPE,
                   p_nchg_date         FTVSHIP.FTVSHIP_NCHG_DATE%TYPE,
                   p_term_date         FTVSHIP.FTVSHIP_TERM_DATE%TYPE,
                   p_addr_line1        FTVSHIP.FTVSHIP_ADDR_LINE1%TYPE,
                   p_addr_line2        FTVSHIP.FTVSHIP_ADDR_LINE2%TYPE,
                   p_building          FTVSHIP.FTVSHIP_BUILDING%TYPE,
                   p_floor             FTVSHIP.FTVSHIP_FLOOR%TYPE,
                   p_city              FTVSHIP.FTVSHIP_CITY%TYPE,
                   p_state             FTVSHIP.FTVSHIP_STATE%TYPE,
                   p_zip_code          FTVSHIP.FTVSHIP_ZIP_CODE%TYPE,
                   p_contact           FTVSHIP.FTVSHIP_CONTACT%TYPE,
                   p_phone_area        FTVSHIP.FTVSHIP_PHONE_AREA%TYPE,
                   p_phone_num         FTVSHIP.FTVSHIP_PHONE_NUM%TYPE,
                   p_phone_ext         FTVSHIP.FTVSHIP_PHONE_EXT%TYPE,
                   p_coas_code         FTVSHIP.FTVSHIP_COAS_CODE%TYPE,
                   p_orgn_code         FTVSHIP.FTVSHIP_ORGN_CODE%TYPE,
                   p_route_code        FTVSHIP.FTVSHIP_ROUTE_CODE%TYPE,
                   p_tgrp_code         FTVSHIP.FTVSHIP_TGRP_CODE%TYPE,
                   p_fund_code_invtry  FTVSHIP.FTVSHIP_FUND_CODE_INVTRY%TYPE,
                   p_acct_code_invtry  FTVSHIP.FTVSHIP_ACCT_CODE_INVTRY%TYPE,
                   p_orgn_code_ware    FTVSHIP.FTVSHIP_ORGN_CODE_WARE%TYPE,
                   p_profit_center_ind FTVSHIP.FTVSHIP_PROFIT_CENTER_IND%TYPE,
                   p_locn_type_code    FTVSHIP.FTVSHIP_LOCN_TYPE_CODE%TYPE,
                   p_delivery_point    FTVSHIP.FTVSHIP_DELIVERY_POINT%TYPE,
                   p_correction_digit  FTVSHIP.FTVSHIP_CORRECTION_DIGIT%TYPE,
                   p_carrier_route     FTVSHIP.FTVSHIP_CARRIER_ROUTE%TYPE,
                   p_prog_code_ware    FTVSHIP.FTVSHIP_PROG_CODE_WARE%TYPE,
                   p_addr_line3        FTVSHIP.FTVSHIP_ADDR_LINE3%TYPE,
                   p_natn_code         FTVSHIP.FTVSHIP_NATN_CODE%TYPE,
                   p_ctry_code_phone   FTVSHIP.FTVSHIP_CTRY_CODE_PHONE%TYPE,
                   p_house_number      FTVSHIP.FTVSHIP_HOUSE_NUMBER%TYPE,
                   p_addr_line4        FTVSHIP.FTVSHIP_ADDR_LINE4%TYPE,
                   p_rowid             OUT VARCHAR2)

Creates a ship record.

p_update

Procedure p_update(p_code              FTVSHIP.FTVSHIP_CODE%TYPE,
                   p_eff_date          FTVSHIP.FTVSHIP_EFF_DATE%TYPE,
                   p_activity_date     FTVSHIP.FTVSHIP_ACTIVITY_DATE%TYPE,
                   p_user_id           FTVSHIP.FTVSHIP_USER_ID%TYPE,
                   p_nchg_date         FTVSHIP.FTVSHIP_NCHG_DATE%TYPE,
                   p_term_date         FTVSHIP.FTVSHIP_TERM_DATE%TYPE,
                   p_addr_line1        FTVSHIP.FTVSHIP_ADDR_LINE1%TYPE,
                   p_addr_line2        FTVSHIP.FTVSHIP_ADDR_LINE2%TYPE,
                   p_building          FTVSHIP.FTVSHIP_BUILDING%TYPE,
                   p_floor             FTVSHIP.FTVSHIP_FLOOR%TYPE,
                   p_city              FTVSHIP.FTVSHIP_CITY%TYPE,
                   p_state             FTVSHIP.FTVSHIP_STATE%TYPE,
                   p_zip_code          FTVSHIP.FTVSHIP_ZIP_CODE%TYPE,
                   p_contact           FTVSHIP.FTVSHIP_CONTACT%TYPE,
                   p_phone_area        FTVSHIP.FTVSHIP_PHONE_AREA%TYPE,
                   p_phone_num         FTVSHIP.FTVSHIP_PHONE_NUM%TYPE,
                   p_phone_ext         FTVSHIP.FTVSHIP_PHONE_EXT%TYPE,
                   p_coas_code         FTVSHIP.FTVSHIP_COAS_CODE%TYPE,
                   p_orgn_code         FTVSHIP.FTVSHIP_ORGN_CODE%TYPE,
                   p_route_code        FTVSHIP.FTVSHIP_ROUTE_CODE%TYPE,
                   p_tgrp_code         FTVSHIP.FTVSHIP_TGRP_CODE%TYPE,
                   p_fund_code_invtry  FTVSHIP.FTVSHIP_FUND_CODE_INVTRY%TYPE,
                   p_acct_code_invtry  FTVSHIP.FTVSHIP_ACCT_CODE_INVTRY%TYPE,
                   p_orgn_code_ware    FTVSHIP.FTVSHIP_ORGN_CODE_WARE%TYPE,
                   p_profit_center_ind FTVSHIP.FTVSHIP_PROFIT_CENTER_IND%TYPE,
                   p_locn_type_code    FTVSHIP.FTVSHIP_LOCN_TYPE_CODE%TYPE,
                   p_delivery_point    FTVSHIP.FTVSHIP_DELIVERY_POINT%TYPE,
                   p_correction_digit  FTVSHIP.FTVSHIP_CORRECTION_DIGIT%TYPE,
                   p_carrier_route     FTVSHIP.FTVSHIP_CARRIER_ROUTE%TYPE,
                   p_prog_code_ware    FTVSHIP.FTVSHIP_PROG_CODE_WARE%TYPE,
                   p_addr_line3        FTVSHIP.FTVSHIP_ADDR_LINE3%TYPE,
                   p_natn_code         FTVSHIP.FTVSHIP_NATN_CODE%TYPE,
                   p_ctry_code_phone   FTVSHIP.FTVSHIP_CTRY_CODE_PHONE%TYPE,
                   p_house_number      FTVSHIP.FTVSHIP_HOUSE_NUMBER%TYPE,
                   p_addr_line4        FTVSHIP.FTVSHIP_ADDR_LINE4%TYPE,
                   p_rowid             VARCHAR2 DEFAULT NULL)

Updates a ship record.