Interface OsidRuntimeManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, OsidRuntimeProfile, Sourceable

public interface OsidRuntimeManager
extends OsidManager, OsidRuntimeProfile

The OsidRuntimeManager represents and OSID platform and contains the information required for running OSID implementations such as search paths and configurations.

The OsidRuntimeManager is defined as an interface to provide flexibility for managing an OSID environment. The instantiation of a OsidRuntimeManager implementation is defined by the OSID platform.

The OsidRuntimeManager should be instantiated with a string that identifies the application or environment current at the time of instantiation. This key is used soley for the purpose of seeding the configuration service as a means to enable lower level OSIDs to tune their configuration in response to this key, or, it can be used by the application to retrieve configuration data for itself.

Method Summary

Modifier and Type	Method	Description
ValueLookupSession	getConfiguration()	Gets the current configuration in the runtime environment.
OsidManager	getManager(OSID osid, String implClassName, Version version)	Finds, loads and instantiates providers of OSID managers.
OsidProxyManager	getProxyManager(OSID osid, String implementation, Version version)	Finds, loads and instantiates providers of OSID managers.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidRuntimeProfile

supportsConfiguration

Modifier and Type	Method	Description
boolean	supportsConfiguration()	Tests if a configuration service is provided within this runtime environment.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getManager

OsidManager getManager(OSID osid,
 String implClassName,
 Version version)
                throws ConfigurationErrorException,
NotFoundException,
OperationFailedException

Finds, loads and instantiates providers of OSID managers. Providers must conform to an OsidManager interface. The interfaces are defined in the OSID enumeration. For all OSID requests, an instance of OsidManager that implements the OsidManager interface is returned. In bindings where permitted, this can be safely cast into the requested manager.

Parameters:

osid - represents the OSID

implClassName - the name of the implementation

version - the minimum required OSID specification version

Returns:

the manager of the service

Throws:

ConfigurationErrorException - an error in configuring the implementation

NotFoundException - the implementation class was not found

NullArgumentException - implClassName or version is null

OperationFailedException - unable to complete request

UnsupportedException - implClassName does not support the requested OSID

Compliance:

mandatory - This method must be implemented.

Notes:

After - finding and instantiating the requested {@code OsidManager} , providers must invoke {@code OsidManager.initialize(OsidRuntimeManager)} where the environment is an instance of the current environment that includes the configuration for the service being initialized. The {@code OsidRuntimeManager} passed may include information useful for the configuration such as the identity of the service being instantiated.

getProxyManager

OsidProxyManager getProxyManager(OSID osid,
 String implementation,
 Version version)
                          throws ConfigurationErrorException,
NotFoundException,
OperationFailedException

Finds, loads and instantiates providers of OSID managers. Providers must conform to an OsidManager interface. The interfaces are defined in the OSID enumeration. For all OSID requests, an instance of OsidManager that implements the OsidManager interface is returned. In bindings where permitted, this can be safely cast into the requested manager.

Parameters:

osid - represents the OSID

implementation - the name of the implementation

version - the minimum required OSID specification version

Returns:

the manager of the service

Throws:

ConfigurationErrorException - an error in configuring the implementation

NotFoundException - the implementation class was not found

NullArgumentException - implementation or version is null

OperationFailedException - unable to complete request

UnsupportedException - implementation does not support the requested OSID

Compliance:

mandatory - This method must be implemented.

Notes:

After - finding and instantiating the requested {@code OsidManager} , providers must invoke {@code OsidManager.initialize(OsidRuntimeManager)} where the environment is an instance of the current environment that includes the configuration for the service being initialized. The {@code OsidRuntimeManager} passed may include information useful for the configuration such as the identity of the service being instantiated.

getConfiguration

ValueLookupSession getConfiguration()
                             throws OperationFailedException,
PermissionDeniedException

Gets the current configuration in the runtime environment.

Returns:

a configuration

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

UnimplementedException - a configuration service is not supported

Compliance:

optional - This method must be implemented if {@code supportsConfiguration()} is {@code true} .