com.tools20022.metamodel

Class MMSyntaxMessageScheme

java.lang.Object

com.tools20022.metamodel.MMSyntaxMessageScheme

All Implemented Interfaces:

GeneratedMetamodelBean, MMModelEntity, MMRepositoryConcept, MMTopLevelCatalogueEntry

public class MMSyntaxMessageScheme
extends Object
implements MMTopLevelCatalogueEntry

syntax processable notation used to define the structure of a MessageInstance in a particular syntax

Field Summary

Fields

Modifier and Type	Field and Description
static Metamodel.MetamodelAttribute<MMSyntaxMessageScheme,Optional<MMMessageDefinition>>	messageDefinitionTraceAttribute the MessageDefinitionTrace from the SyntaxMessageScheme to the MessageDefinition

Fields inherited from interface com.tools20022.metamodel.MMTopLevelCatalogueEntry

businessProcessCatalogueAttribute

Fields inherited from interface com.tools20022.metamodel.MMRepositoryConcept

checkNameFirstLetterUppercase, checkRemovalDateRegistrationStatus, constraintAttribute, definitionAttribute, docletAttribute, exampleAttribute, nameAttribute, registrationStatusAttribute, removalDateAttribute, semanticMarkupAttribute

Fields inherited from interface com.tools20022.metamodel.MMModelEntity

nextVersionsAttribute, objectIdentifierAttribute, previousVersionAttribute

Constructor Summary

Constructors

Constructor and Description
MMSyntaxMessageScheme()

Method Summary

Modifier and Type	Method and Description
MMBusinessProcessCatalogue	getBusinessProcessCatalogue() the BusinessProcessCatalogue that contains all ISO 20022 TopLevelCatalogueEntries
List<MMConstraint>	getConstraint() a property of a RepositoryConcept specifying a semantic condition or restriction expressed in natural language text and potentially in a formal notation
MMBusinessProcessCatalogue	getContainer()
Optional<String>	getDefinition() describes the semantic meaning of a RepositoryConcept
List<MMDoclet>	getDoclet() Doclets of the entity, used for documentation.
List<String>	getExample() provides a representative instance of a RepositoryConcept
Optional<MMMessageDefinition>	getMessageDefinitionTrace() the MessageDefinitionTrace from the SyntaxMessageScheme to the MessageDefinition
Metamodel.MetamodelType<? extends MMSyntaxMessageScheme>	getMetamodel()
String	getName() a word or set of words by which a RepositoryConcept is known, addressed or referred to
List<MMModelEntity>	getNextVersions() List of next versions of a ModelEntity that stem from this ModelEntity.
Optional<String>	getObjectIdentifier() Uniquely identifies the RepositoryConcept
Optional<MMModelEntity>	getPreviousVersion() Previous version of a ModelEntity that this ModelEntity stems from.
MMRegistrationStatus	getRegistrationStatus() specifies in which stage of the registration lifecycle a RepositoryConcept is in
Optional<Date>	getRemovalDate() specifies the date at which a RepositoryConcept will cease or has ceased to be part of the Repository
List<MMSemanticMarkup>	getSemanticMarkup() Enables modelers to markup elements of the Repository with semantic metadata.
static Metamodel.MetamodelType<? extends MMSyntaxMessageScheme>	metaType()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

messageDefinitionTraceAttribute

public static final Metamodel.MetamodelAttribute<MMSyntaxMessageScheme,Optional<MMMessageDefinition>> messageDefinitionTraceAttribute

the MessageDefinitionTrace from the SyntaxMessageScheme to the MessageDefinition

Constructor Detail

MMSyntaxMessageScheme

public MMSyntaxMessageScheme()

Method Detail

getContainer

public MMBusinessProcessCatalogue getContainer()

Specified by:

getContainer in interface GeneratedMetamodelBean

getMetamodel

public Metamodel.MetamodelType<? extends MMSyntaxMessageScheme> getMetamodel()

Specified by:

getMetamodel in interface GeneratedMetamodelBean

metaType

public static Metamodel.MetamodelType<? extends MMSyntaxMessageScheme> metaType()

Specified by:

metaType in interface MMModelEntity

Specified by:

metaType in interface MMRepositoryConcept

Specified by:

metaType in interface MMTopLevelCatalogueEntry

getMessageDefinitionTrace

public Optional<MMMessageDefinition> getMessageDefinitionTrace()

the MessageDefinitionTrace from the SyntaxMessageScheme to the MessageDefinition

See Also:

MMMessageDefinition.getDerivation()

getBusinessProcessCatalogue

public MMBusinessProcessCatalogue getBusinessProcessCatalogue()

Description copied from interface: MMTopLevelCatalogueEntry

the BusinessProcessCatalogue that contains all ISO 20022 TopLevelCatalogueEntries

Specified by:

getBusinessProcessCatalogue in interface MMTopLevelCatalogueEntry

See Also:

MMBusinessProcessCatalogue.getTopLevelCatalogueEntry()

getName

public String getName()

Description copied from interface: MMRepositoryConcept

a word or set of words by which a RepositoryConcept is known, addressed or referred to

Specified by:

getName in interface MMRepositoryConcept

getDefinition

public Optional<String> getDefinition()

Description copied from interface: MMRepositoryConcept

describes the semantic meaning of a RepositoryConcept

Specified by:

getDefinition in interface MMRepositoryConcept

getSemanticMarkup

public List<MMSemanticMarkup> getSemanticMarkup()

Description copied from interface: MMRepositoryConcept

Enables modelers to markup elements of the Repository with semantic metadata.

Specified by:

getSemanticMarkup in interface MMRepositoryConcept

getDoclet

public List<MMDoclet> getDoclet()

Description copied from interface: MMRepositoryConcept

Doclets of the entity, used for documentation.

Specified by:

getDoclet in interface MMRepositoryConcept

getExample

public List<String> getExample()

Description copied from interface: MMRepositoryConcept

provides a representative instance of a RepositoryConcept

Specified by:

getExample in interface MMRepositoryConcept

getConstraint

public List<MMConstraint> getConstraint()

Description copied from interface: MMRepositoryConcept

a property of a RepositoryConcept specifying a semantic condition or restriction expressed in natural language text and potentially in a formal notation

Specified by:

getConstraint in interface MMRepositoryConcept

See Also:

MMConstraint.getOwner()

getRegistrationStatus

public MMRegistrationStatus getRegistrationStatus()

Description copied from interface: MMRepositoryConcept

specifies in which stage of the registration lifecycle a RepositoryConcept is in

Specified by:

getRegistrationStatus in interface MMRepositoryConcept

getRemovalDate

public Optional<Date> getRemovalDate()

Description copied from interface: MMRepositoryConcept

specifies the date at which a RepositoryConcept will cease or has ceased to be part of the Repository

Specified by:

getRemovalDate in interface MMRepositoryConcept

getNextVersions

public List<MMModelEntity> getNextVersions()

Description copied from interface: MMModelEntity

List of next versions of a ModelEntity that stem from this ModelEntity. Allows version control management.

Specified by:

getNextVersions in interface MMModelEntity

See Also:

MMModelEntity.getPreviousVersion()

getPreviousVersion

public Optional<MMModelEntity> getPreviousVersion()

Description copied from interface: MMModelEntity

Previous version of a ModelEntity that this ModelEntity stems from. Allows version control management.

Specified by:

getPreviousVersion in interface MMModelEntity

See Also:

MMModelEntity.getNextVersions()

getObjectIdentifier

public Optional<String> getObjectIdentifier()

Description copied from interface: MMModelEntity

Uniquely identifies the RepositoryConcept

Specified by:

getObjectIdentifier in interface MMModelEntity