Interface LexiconManager

All Superinterfaces:

AutoCloseable, Closeable, LexiconProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface LexiconManager
extends OsidManager, LexiconProfile

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

• TextSession : a session for resolving text

• TextLookupSession : a session to retrieve texts
• TextQuerySession : a session to query for textss
• TextSearchSession : a session to search for texts
• TextAdminSession : a session to create and delete texts
• TextNotificationSession : a session to receive notifications pertaining to text changes
• TextPressSession : a session to look up text press mappings
• TextPressAssignmentSession : a session to manage text to press mappings
• TextSmartPressSession : a session to manage dynamic presses of texts

• IdiomLookupSession : a session to retrieve idioms
• IdiomQuerySession : a session to query for idioms
• IdiomSearchSession : a session to search for idioms
• IdiomAdminSession : a session to create and delete idioms
• IdiomNotificationSession : a session to receive notifications pertaining to idiom changes
• IdiomPressSession : a session to look up idiom press mappings
• IdiomPressAssignmentSession : a session to manage idioms to press mappings
• IdiomSmartPressSession : a session to manage dynamic presses of idioms

• ParameterLookupSession : a session to retrieve parameters
• ParameterQuerySession : a session to query for parameters
• ParameterSearchSession : a session to search for parameters
• ParameterAdminSession : a session to create and delete parameters
• ParameterNotificationSession : a session to receive notifications pertaining to parameter changes
• ParameterPressSession : a session to look up parameter press mappings
• ParameterPressAssignmentSession : a session to manage parameter to press mappings
• ParameterSmartPressSession : a session to manage dynamic presses of parameters

• PressLookupSession : a session to retrieve presses
• PressQuerySession : a session to search for presses
• PressSearchSession : a session to search for presses
• PressAdminSession : a session to create and delete presses
• PressNotificationSession : a session to receive notifications pertaining to press changes
• PressHierarchySession : a session to traverse a hierarchy of press
• PressHierarchyDesignSession : a session to manage an press hierarchy

Method Summary

Modifier and Type	Method	Description
IdiomAdminSession	getIdiomAdminSession()	Gets the OsidSession associated with the idiom administration service.
IdiomAdminSession	getIdiomAdminSessionForPress(Id pressId)	Gets the OsidSession associated with the idiom administration service for the given press.
IdiomLookupSession	getIdiomLookupSession()	Gets the OsidSession associated with the idiom lookup service.
IdiomLookupSession	getIdiomLookupSessionForPress(Id pressId)	Gets the OsidSession associated with the idiom lookup service for the given press.
IdiomNotificationSession	getIdiomNotificationSession(IdiomReceiver idiomReceiver)	Gets the OsidSession associated with the idiom notification service.
IdiomNotificationSession	getIdiomNotificationSessionForPress(IdiomReceiver idiomReceiver, Id pressId)	Gets the OsidSession associated with the idiom notification service for the given press.
IdiomPressAssignmentSession	getIdiomPressAssignmentSession()	Gets the OsidSession associated with assigning idioms to presses.
IdiomPressSession	getIdiomPressSession()	Gets the OsidSession to lookup idiom/press mappings.
IdiomQuerySession	getIdiomQuerySession()	Gets the OsidSession associated with the idiom query service.
IdiomQuerySession	getIdiomQuerySessionForPress(Id pressId)	Gets the OsidSession associated with the idiom query service for the given press.
IdiomSearchSession	getIdiomSearchSession()	Gets the OsidSession associated with the idiom search service.
IdiomSearchSession	getIdiomSearchSessionForPress(Id pressId)	Gets the OsidSession associated with the idiom search service for the given press.
IdiomSmartPressSession	getIdiomSmartPressSession(Id pressId)	Gets the OsidSession to manage idiom smart presses.
LexiconBatchManager	getLexiconBatchManager()	Gets the LexiconBatchManager .
ParameterAdminSession	getParameterAdminSession()	Gets the OsidSession associated with the parameter administration service.
ParameterAdminSession	getParameterAdminSessionForPress(Id pressId)	Gets the OsidSession associated with the parameter administration service for the given press.
ParameterLookupSession	getParameterLookupSession()	Gets the OsidSession associated with the parameter lookup service.
ParameterLookupSession	getParameterLookupSessionForPress(Id pressId)	Gets the OsidSession associated with the parameter lookup service for the given press.
ParameterNotificationSession	getParameterNotificationSession(ParameterReceiver parameterReceiver)	Gets the OsidSession associated with the parameter notification service.
ParameterNotificationSession	getParameterNotificationSessionForPress(ParameterReceiver parameterReceiver, Id pressId)	Gets the OsidSession associated with the parameter notification service for the given press.
ParameterPressAssignmentSession	getParameterPressAssignmentSession()	Gets the OsidSession associated with assigning parameters to presses.
ParameterPressSession	getParameterPressSession()	Gets the OsidSession to lookup parameter/press mappings.
ParameterQuerySession	getParameterQuerySession()	Gets the OsidSession associated with the parameter query service.
ParameterQuerySession	getParameterQuerySessionForPress(Id pressId)	Gets the OsidSession associated with the parameter query service for the given press.
ParameterSearchSession	getParameterSearchSession()	Gets the OsidSession associated with the parameter search service.
ParameterSearchSession	getParameterSearchSessionForPress(Id pressId)	Gets the OsidSession associated with the parameter search service for the given press.
ParameterSmartPressSession	getParameterSmartPressSession(Id pressId)	Gets the OsidSession to manage parameter smart presses.
PressAdminSession	getPressAdminSession()	Gets the OsidSession associated with the press administrative service.
PressHierarchyDesignSession	getPressHierarchyDesignSession()	Gets the OsidSession associated with the press hierarchy design service.
PressHierarchySession	getPressHierarchySession()	Gets the OsidSession associated with the press hierarchy service.
PressLookupSession	getPressLookupSession()	Gets the OsidSession associated with the press lookup service.
PressNotificationSession	getPressNotificationSession(PressReceiver pressReceiver)	Gets the OsidSession associated with the press notification service.
PressQuerySession	getPressQuerySession()	Gets the OsidSession associated with the press query service.
PressSearchSession	getPressSearchSession()	Gets the OsidSession associated with the press search service.
TextAdminSession	getTextAdminSession()	Gets the OsidSession associated with the text administration service.
TextAdminSession	getTextAdminSessionForPress(Id pressId)	Gets the OsidSession associated with the text administration service for the given press.
TextLookupSession	getTextLookupSession()	Gets the OsidSession associated with the text lookup service.
TextLookupSession	getTextLookupSessionForPress(Id pressId)	Gets the OsidSession associated with the text lookup service for the given press.
TextNotificationSession	getTextNotificationSession(TextReceiver textReceiver)	Gets the OsidSession associated with the text notification service.
TextNotificationSession	getTextNotificationSessionForPress(TextReceiver textReceiver, Id pressId)	Gets the OsidSession associated with the text notification service for the given press.
TextPressAssignmentSession	getTextPressAssignmentSession()	Gets the OsidSession associated with assigning texts to presses.
TextPressSession	getTextPressSession()	Gets the OsidSession to lookup text/press mappings.
TextQuerySession	getTextQuerySession()	Gets the OsidSession associated with the text query service.
TextQuerySession	getTextQuerySessionForPress(Id pressId)	Gets the OsidSession associated with the text query service for the given press.
TextSearchSession	getTextSearchSession()	Gets the OsidSession associated with the text search service.
TextSearchSession	getTextSearchSessionForPress(Id pressId)	Gets the OsidSession associated with the text search service for the given press.
TextSession	getTextSession()	Gets the OsidSession associated with the my text service.
TextSession	getTextSessionForPress(Id pressId)	Gets the OsidSession associated with the text service for the given press.
TextSmartPressSession	getTextSmartPressSession(Id pressId)	Gets the OsidSession to manage text smart presses.

Methods inherited from interface Closeable

close

Methods inherited from interface LexiconProfile

getIdiomRecordTypes, getIdiomSearchRecordTypes, getParameterRecordTypes, getParameterSearchRecordTypes, getPressRecordTypes, getPressSearchRecordTypes, getTextRecordTypes, getTextSearchRecordTypes, supportsIdiomAdmin, supportsIdiomLookup, supportsIdiomNotification, supportsIdiomPress, supportsIdiomPressAssignment, supportsIdiomQuery, supportsIdiomRecordType, supportsIdiomSearch, supportsIdiomSearchRecordType, supportsIdiomSmartPress, supportsLexiconBatch, supportsParameterAdmin, supportsParameterLookup, supportsParameterNotification, supportsParameterPress, supportsParameterPressAssignment, supportsParameterQuery, supportsParameterRecordType, supportsParameterSearch, supportsParameterSearchRecordType, supportsParameterSmartPress, supportsPressAdmin, supportsPressHierarchy, supportsPressHierarchyDesign, supportsPressLookup, supportsPressNotification, supportsPressQuery, supportsPressRecordType, supportsPressSearch, supportsPressSearchRecordType, supportsText, supportsTextAdmin, supportsTextLookup, supportsTextNotification, supportsTextPress, supportsTextPressAssignment, supportsTextQuery, supportsTextRecordType, supportsTextReturn, supportsTextSearch, supportsTextSearchRecordType, supportsTextSmartPress, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getIdiomRecordTypes()	Gets the supported Idiom record types.
TypeList	getIdiomSearchRecordTypes()	Gets the supported Idiom search types.
TypeList	getParameterRecordTypes()	Gets the supported Parameter record types.
TypeList	getParameterSearchRecordTypes()	Gets the supported Parameter search types.
TypeList	getPressRecordTypes()	Gets the supported Press record types.
TypeList	getPressSearchRecordTypes()	Gets the supported Press search record types.
TypeList	getTextRecordTypes()	Gets the supported Text record types.
TypeList	getTextSearchRecordTypes()	Gets the supported Text search types.
boolean	supportsIdiomAdmin()	Tests if an idiom administrative service is supported.
boolean	supportsIdiomLookup()	Tests if looking up idioms is supported.
boolean	supportsIdiomNotification()	Tests if an idiom notification service is supported.
boolean	supportsIdiomPress()	Tests if an idiom press lookup service is supported.
boolean	supportsIdiomPressAssignment()	Tests if an idiom press assignment service is supported.
boolean	supportsIdiomQuery()	Tests if querying idioms is supported.
boolean	supportsIdiomRecordType(Type idiomRecordType)	Tests if the given Idiom record type is supported.
boolean	supportsIdiomSearch()	Tests if searching idioms is supported.
boolean	supportsIdiomSearchRecordType(Type idiomSearchRecordType)	Tests if the given Idiom search type is supported.
boolean	supportsIdiomSmartPress()	Tests if an idiom smart press service is supported.
boolean	supportsLexiconBatch()	Tests for the availability of a lexicon batch service.
boolean	supportsParameterAdmin()	Tests if parameter administrative service is supported.
boolean	supportsParameterLookup()	Tests if looking up parameters is supported.
boolean	supportsParameterNotification()	Tests if a parameter notification service is supported.
boolean	supportsParameterPress()	Tests if a parameter press lookup service is supported.
boolean	supportsParameterPressAssignment()	Tests if a parameter press service is supported.
boolean	supportsParameterQuery()	Tests if querying parameters is supported.
boolean	supportsParameterRecordType(Type parameterRecordType)	Tests if the given Parameter record type is supported.
boolean	supportsParameterSearch()	Tests if searching parameters is supported.
boolean	supportsParameterSearchRecordType(Type parameterSearchRecordType)	Tests if the given Parameter search type is supported.
boolean	supportsParameterSmartPress()	Tests if a parameter smart press lookup service is supported.
boolean	supportsPressAdmin()	Tests if press administrative service is supported.
boolean	supportsPressHierarchy()	Tests for the availability of an press hierarchy traversal service.
boolean	supportsPressHierarchyDesign()	Tests for the availability of an press hierarchy design service.
boolean	supportsPressLookup()	Tests if looking up presses is supported.
boolean	supportsPressNotification()	Tests if an press notification service is supported.
boolean	supportsPressQuery()	Tests if querying presses is supported.
boolean	supportsPressRecordType(Type pressRecordType)	Tests if the given Press record type is supported.
boolean	supportsPressSearch()	Tests if searching presses is supported.
boolean	supportsPressSearchRecordType(Type pressSearchRecordType)	Tests if the given Press search record type is supported.
boolean	supportsText()	Tests if a text service is supported for the current agent.
boolean	supportsTextAdmin()	Tests if a text administrative service is supported.
boolean	supportsTextLookup()	Tests if looking up texts is supported.
boolean	supportsTextNotification()	Tests if a text notification service is supported.
boolean	supportsTextPress()	Tests if a text press lookup service is supported.
boolean	supportsTextPressAssignment()	Tests if a text press assignment service is supported.
boolean	supportsTextQuery()	Tests if querying texts is supported.
boolean	supportsTextRecordType(Type textRecordType)	Tests if the given Text record type is supported.
boolean	supportsTextReturn()	Tests if returning texts is supported.
boolean	supportsTextSearch()	Tests if searching texts is supported.
boolean	supportsTextSearchRecordType(Type textSearchRecordType)	Tests if the given Text search type is supported.
boolean	supportsTextSmartPress()	Tests if a text smart press service is supported.
boolean	supportsVisibleFederation()	Tests if any press federation is exposed.

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

getTextSession

TextSession getTextSession()
                    throws OperationFailedException

Gets the OsidSession associated with the my text service.

Returns:

a TextSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsText() is false

Compliance:

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

getTextSessionForPress

TextSession getTextSessionForPress(Id pressId)
                            throws NotFoundException,
OperationFailedException

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

Parameters:

pressId - the Id of the press

Returns:

a TextSession

Throws:

NotFoundException - no Press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsText() or supportsVisibleFederation() is false

Compliance:

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

getTextLookupSession

TextLookupSession getTextLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the text lookup service.

Returns:

a TextLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTextLookup() is false

Compliance:

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

getTextLookupSessionForPress

TextLookupSession getTextLookupSessionForPress(Id pressId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the text lookup service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a TextLookupSession

Throws:

NotFoundException - no Press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTextLookup() or supportsVisibleFederation() is false

Compliance:

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

getTextQuerySession

TextQuerySession getTextQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the text query service.

Returns:

a TextQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTextQuery() is false

Compliance:

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

getTextQuerySessionForPress

TextQuerySession getTextQuerySessionForPress(Id pressId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the text query service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a TextQuerySession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTextQuery() or supportsVisibleFederation() is false

Compliance:

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

getTextSearchSession

TextSearchSession getTextSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the text search service.

Returns:

a TextSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTextSearch() is false

Compliance:

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

getTextSearchSessionForPress

TextSearchSession getTextSearchSessionForPress(Id pressId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the text search service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a TextSearchSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTextSearch() or supportsVisibleFederation() is false

Compliance:

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

getTextAdminSession

TextAdminSession getTextAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the text administration service.

Returns:

a TextAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTextAdmin() is false

Compliance:

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

getTextAdminSessionForPress

TextAdminSession getTextAdminSessionForPress(Id pressId)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

pressId - the Id of the Press

Returns:

a TextAdminSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTextAdmin() or supportsVisibleFederation() is false

Compliance:

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

getTextNotificationSession

TextNotificationSession getTextNotificationSession(TextReceiver textReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the text notification service.

Parameters:

textReceiver - the notification callback

Returns:

a TextNotificationSession

Throws:

NullArgumentException - textReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTextNotification() is false

Compliance:

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

getTextNotificationSessionForPress

TextNotificationSession getTextNotificationSessionForPress(TextReceiver textReceiver,
 Id pressId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the text notification service for the given press.

Parameters:

textReceiver - the notification callback

pressId - the Id of the Press

Returns:

a TextNotificationSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - textReceiver or pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTextNotification() or supportsVisibleFederation() is false

Compliance:

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

getTextPressSession

TextPressSession getTextPressSession()
                              throws OperationFailedException

Gets the OsidSession to lookup text/press mappings.

Returns:

a TextPressSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTextPress() is false

Compliance:

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

getTextPressAssignmentSession

TextPressAssignmentSession getTextPressAssignmentSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with assigning texts to presses.

Returns:

a TextPressAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTextPressAssignment() is false

Compliance:

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

getTextSmartPressSession

TextSmartPressSession getTextSmartPressSession(Id pressId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage text smart presses.

Parameters:

pressId - the Id of the Press

Returns:

a TextSmartPressSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTextSmartPress() is false

Compliance:

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

getIdiomLookupSession

IdiomLookupSession getIdiomLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the idiom lookup service.

Returns:

a IdiomLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomLookup() is false

Compliance:

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

getIdiomLookupSessionForPress

IdiomLookupSession getIdiomLookupSessionForPress(Id pressId)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the idiom lookup service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a IdiomLookupSession

Throws:

NotFoundException - no Press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomLookup() or supportsVisibleFederation() is false

Compliance:

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

getIdiomQuerySession

IdiomQuerySession getIdiomQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the idiom query service.

Returns:

a IdiomQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomQuery() is false

Compliance:

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

getIdiomQuerySessionForPress

IdiomQuerySession getIdiomQuerySessionForPress(Id pressId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the idiom query service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a IdiomQuerySession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomQuery() or supportsVisibleFederation() is false

Compliance:

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

getIdiomSearchSession

IdiomSearchSession getIdiomSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the idiom search service.

Returns:

a IdiomSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomSearch() is false

Compliance:

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

getIdiomSearchSessionForPress

IdiomSearchSession getIdiomSearchSessionForPress(Id pressId)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the idiom search service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a IdiomSearchSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomSearch() or supportsVisibleFederation() is false

Compliance:

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

getIdiomAdminSession

IdiomAdminSession getIdiomAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the idiom administration service.

Returns:

a IdiomAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomAdmin() is false

Compliance:

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

getIdiomAdminSessionForPress

IdiomAdminSession getIdiomAdminSessionForPress(Id pressId)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

pressId - the Id of the Press

Returns:

a IdiomAdminSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomAdmin() or supportsVisibleFederation() is false

Compliance:

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

getIdiomNotificationSession

IdiomNotificationSession getIdiomNotificationSession(IdiomReceiver idiomReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the idiom notification service.

Parameters:

idiomReceiver - the notification callback

Returns:

a IdiomNotificationSession

Throws:

NullArgumentException - idiomReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomNotification() is false

Compliance:

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

getIdiomNotificationSessionForPress

IdiomNotificationSession getIdiomNotificationSessionForPress(IdiomReceiver idiomReceiver,
 Id pressId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the idiom notification service for the given press.

Parameters:

idiomReceiver - the notification callback

pressId - the Id of the Press

Returns:

a IdiomNotificationSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - idiomReceiver or pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomNotification() or supportsVisibleFederation() is false

Compliance:

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

getIdiomPressSession

IdiomPressSession getIdiomPressSession()
                                throws OperationFailedException

Gets the OsidSession to lookup idiom/press mappings.

Returns:

a IdiomPressSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomPress() is false

Compliance:

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

getIdiomPressAssignmentSession

IdiomPressAssignmentSession getIdiomPressAssignmentSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with assigning idioms to presses.

Returns:

a IdiomPressAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomPressAssignment() is false

Compliance:

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

getIdiomSmartPressSession

IdiomSmartPressSession getIdiomSmartPressSession(Id pressId)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage idiom smart presses.

Parameters:

pressId - the Id of the Press

Returns:

a IdiomSmartPressSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdiomSmartPress() is false

Compliance:

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

getParameterLookupSession

ParameterLookupSession getParameterLookupSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the parameter lookup service.

Returns:

a ParameterLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterLookup() is false

Compliance:

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

getParameterLookupSessionForPress

ParameterLookupSession getParameterLookupSessionForPress(Id pressId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the parameter lookup service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a ParameterLookupSession

Throws:

NotFoundException - no Press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterLookup() or supportsVisibleFederation() is false

Compliance:

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

getParameterQuerySession

ParameterQuerySession getParameterQuerySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the parameter query service.

Returns:

a ParameterQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterQuery() is false

Compliance:

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

getParameterQuerySessionForPress

ParameterQuerySession getParameterQuerySessionForPress(Id pressId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the parameter query service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a ParameterQuerySession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterQuery() or supportsVisibleFederation() is false

Compliance:

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

getParameterSearchSession

ParameterSearchSession getParameterSearchSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the parameter search service.

Returns:

a ParameterSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSearch() is false

Compliance:

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

getParameterSearchSessionForPress

ParameterSearchSession getParameterSearchSessionForPress(Id pressId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the parameter search service for the given press.

Parameters:

pressId - the Id of the Press

Returns:

a ParameterSearchSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSearch() or supportsVisibleFederation() is false

Compliance:

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

getParameterAdminSession

ParameterAdminSession getParameterAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the parameter administration service.

Returns:

a ParameterAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterAdmin() is false

Compliance:

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

getParameterAdminSessionForPress

ParameterAdminSession getParameterAdminSessionForPress(Id pressId)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

pressId - the Id of the Press

Returns:

a ParameterAdminSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterAdmin() or supportsVisibleFederation() is false

Compliance:

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

getParameterNotificationSession

ParameterNotificationSession getParameterNotificationSession(ParameterReceiver parameterReceiver)
                                                      throws OperationFailedException

Gets the OsidSession associated with the parameter notification service.

Parameters:

parameterReceiver - the notification callback

Returns:

a ParameterNotificationSession

Throws:

NullArgumentException - parameterReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterNotification() is false

Compliance:

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

getParameterNotificationSessionForPress

ParameterNotificationSession getParameterNotificationSessionForPress(ParameterReceiver parameterReceiver,
 Id pressId)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the parameter notification service for the given press.

Parameters:

parameterReceiver - the notification callback

pressId - the Id of the Press

Returns:

a ParameterNotificationSession

Throws:

NotFoundException - no press found by the given Id

NullArgumentException - parameterReceiver or pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterNotification() or supportsVisibleFederation() is false

Compliance:

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

getParameterPressSession

ParameterPressSession getParameterPressSession()
                                        throws OperationFailedException

Gets the OsidSession to lookup parameter/press mappings.

Returns:

a ParameterPressSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterPress() is false

Compliance:

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

getParameterPressAssignmentSession

ParameterPressAssignmentSession getParameterPressAssignmentSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with assigning parameters to presses.

Returns:

a ParameterPressAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterPressAssignment() is false

Compliance:

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

getParameterSmartPressSession

ParameterSmartPressSession getParameterSmartPressSession(Id pressId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage parameter smart presses.

Parameters:

pressId - the Id of the press

Returns:

a ParameterSmartPressSession

Throws:

NotFoundException - no Press found by the given Id

NullArgumentException - pressId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSmartPress() is false

Compliance:

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

getPressLookupSession

PressLookupSession getPressLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the press lookup service.

Returns:

a PressLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPressLookup() is false

Compliance:

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

getPressQuerySession

PressQuerySession getPressQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the press query service.

Returns:

a PressQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPressQuery() is false

Compliance:

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

getPressSearchSession

PressSearchSession getPressSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the press search service.

Returns:

a PressSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPressSearch() is false

Compliance:

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

getPressAdminSession

PressAdminSession getPressAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the press administrative service.

Returns:

a PressAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPressAdmin() is false

Compliance:

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

getPressNotificationSession

PressNotificationSession getPressNotificationSession(PressReceiver pressReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the press notification service.

Parameters:

pressReceiver - the notification callback

Returns:

a PressNotificationSession

Throws:

NullArgumentException - pressReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPressNotification() is false

Compliance:

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

getPressHierarchySession

PressHierarchySession getPressHierarchySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the press hierarchy service.

Returns:

a PressHierarchySession for presses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPressHierarchy() is false

Compliance:

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

getPressHierarchyDesignSession

PressHierarchyDesignSession getPressHierarchyDesignSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the press hierarchy design service.

Returns:

a HierarchyDesignSession for presses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPressHierarchyDesign() is false

Compliance:

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

getLexiconBatchManager

LexiconBatchManager getLexiconBatchManager()
                                    throws OperationFailedException

Gets the LexiconBatchManager .

Returns:

a LexiconBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLexiconBatch() is false

Compliance:

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