Interface TypeProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable, TypeProfile

public interface TypeProxyManager
extends OsidProxyManager, TypeProfile

This manager provides access to the available sessions of the type service. Methods in this manager support the passing of a Proxy object for the purpose of passing information from a server environment. The TypeLookupSession is used for looking up Types and the TypeAdminSession is used for managing and registering new Types.

TypeProxyManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
TypeAdminSession	getTypeAdminSession(Proxy proxy)	Gets the OsidSession associated with the TypeAdmin service.
TypeLookupSession	getTypeLookupSession(Proxy proxy)	Gets the OsidSession associated with the type lookup service.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Methods inherited from interface OsidProxyManager

close

Methods inherited from interface OsidProxyManager

changeBranch, getProxy, getProxyCondition, initialize, rollbackService

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Methods inherited from interface TypeProfile

supportsTypeAdmin, supportsTypeLookup

Method Details

getTypeLookupSession

TypeLookupSession getTypeLookupSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the type lookup service.

Parameters:

proxy - a proxy

Returns:

a TypeLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTypeLookup() is false

Compliance:

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

getTypeAdminSession

TypeAdminSession getTypeAdminSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the TypeAdmin service.

Parameters:

proxy - a proxy

Returns:

the new TypeAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTypeAdmin() is false

Compliance:

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