de.iip_ecosphere.platform.support.iip_aas

Interface AasContributor

All Known Implementing Classes:

NetworkManagerAas, PlatformAas

public interface AasContributor

Service interface to contribute to an AAS. Platform components with individual AAS shall implement this interface and contribute to the AasPartRegistry.

Author:

Holger Eichelberger, SSE

See Also:

ExcludeFirst

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AasContributor.Kind The kind of AAS being built.

Method Summary

Modifier and Type	Method and Description
de.iip_ecosphere.platform.support.aas.Aas	contributeTo(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder, de.iip_ecosphere.platform.support.aas.InvocablesCreator iCreator) Contribute to the given aasBuilder.
void	contributeTo(de.iip_ecosphere.platform.support.aas.ProtocolServerBuilder sBuilder) Contributes the real implementation functions to the sBuilder.
AasContributor.Kind	getKind() Returns the kind of AAS being created.
boolean	isValid() Allow the AAS contributor to declare itself as invalid.

Method Detail

contributeTo

de.iip_ecosphere.platform.support.aas.Aas contributeTo(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder,
                                                       de.iip_ecosphere.platform.support.aas.InvocablesCreator iCreator)

Contribute to the given aasBuilder.

Parameters:

aasBuilder - the AAS to contribute to

iCreator - the invocables creator for binding (remote) property and operation implementations. Property and function namesshall be qualified by the AAS short id.

Returns:

the contributor may ignore aasBuilder and create an own AAS and return that. If this contributor just contributes to the aasBuilder the result shall be null

contributeTo

void contributeTo(de.iip_ecosphere.platform.support.aas.ProtocolServerBuilder sBuilder)

Contributes the real implementation functions to the sBuilder. Names used for the iCreator in #contributeTo(AasBuilder, InvocablesCreator) must be the same as used here. Property and function names shall be qualified by the AAS short id.

Parameters:

sBuilder - the server builder

getKind

AasContributor.Kind getKind()

Returns the kind of AAS being created. This is helpful for filtering.

Returns:

the kind of AAS

isValid

boolean isValid()

Allow the AAS contributor to declare itself as invalid.

Returns:

true as prerequisite to execute contributeTo(ProtocolServerBuilder) and #contributeTo(AasBuilder, InvocablesCreator), false else