org.osid.ontology.batch

Interface OntologyBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OntologyBatchProfile, OsidProfile, OsidProxyManager, Sourceable

public interface OntologyBatchProxyManager
extends OsidProxyManager, OntologyBatchProfile

The ontology batch proxy manager provides access to ontology batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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

Methods

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

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.ontology.batch.OntologyBatchProfile

supportsOntologyBatchAdmin, supportsRelevancyBatchAdmin, supportsSubjectBatchAdmin, supportsVisibleFederation

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

getSubjectBatchAdminSession

SubjectBatchAdminSession getSubjectBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk subject administration service.

Parameters:

proxy - a proxy

Returns:

a SubjectBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsSubjectBatchAdmin() is true.

getSubjectBatchAdminSessionForOntology

SubjectBatchAdminSession getSubjectBatchAdminSessionForOntology(Id ontologyId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a SubjectBatchAdminSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubjectBatchAdmin() and supportsVisibleFederation() are true

getRelevancyBatchAdminSession

RelevancyBatchAdminSession getRelevancyBatchAdminSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk relevancy administration service.

Parameters:

proxy - a proxy

Returns:

a RelevancyBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsRelevancyBatchAdmin() is true.

getRelevancyBatchAdminSessionForOntology

RelevancyBatchAdminSession getRelevancyBatchAdminSessionForOntology(Id ontologyId,
                                                                  Proxy proxy)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

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

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyBatchAdminSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRelevancyBatchAdmin() and supportsVisibleFederation() are true

getOntologyBatchAdminSession

OntologyBatchAdminSession getOntologyBatchAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk ontology administration service.

Parameters:

proxy - a proxy

Returns:

an OntologyBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsOntologyBatchAdmin() is true.