Package sb_athletic

Package sb_athletic_comments

This package provides the Common Business Interface for the Athletic Comments API (sb_athletic_comments).

General comments for an athlete may be entered, updated and deleted. These comments are associated with the athlete, regardless of the term and sport.

Program units

f_api_version	Returns the API version number.
f_exists	Checks 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

athletic_comments_rec	Business Entity record type
athletic_comments_ref	Entity cursor variable type
athletic_comments_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(17) := 'ATHLETIC_COMMENTS';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

athletic_comments_rec

TYPE athletic_comments_rec IS RECORD (
  r_pidm                    sgratct.sgratct_pidm%TYPE,
  r_seqno                   sgratct.sgratct_seqno%TYPE,
  r_cmtt_code               sgratct.sgratct_cmtt_code%TYPE,
  r_orig_code               sgratct.sgratct_orig_code%TYPE,
  r_user_id                 sgratct.sgratct_user_id%TYPE,
  r_comment_text            sgratct.sgratct_comment_text%TYPE,
  r_data_origin             sgratct.sgratct_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

athletic_comments_ref

TYPE athletic_comments_ref IS REF CURSOR RETURN athletic_comments_rec;

Entity cursor variable type

athletic_comments_tab

TYPE athletic_comments_tab IS TABLE OF athletic_comments_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_pidm  sgratct.sgratct_pidm%TYPE,
                  p_seqno sgratct.sgratct_seqno%TYPE DEFAULT NULL,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2;

Checks if a record exists.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the comments belong. NUMBER(8) Required Key
	p_seqno	Unique identifier of the comment for the PIDM. NUMBER(4) 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 athletic_comments_rec,
                   rec_two athletic_comments_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 athletic_comments_rec Required
	rec_two	The second record to compare. Type athletic_comments_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_pidm      sgratct.sgratct_pidm%TYPE DEFAULT NULL,
                     p_seqno     sgratct.sgratct_seqno%TYPE DEFAULT NULL,
                     p_cmtt_code sgratct.sgratct_cmtt_code%TYPE DEFAULT NULL,
                     p_orig_code sgratct.sgratct_orig_code%TYPE DEFAULT NULL)
  RETURN athletic_comments_ref;

Selects all records for the entity.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the comments belong. NUMBER(8) Required Key
	p_seqno	Unique identifier of the comment for the PIDM. NUMBER(4) Required Key
	p_cmtt_code	Code for the comment type. VARCHAR2(3) Required
	p_orig_code	Code for the originator of the comment. VARCHAR2(4) Required

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm  sgratct.sgratct_pidm%TYPE,
                     p_seqno sgratct.sgratct_seqno%TYPE)
  RETURN athletic_comments_ref;

Selects one record using the key.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the comments belong. NUMBER(8) Required Key
	p_seqno	Unique identifier of the comment for the PIDM. NUMBER(4) 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 athletic_comments_ref;

Selects one record using the 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_pidm  sgratct.sgratct_pidm%TYPE,
                          p_seqno sgratct.sgratct_seqno%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN athletic_comments_ref;

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the comments belong. NUMBER(8) Required Key
	p_seqno	Unique identifier of the comment for the PIDM. NUMBER(4) 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_pidm         sgratct.sgratct_pidm%TYPE,
                   p_seqno        sgratct.sgratct_seqno%TYPE,
                   p_cmtt_code    sgratct.sgratct_cmtt_code%TYPE,
                   p_orig_code    sgratct.sgratct_orig_code%TYPE,
                   p_user_id      sgratct.sgratct_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_comment_text sgratct.sgratct_comment_text%TYPE DEFAULT NULL,
                   p_data_origin  sgratct.sgratct_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out    OUT gb_common.internal_record_id_type);

Creates a record.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the comments belong. NUMBER(8) Required Key
	p_seqno	Unique identifier of the comment for the PIDM. NUMBER(4) Required Key
	p_cmtt_code	Code for the comment type. VARCHAR2(3) Required
	p_orig_code	Code for the originator of the comment. VARCHAR2(4) Required
	p_user_id	ID of the most recent user to create or update the row in the SGRATCT table. VARCHAR2(30) Required
	p_comment_text	Text of the comment. VARCHAR2(4000)
	p_data_origin	Value of the source system that inserted or updated the row. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_pidm  sgratct.sgratct_pidm%TYPE,
                   p_seqno sgratct.sgratct_seqno%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the comments belong. NUMBER(8) Required Key
	p_seqno	Unique identifier of the comment for the PIDM. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_pidm        sgratct.sgratct_pidm%TYPE,
                 p_seqno       sgratct.sgratct_seqno%TYPE,
                 p_rowid_inout IN OUT NOCOPY gb_common.internal_record_id_type);

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_pidm	Internal identification number (PIDM) of the athlete for which the comments belong. NUMBER(8) Required Key
	p_seqno	Unique identifier of the comment for the PIDM. NUMBER(4) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_pidm         sgratct.sgratct_pidm%TYPE,
                   p_seqno        sgratct.sgratct_seqno%TYPE,
                   p_cmtt_code    sgratct.sgratct_cmtt_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orig_code    sgratct.sgratct_orig_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id      sgratct.sgratct_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_comment_text sgratct.sgratct_comment_text%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin  sgratct.sgratct_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid        gb_common.internal_record_id_type DEFAULT NULL);

Updates a record.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the comments belong. NUMBER(8) Required Key
	p_seqno	Unique identifier of the comment for the PIDM. NUMBER(4) Required Key
	p_cmtt_code	Code for the comment type. VARCHAR2(3) Required
	p_orig_code	Code for the originator of the comment. VARCHAR2(4) Required
	p_user_id	ID of the most recent user to create or update the row in the SGRATCT table. VARCHAR2(30) Required
	p_comment_text	Text of the comment. VARCHAR2(4000)
	p_data_origin	Value of the source system that inserted or updated the row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)