index

Package nb_common

This package provides utility functions and procedures for the Banner HR APIs.
 

Various functions and procedures are located in this API.

Program units
f_api_version   Returns API version number.
f_concat_error_messages   Concatenates two delimited error messages.
f_concat_warning_messages   Concatenates two delimited warning messages.
f_max_date   Returns the date December 31, 9999 AD in a Oracle date format.
f_min_date   Returns the date January 1, 4712 BC in a Oracle date format.
f_prefaced_warning_message   Prefaces all strings within the warning message with the word Warning.
p_overlay   Overlays an existing value with an entered value only if the entered value is specified.
p_overlay   Overlays an existing value with an entered value only if the entered value is specified.
p_overlay   Overlays an existing value with an entered value only if the entered value is specified.

Constants
CONST_MIN_DATE  
CONST_MAX_DATE  

CONST_MIN_DATE 

CONST_MIN_DATE   CONSTANT DATE := TO_DATE(1,'J');

CONST_MAX_DATE 

CONST_MAX_DATE   CONSTANT DATE := TO_DATE(5373484,'J');

f_api_version 

Function f_api_version RETURN PLS_INTEGER

Returns API version number.

Returns
Version of the API signature.

f_concat_error_messages 

Function f_concat_error_messages(p_delim_error_msg_1 IN gb_common_strings.err_type,
                                 p_delim_error_msg_2 IN gb_common_strings.err_type)
  RETURN gb_common_strings.err_type

Concatenates two delimited error messages.

Returns
Concatenated delimited error messages.

f_concat_warning_messages 

Function f_concat_warning_messages(p_delim_warning_msg_1 IN gb_common_strings.err_type,
                                   p_delim_warning_msg_2 IN gb_common_strings.err_type)
  RETURN gb_common_strings.err_type

Concatenates two delimited warning messages.

Returns
Concatenated delimited warning messages.

f_max_date 

Function f_max_date RETURN DATE

Returns the date December 31, 9999 AD in a Oracle date format.

Returns
Date

f_min_date 

Function f_min_date RETURN DATE

Returns the date January 1, 4712 BC in a Oracle date format.

Returns
Date

f_prefaced_warning_message 

Function f_prefaced_warning_message(p_delim_warning_msg IN gb_common_strings.err_type)
  RETURN gb_common_strings.err_type

Prefaces all strings within the warning message with the word Warning.

Returns
Prefaced warning messages.

p_overlay 

Procedure p_overlay(p_existing_value_inout IN OUT VARCHAR2,
                    p_entered_value        IN VARCHAR2)

Overlays an existing value with an entered value only if the entered value is specified.

Parameters
p_overlay_value_inout   Existing value that may be overlaid.
p_entered_value   The value that will overlay the existing value.

p_overlay 

Procedure p_overlay(p_existing_value_inout IN OUT NUMBER,
                    p_entered_value        IN NUMBER)

Overlays an existing value with an entered value only if the entered value is specified. Overloaded for NUMBER fields.

Parameters
p_overlay_value_inout   Existing value that may be overlaid.
p_entered_value   The value that will overlay the existing value.

p_overlay 

Procedure p_overlay(p_existing_value_inout IN OUT DATE,
                    p_entered_value        IN DATE)

Overlays an existing value with an entered value only if the entered value is specified. Overloaded for DATE fields.

Parameters
p_overlay_value_inout   Existing value that may be overlaid.
p_entered_value   The value that will overlay the existing value.