| Interface | osid.lexicon.TextPressAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.lexicon.LexiconManager | ||
osid.lexicon.LexiconProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of a | ||
| Method | canAssignTexts | ||
| 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
| ||
| Return | boolean | false if lexicon is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignTextsToPress | ||
| 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
| ||
| Parameters | osid.id.Id | pressId | the Id of the Press |
| Return | boolean | false if lexicon is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | pressId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignablePressIds | ||
| Description |
Gets a list of presses including and under the given press node in which any text can be assigned. | ||
| Parameters | osid.id.Id | pressId | the Id of the Press |
| Return | osid.id.IdList | list of assignable press Ids | |
| Errors | NULL_ARGUMENT | pressId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignablePressIdsForText | ||
| Description |
Gets a list of presses including and under the given press node in which a specific text can be assigned. | ||
| Parameters | osid.id.Id | pressId | the Id of the Press |
osid.id.Id | textId | the Id of the Text | |
| Return | osid.id.IdList | list of assignable press Ids | |
| Errors | NULL_ARGUMENT | pressId or textId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignTextToPress | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | textId | the Id of the Text |
osid.id.Id | pressId | the Id of the Press | |
| Errors | ALREADY_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignTextFromPress | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | textId | the Id of the Text |
osid.id.Id | pressId | the Id of the Press | |
| Errors | NOT_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignTextToPress | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | textId | the Id of the Text |
osid.id.Id | fromPressId | the Id of the current Press | |
osid.id.Id | toPressId | the Id of the destination Press | |
| Errors | NOT_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 | ||
| Compliance | mandatory | This method must be implemented. | |