BusinessNetworkMetadata (Common API)

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

BusinessNetworkMetadata

Defines the metadata for a BusinessNeworkDefinition. This includes:

  • package.json
  • README.md (optional)

Details

  • Module common

See also

Method Summary

Name Returns Description
constructor void Create the BusinessNetworkMetadata.

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

getDescription string Returns the description for this business network.
getIdentifier string Returns the identifier for this business network, formed from name@version.
getName string Returns the name for this business network.
getPackageJson object Returns the package.json for this business network.
getREADME String Returns the README.md for this business network. This may be null if the business network does not have a README.md
getVersion string Returns the version for this business network.

Method Details

new BusinessNetworkMetadata()

Create the BusinessNetworkMetadata.

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

Parameters

Name Type Optional Description
packageJson object false the JS object for package.json (required)
readme String false the README.md for the business network (may be null)

getREADME

String getREADME( )

Returns the README.md for this business network. This may be null if the business network does not have a README.md

Returns

String - the README.md file for the business network or null

Parameters

No parameters

getPackageJson

object getPackageJson( )

Returns the package.json for this business network.

Returns

object - the Javascript object for package.json

Parameters

No parameters

getName

string getName( )

Returns the name for this business network.

Returns

string - the name of the business network

Parameters

No parameters

getDescription

string getDescription( )

Returns the description for this business network.

Returns

string - the description of the business network

Parameters

No parameters

getVersion

string getVersion( )

Returns the version for this business network.

Returns

string - the description of the business network

Parameters

No parameters

getIdentifier

string getIdentifier( )

Returns the identifier for this business network, formed from name@version.

Returns

string - the identifier of the business network

Parameters

No parameters