CdmObject Definition Collection

A CdmObject definition collection extends Collection and adds additional behaviors specific to CdmObject definition collections.

public class CdmDefinitionCollection extends CdmCollection<CdmObjectDefinition>

Constructors

Name Description
CdmDefinitionCollection(CdmCorpusContext, CdmDocumentDefinition)
ctx: The corpus context.
owner: The owner of this collection. Must be a document.
Initializes a new instance of the CdmDefinitionCollection class.

Methods

Name Description Return Type
Add(CdmObjectDefinition)
definition: The object definition to add to the collection.

append(...) in Python, push(...) in TypeScript.
Adds the specified object definition to the collection. Returns the object definition that was added to the collection. CdmObjectDefinition
Add(string, bool)
name: The name of the entity to add to the collection.
simpleRef [optional]: This parameter is unused. It's kept just for consistency with other Common Data Model collections.

append(...) in Python, push(...) in TypeScript.
Creates an entity with the specified name and adds it to the collection. Returns the entity that was added to the collection. CdmEntityDefinition
Add(CdmObjectType, string)
ofType: The type of the object to add to the collection.
name: The name of the object.

append(string, CdmObjectType) in Python, push(...) in TypeScript. In Python, the parameter order is reversed.
Creates an object definition of the specified type with the specified name and adds it to the collection. Returns the object definition that was added to the collection. CdmObjectDefinition