Interface OntologyBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OntologyBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface OntologyBatchManager
extends OsidManager, OntologyBatchProfile

The ontology batch manager provides access to ontology batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• SubjectBatchAdminSession : a session to create, modify and delete subjects in bulk
• RelevancyBatchSession : a session to create, modify and delete relevancies in bulk
• OntologyBatchAdminSession : a session to create, modify and delete ontologies in bulk

Method Summary

Modifier and Type	Method	Description
OntologyBatchAdminSession	getOntologyBatchAdminSession()	Gets the OsidSession associated with the bulk ontology administration service.
RelevancyBatchAdminSession	getRelevancyBatchAdminSession()	Gets the OsidSession associated with the bulk relevancy administration service.
RelevancyBatchAdminSession	getRelevancyBatchAdminSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the bulk relevancy administration service for the given ontology.
SubjectBatchAdminSession	getSubjectBatchAdminSession()	Gets the OsidSession associated with the bulk subject administration service.
SubjectBatchAdminSession	getSubjectBatchAdminSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the bulk subject administration service for the given ontology.

Methods inherited from interface Closeable

close

Methods inherited from interface OntologyBatchProfile

supportsOntologyBatchAdmin, supportsRelevancyBatchAdmin, supportsSubjectBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsOntologyBatchAdmin()	Tests if bulk administration of ontologies is available.
boolean	supportsRelevancyBatchAdmin()	Tests if bulk administration of relevancies is available.
boolean	supportsSubjectBatchAdmin()	Tests if bulk administration of subjects is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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

getSubjectBatchAdminSession

SubjectBatchAdminSession getSubjectBatchAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk subject administration service.

Returns:

a SubjectBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectBatchAdmin() is false

Compliance:

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

getSubjectBatchAdminSessionForOntology

SubjectBatchAdminSession getSubjectBatchAdminSessionForOntology(Id ontologyId)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk subject administration service for the given ontology.

Parameters:

ontologyId - the Id of the Ontology

Returns:

a SubjectBatchAdminSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getRelevancyBatchAdminSession

RelevancyBatchAdminSession getRelevancyBatchAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk relevancy administration service.

Returns:

a RelevancyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyBatchAdmin() is false

Compliance:

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

getRelevancyBatchAdminSessionForOntology

RelevancyBatchAdminSession getRelevancyBatchAdminSessionForOntology(Id ontologyId)
                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk relevancy administration service for the given ontology.

Parameters:

ontologyId - the Id of the Ontology

Returns:

a RelevancyBatchAdminSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getOntologyBatchAdminSession

OntologyBatchAdminSession getOntologyBatchAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk ontology administration service.

Returns:

an OntologyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyBatchAdmin() is false

Compliance:

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