org.osid.type

Interface TypeProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, 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.

Method Summary

Methods

Modifier and Type	Method and 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 org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.type.TypeProfile

supportsTypeAdmin, supportsTypeLookup

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsTypeLookup() is 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 supportsTypeAdmin() is true.