Skip to main content

MGCLatticeDmfProjectSpecContract

One data project and its entity lines, as a specification file carries it.

Methods​

new​

Initializes a new instance of the MGCLatticeDmfProjectSpecContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeDmfProjectSpecContract class.

  • Visibility: public
  • Returns: MGCLatticeDmfProjectSpecContract A new instance.

No parameters.

parmName​

Gets or sets the data project's name, which is its key.

  • Visibility: public
  • Returns: str The project name.
NameTypeOptionalDescription
_namestrYesThe project name.

parmDescription​

Gets or sets the project description.

  • Visibility: public
  • Returns: str The description.
NameTypeOptionalDescription
_descriptionstrYesThe description.

parmOperationType​

Gets or sets whether the project imports or exports, as an element name.

  • Visibility: public
  • Returns: str The operation type name.
NameTypeOptionalDescription
_operationTypestrYesThe operation type name, for example Import.

operationTypeValue​

Gets the operation type as the enumeration the platform stores.

  • Visibility: public
  • Returns: DMFOperationType The operation type.

No parameters.

parmGenerateDataPackage​

Gets or sets whether an export writes a data package.

  • Visibility: public
  • Returns: boolean Whether a package is generated.
NameTypeOptionalDescription
_generateDataPackagebooleanYesWhether a package is generated.

parmTruncateEntityData​

Gets or sets whether an import empties the target before loading.

  • Visibility: public
  • Returns: boolean Whether the target is truncated.
NameTypeOptionalDescription
_truncateEntityDatabooleanYesWhether the target is truncated.

parmEntities​

Gets or sets the project's entity lines.

  • Visibility: public
  • Returns: List The lines.
NameTypeOptionalDescription
_entitiesListYesThe lines.

addEntity​

Adds an entity line to the project.

  • Visibility: public
  • Returns: void
NameTypeOptionalDescription
_entityMGCLatticeDmfProjectEntitySpecContractNoThe line.