../E14406-01.epub /> ../E14406-01.mobi />

OMBALTER COLLECTION

Purpose

Alter the collection by adding, removing or modifying shortcuts.

Prerequisites

Should be in the context of a project, before altering a collection.

Syntax

alterCollectionCommand =  OMBALTER ( COLLECTION "QUOTED_STRING" ( [ 
          "renameClause" ] [ SET "setPropertiesClause" [ SET 
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] | 
          SET "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" 
          ] [ "alterCollectionReferences" ] ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterCollectionReferences =  ( "addReferenceClause" | 
          "removeReferenceClause" | "reconcileReferenceClause" )+
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addReferenceClause =  ADD REFERENCE TO "componentRefClause"
     removeReferenceClause =  REMOVE REFERENCE TO "componentRefClause"
     reconcileReferenceClause =  RECONCILE
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )
     componentRefClause =  ( "UNQUOTED_STRING" "QUOTED_STRING" )

Parameters

alterCollectionCommand

Alter a collection of objects.

QUOTED_STRING

Name of the existing collection in quotes.

renameClause

Rename a collection.

setPropertiesClause

Associate a set of properties with a collection.

propertiesClause

Basic properties for COLLECTION: 

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

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

setReferenceIconSetClause

Set icon set for the collection.

unsetReferenceIconSetClause

Unset icon set for the collection.

alterCollectionReferences

Alter the collections references, includes adding, dropping and reconciling the collection.

propertyNameList

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

propertyValueList

Comma separated list of property values.

addReferenceClause

Add a reference to the collection.

removeReferenceClause

Remove a reference from the collection.

reconcileReferenceClause

Reconcile the collection, deleting references which now refer to deleted objects.

propertyValue

Value of a property.

componentRefClause

Specify the type of the object to reference.