Edit

Purpose

  • Article

A purpose provides an attribute with what it does for an entity (for example, SortedBy or NamedBy).

public class CdmPurposeDefinition extends CdmObjectDefinitionBase

CdmPurposeDefinition extends CdmObjectDefinition in Python.

Constructors

Name Description
CdmPurposeDefinition(CdmCorpusContext, string, CdmPurposeReference)
ctx: The corpus context.
purposeName: The purpose's name.
extendsPurpose [optional]: The reference to the purpose extended by this purpose.		 Initializes a new instance of the CdmPurposeDefinition class.

Properties

Name Type Description
PurposeName string The purpose's name.
ExtendsPurpose CdmPurposeReference The reference to the purpose extended by this purpose.

Methods

Name Description Return Type
GetName() See CdmObjectDefinition.GetName(). string
IsDerivedFrom(string, ResolveOptions) See CdmObject.IsDerivedFrom(...). bool
Copy(ResolveOptions, CdmObject) See CdmObject.Copy(...). CdmObject
Validate() See CdmObject.Validate(). bool