OMBRETRIEVE FOLDER

Purpose

Retrieve details of the folder.

Prerequisites

Should be in the context of a module (Oracle, Non-Oracle, Aplications, Process Flow types) or folder.

Syntax

retrieveUserFolderCommand =  OMBRETRIEVE FOLDER "QUOTED_STRING" ( GET ( ( 
          "getContainedObjClause" | "propertiesClause" ) ) | 
          "getReferenceIconSetClause" )+
     getContainedObjClause =  CONTAINED_OBJECT "UNQUOTED_STRING"
     propertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveUserFolderCommand

This command retrieves the details of a folder.

QUOTED_STRING

Name of the existing folder.

getContainedObjClause

Retrieve the list of the folder's contained objects - all or by type.

propertiesClause

Retrieve a set of properties that is associated with a folder.

propertiesClause

Basic properties for FOLDER:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a Folder 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of a Folder

getReferenceIconSetClause

Retrieve the icon set referenced by this folder.

propertyNameList

Comma separated list of property names. Property names are unquoted.

See Also

OMBLIST