| Interface | osid.lexicon.ParameterPressAssignmentSession | ||
|---|---|---|---|
| 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 | canAssignParameters | ||
| Description |
Tests if this user can alter parameter/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 mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignParametersToPress | ||
| Description |
Tests if this user can alter parameter/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 mapping 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 parameter 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 | getAssignablePressIdsForParameter | ||
| Description |
Gets a list of presses including and under the given press node in which a specific parameter can be assigned. | ||
| Parameters | osid.id.Id | pressId | the Id of the Press |
osid.id.Id | parameterId | the Id of the Parameter | |
| Return | osid.id.IdList | list of assignable press Ids | |
| Errors | NULL_ARGUMENT | pressId or parameterId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignParameterToPress | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | parameterId | the Id of the Parameter |
osid.id.Id | pressId | the Id of the Press | |
| Errors | ALREADY_EXISTS | parameterId is already assigned to pressId | |
| NOT_FOUND | parameterId or pressId not found | ||
| NULL_ARGUMENT | parameterId or pressId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignParameterFromPress | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | parameterId | the Id of the Parameter |
osid.id.Id | pressId | the Id of the Press | |
| Errors | NOT_FOUND | parameterId or pressId not found or
parameterId not assigned to pressId | |
| NULL_ARGUMENT | parameterId or pressId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignParameterToPress | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | parameterId | the Id of the Parameter |
osid.id.Id | fromPressId | the Id of the current Press | |
osid.id.Id | toPressId | the Id of the destination Press | |
| Errors | NOT_FOUND | parameterId, fromPressId , or toPressId not found
or parameterId not mapped to fromPressId | |
| NULL_ARGUMENT | parameterId, fromPressId , or toPressId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |