index

Package sb_course_labor

This package provides the Common Business interface for the Course Labor Distribution API (sb_course_labor).

Program units
f_api_version  
f_exists  
f_isequal  
f_query_all  
f_query_one  
f_query_by_term  
f_query_by_rowid  
f_query_one_lock  
p_create  
p_delete  
p_lock  
p_update  

Types
course_labor_rec  
course_labor_ref  
course_labor_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(12) := 'COURSE_LABOR';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

course_labor_rec 

TYPE course_labor_rec IS RECORD (
  r_subj_code               scrclbd.scrclbd_subj_code%TYPE,
  r_crse_numb               scrclbd.scrclbd_crse_numb%TYPE,
  r_term_code_eff           scrclbd.scrclbd_term_code_eff%TYPE,
  r_seq_no                  scrclbd.scrclbd_seq_no%TYPE,
  r_percent                 scrclbd.scrclbd_percent%TYPE,
  r_user_id                 scrclbd.scrclbd_user_id%TYPE,
  r_data_origin             scrclbd.scrclbd_data_origin%TYPE,
  r_coas_code               scrclbd.scrclbd_coas_code%TYPE,
  r_acci_code               scrclbd.scrclbd_acci_code%TYPE,
  r_fund_code               scrclbd.scrclbd_fund_code%TYPE,
  r_orgn_code               scrclbd.scrclbd_orgn_code%TYPE,
  r_acct_code               scrclbd.scrclbd_acct_code%TYPE,
  r_prog_code               scrclbd.scrclbd_prog_code%TYPE,
  r_actv_code               scrclbd.scrclbd_actv_code%TYPE,
  r_locn_code               scrclbd.scrclbd_locn_code%TYPE,
  r_proj_code               scrclbd.scrclbd_proj_code%TYPE,
  r_ctyp_code               scrclbd.scrclbd_ctyp_code%TYPE,
  r_acct_external_cde       scrclbd.scrclbd_acct_external_cde%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

course_labor_ref 

TYPE course_labor_ref IS REF CURSOR RETURN course_labor_rec;

Entity cursor variable type

course_labor_tab 

TYPE course_labor_tab IS TABLE OF course_labor_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_subj_code     scrclbd.scrclbd_subj_code%TYPE,
                  p_crse_numb     scrclbd.scrclbd_crse_numb%TYPE,
                  p_term_code_eff scrclbd.scrclbd_term_code_eff%TYPE,
                  p_seq_no        scrclbd.scrclbd_seq_no%TYPE,
                  p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term code when the course becomes effective. VARCHAR2(6) Required Key
p_seq_no   Sequence number of the course labor distribution information. NUMBER(3) 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 course_labor_rec, rec_two course_labor_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 course_labor_rec Required
rec_two   The second record to compare. Type course_labor_rec Required

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

f_query_all 

Function f_query_all(p_subj_code     scrclbd.scrclbd_subj_code%TYPE,
                     p_crse_numb     scrclbd.scrclbd_crse_numb%TYPE,
                     p_term_code_eff scrclbd.scrclbd_term_code_eff%TYPE)
  RETURN course_labor_ref

Selects all records for the entity.

Parameters
p_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term code when the course becomes effective. VARCHAR2(6) Required Key

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

f_query_one 

Function f_query_one(p_subj_code     scrclbd.scrclbd_subj_code%TYPE,
                     p_crse_numb     scrclbd.scrclbd_crse_numb%TYPE,
                     p_term_code_eff scrclbd.scrclbd_term_code_eff%TYPE,
                     p_seq_no        scrclbd.scrclbd_seq_no%TYPE)
  RETURN course_labor_ref

Selects one record using key.

Parameters
p_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term code when the course becomes effective. VARCHAR2(6) Required Key
p_seq_no   Sequence number of the course labor distribution information. NUMBER(3) Required Key

Returns
A cursor variable that will fetch exactly one record.

f_query_by_term 

Function f_query_by_term(p_subj_code     scrclbd.scrclbd_subj_code%TYPE,
                         p_crse_numb     scrclbd.scrclbd_crse_numb%TYPE,
                         p_term_code_eff scrclbd.scrclbd_term_code_eff%TYPE)
  RETURN course_labor_ref

Selects the course labor distribution record current for the input effective term. This will always be the course labor distribution record with the maximum effective term that is less than or equal to the input effective term.

Parameters
p_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term this version of the course becomes effective. VARCHAR2(6) 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 course_labor_ref

Selects one record using 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_subj_code     scrclbd.scrclbd_subj_code%TYPE,
                          p_crse_numb     scrclbd.scrclbd_crse_numb%TYPE,
                          p_term_code_eff scrclbd.scrclbd_term_code_eff%TYPE,
                          p_seq_no        scrclbd.scrclbd_seq_no%TYPE,
                          p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN course_labor_ref

Selects one record and locks it.

Parameters
p_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term code when the course becomes effective. VARCHAR2(6) Required Key
p_seq_no   Sequence number of the course labor distribution information. NUMBER(3) 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_subj_code         scrclbd.scrclbd_subj_code%TYPE,
                   p_crse_numb         scrclbd.scrclbd_crse_numb%TYPE,
                   p_term_code_eff     scrclbd.scrclbd_term_code_eff%TYPE,
                   p_seq_no            scrclbd.scrclbd_seq_no%TYPE,
                   p_percent           scrclbd.scrclbd_percent%TYPE,
                   p_user_id           scrclbd.scrclbd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin       scrclbd.scrclbd_data_origin%TYPE DEFAULT NULL,
                   p_coas_code         scrclbd.scrclbd_coas_code%TYPE DEFAULT NULL,
                   p_acci_code         scrclbd.scrclbd_acci_code%TYPE DEFAULT NULL,
                   p_fund_code         scrclbd.scrclbd_fund_code%TYPE DEFAULT NULL,
                   p_orgn_code         scrclbd.scrclbd_orgn_code%TYPE DEFAULT NULL,
                   p_acct_code         scrclbd.scrclbd_acct_code%TYPE DEFAULT NULL,
                   p_prog_code         scrclbd.scrclbd_prog_code%TYPE DEFAULT NULL,
                   p_actv_code         scrclbd.scrclbd_actv_code%TYPE DEFAULT NULL,
                   p_locn_code         scrclbd.scrclbd_locn_code%TYPE DEFAULT NULL,
                   p_proj_code         scrclbd.scrclbd_proj_code%TYPE DEFAULT NULL,
                   p_ctyp_code         scrclbd.scrclbd_ctyp_code%TYPE DEFAULT NULL,
                   p_acct_external_cde scrclbd.scrclbd_acct_external_cde%TYPE DEFAULT NULL,
                   p_rowid_out         OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term code when the course becomes effective. VARCHAR2(6) Required Key
p_seq_no   Sequence number of the course labor distribution information. NUMBER(3) Required Key
p_percent   Percent of pay to be applied to this labor distribution. NUMBER(5,2) Required
p_user_id   The Oracle ID of the user who changed the record. VARCHAR2(30) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_coas_code   The primary identification code for a chart of accounts. Valued only if Banner Finance is installed. VARCHAR2(1)
p_acci_code   An index code used to default the account distribution to which the position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_fund_code   The fund code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_orgn_code   The organization to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_acct_code   The account code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_prog_code   The program code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_actv_code   The activity code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_locn_code   The location code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_proj_code   The project code within the Finance Cost Accounting Module. Valued only if Banner Finance is installed. VARCHAR2(8)
p_ctyp_code   The cost type within the Finance Cost Accounting Module. Valued only if Banner Finance is installed. VARCHAR2(2)
p_acct_external_cde   A free-form account code to allow updates to an accounting system other than Banner Finance. VARCHAR2(60)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_subj_code     scrclbd.scrclbd_subj_code%TYPE,
                   p_crse_numb     scrclbd.scrclbd_crse_numb%TYPE,
                   p_term_code_eff scrclbd.scrclbd_term_code_eff%TYPE,
                   p_seq_no        scrclbd.scrclbd_seq_no%TYPE,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term code when the course becomes effective. VARCHAR2(6) Required Key
p_seq_no   Sequence number of the course labor distribution information. NUMBER(3) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_subj_code     scrclbd.scrclbd_subj_code%TYPE,
                 p_crse_numb     scrclbd.scrclbd_crse_numb%TYPE,
                 p_term_code_eff scrclbd.scrclbd_term_code_eff%TYPE,
                 p_seq_no        scrclbd.scrclbd_seq_no%TYPE,
                 p_rowid_inout   IN OUT gb_common.internal_record_id_type)

Locks a record.
If 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_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term code when the course becomes effective. VARCHAR2(6) Required Key
p_seq_no   Sequence number of the course labor distribution information. NUMBER(3) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_subj_code         scrclbd.scrclbd_subj_code%TYPE,
                   p_crse_numb         scrclbd.scrclbd_crse_numb%TYPE,
                   p_term_code_eff     scrclbd.scrclbd_term_code_eff%TYPE,
                   p_seq_no            scrclbd.scrclbd_seq_no%TYPE,
                   p_percent           scrclbd.scrclbd_percent%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id           scrclbd.scrclbd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin       scrclbd.scrclbd_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coas_code         scrclbd.scrclbd_coas_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acci_code         scrclbd.scrclbd_acci_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fund_code         scrclbd.scrclbd_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orgn_code         scrclbd.scrclbd_orgn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acct_code         scrclbd.scrclbd_acct_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prog_code         scrclbd.scrclbd_prog_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_actv_code         scrclbd.scrclbd_actv_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_locn_code         scrclbd.scrclbd_locn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_proj_code         scrclbd.scrclbd_proj_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ctyp_code         scrclbd.scrclbd_ctyp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acct_external_cde scrclbd.scrclbd_acct_external_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid             gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_subj_code   The subject area of the course. VARCHAR2(4) Required Key
p_crse_numb   The course number associated with the subject for the course. VARCHAR2(5) Required Key
p_term_code_eff   The term code when the course becomes effective. VARCHAR2(6) Required Key
p_seq_no   Sequence number of the course labor distribution information. NUMBER(3) Required Key
p_percent   Percent of pay to be applied to this labor distribution. NUMBER(5,2) Required
p_user_id   The Oracle ID of the user who changed the record. VARCHAR2(30) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_coas_code   The primary identification code for a chart of accounts. Valued only if Banner Finance is installed. VARCHAR2(1)
p_acci_code   An index code used to default the account distribution to which the position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_fund_code   The fund code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_orgn_code   The organization to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_acct_code   The account code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_prog_code   The program code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_actv_code   The activity code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_locn_code   The location code to which a position should be charged. Valued only if Banner Finance is installed. VARCHAR2(6)
p_proj_code   The project code within the Finance Cost Accounting Module. Valued only if Banner Finance is installed. VARCHAR2(8)
p_ctyp_code   The cost type within the Finance Cost Accounting Module. Valued only if Banner Finance is installed. VARCHAR2(2)
p_acct_external_cde   A free-form account code to allow updates to an accounting system other than Banner Finance. VARCHAR2(60)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)