ParticipantRegistry (Client API)

Overview - Common API - Client API - Admin API - Runtime API

ParticipantRegistry

The ParticipantRegistry is used to manage a set of participants stored on the blockchain.

Details

  • Extends Registry

  • Module client

See also

  • See (see {@link registry)

Method Summary

Name Returns Description
addParticipantRegistry Promise Add a new participant registry.
constructor void Create an participant registry.

Note: Only to be called by framework code. Applications should retrieve instances from BusinessNetworkConnection

getAllParticipantRegistries Promise Get a list of all existing participant registries.
getParticipantRegistry Promise Get an existing participant registry.
participantRegistryExists Promise Determine whether a participant registry exists.

Method Details

getAllParticipantRegistries

Promise getAllParticipantRegistries( SecurityContext securitycontext, ModelManager modelmanager, Factory factory, Serializer serializer, BusinessNetworkConnection bnc, [Boolean includesystem] )

Get a list of all existing participant registries.

Returns

Promise - A promise that will be resolved with a list of ParticipantRegistry instances representing the participant registries.

Parameters

Name Type Optional Description
securityContext SecurityContext false The user's security context.
modelManager ModelManager false The ModelManager to use for this participant registry.
factory Factory false The factory to use for this participant registry.
serializer Serializer false The Serializer to use for this participant registry.
bnc BusinessNetworkConnection false BusinessNetworkConnection to use
includeSystem Boolean true Should system registries be included? (optional, default to false)

getParticipantRegistry

Promise getParticipantRegistry( SecurityContext securitycontext, string id, ModelManager modelmanager, Factory factory, Serializer serializer, BusinessNetworkConnection bnc )

Get an existing participant registry.

Returns

Promise - A promise that will be resolved with a ParticipantRegistry instance representing the participant registry.

Parameters

Name Type Optional Description
securityContext SecurityContext false The user's security context.
id string false The unique identifier of the participant registry.
modelManager ModelManager false The ModelManager to use for this participant registry.
factory Factory false The factory to use for this participant registry.
serializer Serializer false The Serializer to use for this participant registry.
bnc BusinessNetworkConnection false BusinessNetworkConnection to use

participantRegistryExists

Promise participantRegistryExists( SecurityContext securitycontext, string id, ModelManager modelmanager, Factory factory, Serializer serializer, BusinessNetworkConnection bnc )

Determine whether a participant registry exists.

Returns

Promise - A promise that will be resolved with a boolean indicating whether the asset registry exists

Parameters

Name Type Optional Description
securityContext SecurityContext false The user's security context.
id string false The unique identifier of the asset registry.
modelManager ModelManager false The ModelManager to use for this asset registry.
factory Factory false The factory to use for this asset registry.
serializer Serializer false The Serializer to use for this asset registry.
bnc BusinessNetworkConnection false BusinessNetworkConnection to use

addParticipantRegistry

Promise addParticipantRegistry( SecurityContext securitycontext, string id, string name, ModelManager modelmanager, Factory factory, Serializer serializer, BusinessNetworkConnection bnc )

Add a new participant registry.

Returns

Promise - A promise that will be resolved with a ParticipantRegistry instance representing the new participant registry.

Parameters

Name Type Optional Description
securityContext SecurityContext false The user's security context.
id string false The unique identifier of the participant registry.
name string false The name of the participant registry.
modelManager ModelManager false The ModelManager to use for this participant registry.
factory Factory false The factory to use for this participant registry.
serializer Serializer false The Serializer to use for this participant registry.
bnc BusinessNetworkConnection false BusinessNetworkConnection to use

new ParticipantRegistry()

Create an participant registry.

Note: Only to be called by framework code. Applications should retrieve instances from BusinessNetworkConnection

Parameters

Name Type Optional Description
id string false The unique identifier of the participant registry.
name string false The display name for the participant registry.
securityContext SecurityContext false The security context to use for this participant registry.
modelManager ModelManager false The ModelManager to use for this participant registry.
factory Factory false The factory to use for this participant registry.
serializer Serializer false The Serializer to use for this participant registry.
bnc BusinessNetworkConnection false BusinessNetworkConnection to use