Element Type Definition: PLSQL

Oracle Designer Model, Release 6i
Element Type Definition

Element Type Name	PLSQL_MODULE
Short Name	PLM
View Name	CI_PLSQL_MODULES
Description	A sub-type of MODULE representing, as its name suggests, all modules
	written in PL/SQL, ie PL/SQL packages, procedures, functions etc.

Sub-type of	MODULE
Versioning:	Structure of PLSQL_MODULE versionable object
Versioning:	Type Bodies (only) belong to: ORACLE_OBJECT_TYPE versionable object
Rules:	API Spec Uniqueness Criteria Deletion Rules
Descriptor:	SHORT_NAME
Used by:	Oracle Designer
Underlying table:	SDD_MOD
Changes:	Summary of changes to PLSQL_MODULE in Release 6i

Reference Properties
Name	Opt ?	Notes	Relationship	In Arc
JAVA_MODULE_REFERENCE	Y	Prompt: Java Class Definition	May be the caller of one and only one JAVA_MODULE
ORACLE_OBJECT_TYPE_REFERENCE	Y	Prompt: Oracle Object Type	May be the member for one and only one ORACLE_OBJECT_TYPE
ORACLE_TYPE_REFERENCE	Y	Prompt: Return Type (Object)	May be of return type defined by one and only one ORACLE_TYPE

Properties
Name	Datatype	Opt ?	Notes	Domain	Default Value
ACTIVITY_CODE	VARCHAR2(10)	Y	The name or code of the activity that is to implement this module. Prompt: Activity Uppercase Defined on MOD supertype
CANDIDATE_FLAG	VARCHAR2(1)	N	Indicates whether or not this module is a candidate module Prompt: Candidate ? Uppercase Defined on MOD supertype	YESNO	N
COMPLETION_STATUS	VARCHAR2(12)	N	Indicates whether or not the build of this module is complete. Prompt: Status Uppercase Defined on MOD supertype	MODULE_COMPLETION	NOT STARTED
COMPLEXITY	VARCHAR2(10)	Y	An indication of the complexity of this module. Prompt: Complexity Uppercase Defined on MOD supertype	MOD_COMPLEXITY
ESTIMATE	NUMBER(8, 2)	Y	An estimate of the time needed to complete this module. Prompt: Time Estimate Uppercase Defined on MOD supertype
ESTIMATE_UNITS	VARCHAR2(10)	Y	The units of time in which the estimate is measured e.g. DAYS, HOURS. Prompt: Estimate Units Defined on MOD supertype	TIME_UNIT Non-enforced
FREE_FORMAT_TEXT_FLAG	VARCHAR2(1)	N	Y if the module declaration section is free format text Prompt: Free Format Declaration ? Uppercase	YESNO	N
IMPLEMENTATION_NAME	VARCHAR2(30)	Y	Name used on implementation, not required to be unique to cater for overloading when different arguments are used Prompt: Implementation Name
JAVA_METHOD	VARCHAR2(4000)	Y	Name of the Java method to be called. If JAVA_MODULE_REFERENCE populated then this property identifies method within that class, if not populated then method can be fully qualified (ie including class) here Prompt: Java Method	APICONVERT_VARCHAR2(4000)
JAVA_PARAMETER_LIST	VARCHAR2(4000)	Y	Parameter list for method identified in JAVA_METHOD. The mapping to PL/SQL arguments is by their position in the list Prompt: Java Parameter List	APICONVERT_VARCHAR2(4000)
JAVA_RETURN_TYPE	VARCHAR2(4000)	Y	Java class return type Prompt: Java Return Type	APICONVERT_VARCHAR2(4000)
MODULE_TYPE	VARCHAR2(3)	N	Sub-type discriminator. Internal property indicating whether the MODULE is a PLSQL_MODULE (PLM) or a GENERAL_MODULE (GEM) Not displayed Uppercase System maintained Not updatable by user Defined on MOD supertype	MODULE_SUBTYPE
NAME	VARCHAR2(40)	N	The name of this module. Prompt: Name Uppercase System maintained: API provides a value only if left null by the user Defined on MOD supertype
PLSQL_MODULE_TYPE	VARCHAR2(10)	Y	The PL/SQL module type (eg FUNCTION, PACKAGE etc) Prompt: Type Uppercase	PLSQL_MOD_TYPE
PROJECT_CODE	VARCHAR2(12)	Y	The name or code of the project that contains this module. Prompt: Project Uppercase Defined on MOD supertype
PURPOSE	VARCHAR2(70)	N	The purpose of this module. Prompt: Purpose Defined on MOD supertype
REPEATABLE_FLAG	VARCHAR2(1)	N	Indicates whether the DETERMINISTIC option is set Prompt: Deterministic ? Uppercase	YESNO	N
RETURN_TYPE	VARCHAR2(70)	Y	The datatype of the value returned by this module. Prompt: Return Type (Scalar)	PLS_DATATYPE Non-enforced
RNDS_FLAG	VARCHAR2(1)	N	Specifies whether 'reads no database state' constraint (ie does not query database tables) required Prompt: RNDS ? Uppercase	YESNODEF	D
RNPS_FLAG	VARCHAR2(1)	N	Specifies whether 'reads no package state' constraint (ie does not query packaged variables required Prompt: RNPS ? Uppercase	YESNODEF	D
SCOPE	VARCHAR2(20)	N	Scope for the module. (PUBLIC or PRIVATE). Prompt: Scope Uppercase	MOD_SCOPE	PRIVATE
SHORT_NAME	VARCHAR2(20)	N	The short name of this module. Prompt: Short Name Uppercase Defined on MOD supertype
SIZE_OF_MODULE	NUMBER(6, 0)	Y	The estimated size of this module. Prompt: Size Defined on MOD supertype
SOURCE_PATHNAME	VARCHAR2(132)	Y	The full name of the file that contains the source code for this module. Prompt: Source Path
TASK_CODE	VARCHAR2(10)	Y	The name or code of the task that is to implement this module. Prompt: Task Uppercase Defined on MOD supertype
TOP_LEVEL_FLAG	VARCHAR2(1)	N	Used to 'top level' modules from those that can only be executed in the context of another module, via a MODULE_NETWORK. Orininally required for Module Dictionary support. Information only, not used by the generators Prompt: Top Level ? Uppercase Defined on MOD supertype	YESNO	N
TYPE_MEMBER_ORDERING	VARCHAR2(5)	Y	Indicates whether a MAP or an ORDER member function Prompt: Type Member Ordering Uppercase	TYPE_MEMBER_ORDERING
WNDS_FLAG	VARCHAR2(1)	N	Specifies whether 'writes no database state' constraint (ie does not modify database tables) required Prompt: WNDS ? Uppercase	YESNODEF	D
WNPS_FLAG	VARCHAR2(1)	N	Specifies whether 'writes no package state' constraint (ie does not modify packaged variables) required Prompt: WNPS ? Uppercase	YESNODEF	D
PARENT_IVID	NUMBER(38, 0)	Y	Internal property, applicable to type body PLSQL_MODULES only. The IVID of the parent ORACLE_OBJECT_TYPE Not displayed System maintained Updatable only if null Defined on MOD supertype
PAC_REFERENCE	NUMBER(38, 0)	Y	Internal property, applicable to type body PLSQL_MODULES only. The IRID of the parent ORACLE_OBJECT_TYPE Not displayed System maintained Not updatable by user Defined on MOD supertype

Multi-line Text
Name	Text Type	Prompt
DESCRIPTION	CDIDSC Defined on MOD supertype	Description
NOTES	CDINOT Defined on MOD supertype	Notes
PACKAGE_SPECIFICATION	CDISPC	Package Specification
PLSQL	CDIPLS	PL/SQL Block
PRIVATE_DECLARATION	PLSDEC	Private Declaration
RELEASE_NOTES	CDRNOT Defined on MOD supertype	Release Notes

Other Properties
PLSQL_MODULE has the 20 user definable properties (USER_DEFINED_PROPERTY_0, _1, _2, _3 etc) for User Extensibility
The following 'standard' properties are also inherited by all element types: ID IRID IVID ELEMENT_TYPE_NAME DATE_CREATED CREATED_BY DATE_CHANGED CHANGED_BY NUMBER_OF_TIMES_MODIFIED TYPES

Other element types that reference PLSQL_MODULE:

Each SYSTEM_OBJECTIVE_OF_MODULE must be a use for one and only one MODULE
Each DISTRIBUTED_PROCESSING must be a use for one and only one MODULE
Each MODULE_ASSUMPTION must be a use for one and only one MODULE
Each PROBLEM_TO_MODULE must be a use for one and only one MODULE
Each FOLDER_MEMBER must be of one and only one FOLDERED_ELEMENT
Each MODULE_ARGUMENT must be within one and only one PLSQL_MODULE (in arc)
Each DATASTRUCTURE must be owned and used by one and only one PLSQL_MODULE
Each DIAGRAM_ELEMENT_USAGE must be for one and only one CIELEMENT (in arc)
Each DOCUMENT_ATTACHMENT must be from one and only one ACCESS_CONTROLLED_ELEMENT (in arc)
Each DATABASE_SYNONYM must be for one and only one PLSQL_MODULE (in arc)
Each DATASTRUCTURE_ITEM may be defined by one and only one PLSQL_MODULE (in arc)
Each DATASTRUCTURE_ITEM may be for plsql module of one and only one PLSQL_MODULE
Each CHANGE_HISTORY must be for one and only one MODULE
Each MODULE_BUSINESS_UNIT must be for one and only one MODULE
Each MODULE_FUNCTION must be for one and only one MODULE
Each MODULE_NETWORK must be for one and only one MODULE
Each MODULE_NETWORK must be of one and only one MODULE
Each MODULE_PROGRAM_DATUM must be for one and only one PLSQL_MODULE (in arc)
Each PROGRAM_DATUM must be owned by one and only one PLSQL_MODULE (in arc)
Each PLSQL_MOD_IMPLEMENTATION must be an implementation of one and only one PLSQL_MODULE
Each SET_MEMBER_ITEM must be of one and only one PRIMARY_ACCESS_ELEMENT (in arc)
Each SERVER_OBJECT_USAGE must be for generation of one and only one CIELEMENT (in arc)
Each DATABASE_TRIGGER must be logically defined in one and only one PLSQL_MODULE
Each EXTENDED_STRUCTURE_ELEMENT must be part of one and only one ACCESS_CONTROLLED_ELEMENT (in arc)
Each EXTENDED_STRUCTURE_ELEMENT must be use of one and only one ACCESS_CONTROLLED_ELEMENT

Note:

All properties are displayed and updatable by the user unless indicated otherwise

All reference properties are displayed and transferable unless indicated otherwise

All domains are enforced unless indicated otherwise

All properties and reference properties are defined on this element type unless indicated as inherited from a supertype