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

This session provides methods to re-assign Texts to Press mappings. A Text may appear in multiple Press objects and removing the last reference to a Text 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 a Text to another Press is not a copy operation (eg: does not change its Id ).

MethodcanAssignTexts
Description

Tests if this user can alter text/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 lexicon is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignTextsToPress
Description

Tests if this user can alter text/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 lexicon 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 text 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.
MethodgetAssignablePressIdsForText
Description

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

Parametersosid.id.IdpressIdthe Id of the Press
osid.id.IdtextIdthe Id of the Text
Returnosid.id.IdListlist of assignable press Ids
ErrorsNULL_ARGUMENTpressId or textId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignTextToPress
Description

Adds an existing Text to a Press .

Parametersosid.id.IdtextIdthe Id of the Text
osid.id.IdpressIdthe Id of the Press
ErrorsALREADY_EXISTStextId is slready assigned to pressId
NOT_FOUNDtextId or pressId not found
NULL_ARGUMENTtextId or pressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignTextFromPress
Description

Removes a Text from a Press .

Parametersosid.id.IdtextIdthe Id of the Text
osid.id.IdpressIdthe Id of the Press
ErrorsNOT_FOUNDtextId or pressId not found or textId not assigned to pressId
NULL_ARGUMENTtextId or pressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignTextToPress
Description

Moves a Text from one Press to another. Mappings to other Presses are unaffected.

Parametersosid.id.IdtextIdthe Id of the Text
osid.id.IdfromPressIdthe Id of the current Press
osid.id.IdtoPressIdthe Id of the destination Press
ErrorsNOT_FOUNDtextId, fromPressId , or toPressId not found or textId not mapped to fromPressId
NULL_ARGUMENTtextId, fromPressId , or toPressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.