Interface | osid.resource.demographic.DemographicBinAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignDemographics | ||
Description |
Tests if this user can alter demographic/bin 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 | canAssignDemographicsToBin | ||
Description |
Tests if this user can alter demographic/bin 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 | binId | the Id of the Bin |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | binId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableBinIds | ||
Description |
Gets a list of bins including and under the given bin node in which any demographic can be assigned. | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
Return | osid.id.IdList | list of assignable bin Ids | |
Errors | NULL_ARGUMENT | binId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableBinIdsForDemographic | ||
Description |
Gets a list of bins including and under the given bin node in which a specific demographic can be assigned. | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.id.Id | demographicId | the Id of the Demographic | |
Return | osid.id.IdList | list of assignable bin Ids | |
Errors | NULL_ARGUMENT | binId or demographicId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignDemographicToBin | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | demographicId | the Id of the Demographic |
osid.id.Id | binId | the Id of the Bin | |
Errors | ALREADY_EXISTS | demographicId is not assigned to binId | |
NOT_FOUND | demographicId or binId not found | ||
NULL_ARGUMENT | demographicId or binId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignDemographicFromBin | ||
Description |
Removes a | ||
Parameters | osid.id.Id | demographicId | the Id of the Demographic |
osid.id.Id | binId | the Id of the Bin | |
Errors | NOT_FOUND | demographicId or binId not found or
demographicId not assigned to binId | |
NULL_ARGUMENT | demographicId or binId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |