Edit

Share via

Import Collection

  • Article

An import collection extends Collection and adds additional behaviors specific to import collections.

public class CdmImportCollection extends CdmCollection<CdmImport>

Constructors

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

Methods

Name Description Return Type SDK
Add(string, bool)
corpusPath: The corpus path to be set for the import.
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 import with the specified corpus path and adds it to the collection. Returns the import that was added to the collection. CdmImport 1.0
Add(string, string)
corpusPath: The corpus path to be set for the import.
moniker: The moniker to be set for the import.

append(...) in Python, push(...) in TypeScript.		 Creates an import with the specified corpus path and moniker and adds it to the collection. Returns the import that was added to the collection. CdmImport 1.0
AddRange(IEnumerable<CdmImport>)
importList: The list of imports to add.

addAll(...) in Java, extend(...) in Python, concat(...) in TypeScript.		 Adds the elements of the specified list of imports to the collection. void 1.0
Item(string, string, bool)
corpusPath: The corpus path for the import to fetch.
moniker [optional]: A nickname used for imports to specify which document to import in the case of duplicate symbols.
checkMoniker [optional]: A boolean that denotes whether to fetch the import by checking both the corpus name and moniker or only the corpus name. The default value is true.		 Returns the object with the specified corpus path and/or moniker. CdmImport 1.6