OpenAssetIO
An abstract API for generalising interactions between a host application and an asset management system
|
This class represents the various derived classes that make up the binding to a Asset Management System. More...
Public Member Functions | |
def | interface (cls) |
Constructs an instance of the ManagerInterface. More... | |
Static Public Member Functions | |
def | identifier () |
Returns an identifier to uniquely identify the plug-in. More... | |
This class represents the various derived classes that make up the binding to a Asset Management System.
It used by the dynamic plug-in discovery mechanism (openassetio.pluginSystem.PythonPluginSystem) to instantiate the main classes in an implementation.
The class will never be instantiated itself, so all functionality is via class methods.
In order to register a new asset management system, simply place a python package on the appropriate search path, that has a top-level attribute called 'plugin', that holds a class derived from this.
|
static |
Returns an identifier to uniquely identify the plug-in.
Generally, this should be the identifier used by the manager. The identifier should use only alpha-numeric characters and '.', '_' or '-'. For example:
"org.openassetio.test.manager"
def interface | ( | cls | ) |
Constructs an instance of the ManagerInterface.
This is an instance of some class derived from ManagerInterface to be bound to the Host-facing Manager.
Generally this is only directly called by the openassetio.pluginSystem.PythonPluginSystemManagerImplementationFactory.
Copyright 2013-2023 The Foundry Visionmongers Ltd. OpenAssetIO is released under the Apache 2.0 License