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

This session provides methods to re-assign Idioms to Press mappings. An Idiom may appear in multiple Press objects and removing the last reference to an Idiom is the equivalent of deleting it. Each Press may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Idiom to another Press is not a copy operation (eg: does not change its Id ).

MethodcanAssignIdioms
Description

Tests if this user can alter idiom/press mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returnbooleanfalse if idiom assignment is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignIdiomsToPress
Description

Tests if this user can alter idiom/press mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parametersosid.id.IdpressIdthe Id of the Press
Returnbooleanfalse if idiom assignment is not authorized, true otherwise
ErrorsNULL_ARGUMENTpressId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignablePressIds
Description

Gets a list of presses including and under the given press node in which any idiom can be assigned.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.id.IdListlist of assignable press Ids
ErrorsNULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignablePressIdsForIdiom
Description

Gets a list of presses including and under the given press node in which a specific idiom can be assigned.

Parametersosid.id.IdpressIdthe Id of the Press
osid.id.IdidiomIdthe Id of the Idiom
Returnosid.id.IdListlist of assignable press Ids
ErrorsNULL_ARGUMENTpressId or idiomId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignIdiomToPress
Description

Adds an existing Idiom to a Press .

Parametersosid.id.IdidiomIdthe Id of the Idiom
osid.id.IdpressIdthe Id of the Press
ErrorsALREADY_EXISTSidiomId is already assigned to pressId
NOT_FOUNDidiomId or pressId not found
NULL_ARGUMENTidiomId or pressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignIdiomFromPress
Description

Removes an Idiom from a Press .

Parametersosid.id.IdidiomIdthe Id of the Idiom
osid.id.IdpressIdthe Id of the Press
ErrorsNOT_FOUNDidiomId or pressId not found or idiomId not assigned to pressId
NULL_ARGUMENTidiomId or pressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignIdiomToPress
Description

Moves an Idiom from one Press to another. Mappings to other Presses are unaffected.

Parametersosid.id.IdidiomIdthe Id of the Idiom
osid.id.IdfromPressIdthe Id of the current Press
osid.id.IdtoPressIdthe Id of the destination Press
ErrorsNOT_FOUNDidiomId, fromPressId , or toPressId not found or idiomId not mapped to fromPressId
NULL_ARGUMENTidiomId, fromPressId , or toPressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.