OMBCREATE PLSQL_REF_CURSOR_TYPE

Purpose

To create a PLSQL Ref-Cursor Type.

Prerequisites

Should be in the context of a Package.

Syntax

createPlSqlRefCursorTypeCommand =  OMBCREATE ( PLSQL_REF_CURSOR_TYPE 
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET ( REF | REFERENCE 
          ) "setReferenceIconSetClause" ] | ( REF | REFERENCE ) 
          "setReferenceIconSetClause" ) ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

createPlSqlRefCursorTypeCommand

Creates a PL/SQL Ref-Cursor Type with the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Ref-Cursor Type Valid properties are shown below:

getPropertiesClause

Basic properties for PLSQL_REF_CURSOR_TYPE: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Ref-Cursor Type

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Ref-Cursor Type

Name: RETURN_TYPE
Type: STRING(20)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Return type of the Ref-Cursor Type. This should be a PLSQL Record Type.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

PLSQL_REF_CURSOR_TYPE Object

Table 8-67 PLSQL_REF_CURSOR_TYPE Object

Property	Type	Choices	Min	Max	Default	Description
GENERATION_COMMENTS	STRING	none	none	none	empty string	Enter additional comments for the generated code.

PLSQL_REF_CURSOR_TYPE Object

Table 8-68 PLSQL_REF_CURSOR_TYPE Object

Property	Type	Choices	Min	Max	Default	Description
GENERATION_COMMENTS	STRING	none	none	none	empty string	Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER PLSQL_REF_CURSOR_TYPE

OMBDROP PLSQL_REF_CURSOR_TYPE