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.

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, 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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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.

Methods inherited from interface TypeProfile

supportsTypeAdmin, supportsTypeLookup

Modifier and Type	Method	Description
boolean	supportsTypeAdmin()	Tests if a Type administrative service is supported.
boolean	supportsTypeLookup()	Tests if Type lookup is supported.

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} .