OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.IdiomPressSession
Implementsosid.OsidSession
Used Byosid.lexicon.LexiconManager
osid.lexicon.LexiconProxyManager
Description

This session provides methods to retrieve Idiom to Press mappings. An Idiom may appear in multiple Press objects. Each press may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupIdiomPressMappings
Description

Tests if this user can perform lookups of idiom/press mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an press that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseComparativeIdiomPressView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliancemandatory This method is must be implemented.
MethodusePlenaryIdiomPressView
Description

A complete view of the Idiom and Press returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliancemandatory This method is must be implemented.
MethodgetIdiomIdsByPress
Description

Gets the list of Idiom Ids associated with a Press.

Parametersosid.id.IdpressId Id of the Press
Returnosid.id.IdList list of related idiom Ids
ErrorsNOT_FOUND pressId is not found
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetIdiomsByPress
Description

Gets the list of Idioms associated with a Press.

Parametersosid.id.IdpressId Id of the Press
Returnosid.lexicon.IdiomList list of related idioms
ErrorsNOT_FOUND pressId is not found
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetIdiomIdsByPresses
Description

Gets the list of Idiom Ids corresponding to a list of Presses.

Parametersosid.id.IdListpressIds list of press Ids
Returnosid.id.IdList list of idiom Ids
ErrorsNULL_ARGUMENT pressIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetIdiomsByPresses
Description

Gets the list of Idiom corresponding to a list of Presses.

Parametersosid.id.IdListpressIds list of press Ids
Returnosid.lexicon.IdiomList list of idioms
ErrorsNULL_ARGUMENT pressIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetPressIdsByIdiom
Description

Gets the Press Ids mapped to an Idiom.

Parametersosid.id.IdidiomId Id of an Idiom
Returnosid.id.IdList list of presses
ErrorsNOT_FOUND idiomId is not found
NULL_ARGUMENT idiomId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetPressesByIdiom
Description

Gets the Presses mapped to an Idiom.

Parametersosid.id.IdidiomId Id of an Idiom
Returnosid.lexicon.PressList list of presses
ErrorsNOT_FOUND idiomId is not found
NULL_ARGUMENT idiomId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.