OSID Logo
OSID Specifications
lexicon package
Version 3.1.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.

Returnboolean false if lexicon is not authorized, true otherwise
Compliancemandatory This 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.IdpressId the Id of the Press
Returnboolean false if lexicon is not authorized, true otherwise
ErrorsNULL_ARGUMENT pressId is null
Compliancemandatory This 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.IdpressId the Id of the Press
Returnosid.id.IdList list of assignable press Ids
ErrorsNULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdpressId the Id of the Press
osid.id.IdtextId the Id of the Text
Returnosid.id.IdList list of assignable press Ids
ErrorsNULL_ARGUMENT pressId or textId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignTextToPress
Description

Adds an existing Text to a Press.

Parametersosid.id.IdtextId the Id of the Text
osid.id.IdpressId the Id of the Press
ErrorsALREADY_EXISTS textId is slready assigned to pressId
NOT_FOUND textId or pressId not found
NULL_ARGUMENT textId or pressId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignTextFromPress
Description

Removes a Text from a Press.

Parametersosid.id.IdtextId the Id of the Text
osid.id.IdpressId the Id of the Press
ErrorsNOT_FOUND textId or pressId not found or textId not assigned to pressId
NULL_ARGUMENT textId or pressId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignTextToPress
Description

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

Parametersosid.id.IdtextId the Id of the Text
osid.id.IdfromPressId the Id of the current Press
osid.id.IdtoPressId the Id of the destination Press
ErrorsNOT_FOUND textId, fromPressId, or toPressId not found or textId not mapped to fromPressId
NULL_ARGUMENT textId, fromPressId, or toPressId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.