Interface LexiconBatchManager

All Superinterfaces:

AutoCloseable, Closeable, LexiconBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface LexiconBatchManager
extends OsidManager, LexiconBatchProfile

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

• TextBatchAdminSession : a session to create, modify, and delete texts in bulk
• IdiomBatchAdminSession : a session to create, modify, and delete idioms in bulk
• ParameterBatchAdminSession : a session to create, modify, and delete parameters in bulk
• PressBatchAdminSession : a session to create, modify, and delete presses in bulk

Method Summary

Modifier and Type	Method	Description
IdiomBatchAdminSession	getIdiomBatchAdminSession()	Gets the OsidSession associated with the bulk text administration service.
IdiomBatchAdminSession	getIdiomBatchAdminSessionForPress(Id pressId)	Gets the OsidSession associated with the bulk idiom administration service for the given press.
ParameterBatchAdminSession	getParameterBatchAdminSession()	Gets the OsidSession associated with the bulk parameter administration service.
ParameterBatchAdminSession	getParameterBatchAdminSessionForPress(Id pressId)	Gets the OsidSession associated with the bulk parameter administration service for the given press.
PressBatchAdminSession	getPressBatchAdminSession()	Gets the OsidSession associated with the bulk press administration service.
TextBatchAdminSession	getTextBatchAdminSession()	Gets the OsidSession associated with the bulk text administration service.
TextBatchAdminSession	getTextBatchAdminSessionForPress(Id pressId)	Gets the OsidSession associated with the bulk text administration service for the given press.

Methods inherited from interface Closeable

close

Methods inherited from interface LexiconBatchProfile

supportsIdiomBatchAdmin, supportsParameterBatchAdmin, supportsPressBatchAdmin, supportsTextBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsIdiomBatchAdmin()	Tests if bulk administration of idioms is available.
boolean	supportsParameterBatchAdmin()	Tests if bulk administration of parameters is available.
boolean	supportsPressBatchAdmin()	Tests if bulk administration of texts is available.
boolean	supportsTextBatchAdmin()	Tests if bulk administration of texts 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

getTextBatchAdminSession

TextBatchAdminSession getTextBatchAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk text administration service.

Returns:

a TextBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTextBatchAdmin() is false

Compliance:

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

getTextBatchAdminSessionForPress

TextBatchAdminSession getTextBatchAdminSessionForPress(Id pressId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk text administration service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a TextBatchAdminSession

Throws:

NotFoundException - no Press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOsidObjectBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getIdiomBatchAdminSession

IdiomBatchAdminSession getIdiomBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk text administration service.

Returns:

an IdiomBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomBatchAdmin() is false

Compliance:

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

getIdiomBatchAdminSessionForPress

IdiomBatchAdminSession getIdiomBatchAdminSessionForPress(Id pressId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk idiom administration service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

an IdiomBatchAdminSession

Throws:

NotFoundException - no Press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOsidObjectBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getParameterBatchAdminSession

ParameterBatchAdminSession getParameterBatchAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk parameter administration service.

Returns:

a ParameterBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterBatchAdmin() is false

Compliance:

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

getParameterBatchAdminSessionForPress

ParameterBatchAdminSession getParameterBatchAdminSessionForPress(Id pressId)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk parameter administration service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a ParameterBatchAdminSession

Throws:

NotFoundException - no Press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOsidObjectBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPressBatchAdminSession

PressBatchAdminSession getPressBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk press administration service.

Returns:

a PressBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPressBatchAdmin() is false

Compliance:

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