| Interface | osid.personnel.OrganizationRealmAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignOrganizations | ||
| Description |
Tests if this user can alter organization/realm
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 | canAssignOrganizationsToRealm | ||
| Description |
Tests if this user can alter organization/realm
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 | realmId | the Id of the Realm |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | realmId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableRealmIds | ||
| Description |
Gets a list of realms including and under the given realm node in which any organization can be assigned. | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.id.IdList | list of assignable realm Ids | |
| Errors | NULL_ARGUMENT | realmId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableRealmIdsForOrganization | ||
| Description |
Gets a list of realms including and under the given realm node in which a specific organization can be assigned. | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
osid.id.Id | organizationId | the Id of the Organization | |
| Return | osid.id.IdList | list of assignable realm Ids | |
| Errors | NULL_ARGUMENT | realmId or organizationId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignOrganizationToRealm | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | organizationId | the Id of the Organization |
osid.id.Id | realmId | the Id of the Realm | |
| Errors | ALREADY_EXISTS | organizationId already assigned to realmId | |
| NOT_FOUND | organizationId or realmId not found | ||
| NULL_ARGUMENT | organizationId or realmId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignOrganizationFromRealm | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | organizationId | the Id of the Organization |
osid.id.Id | realmId | the Id of the Realm | |
| Errors | NOT_FOUND | organizationId or realmId not found or
organizationId not mapped to realmId | |
| NULL_ARGUMENT | organizationId or realmId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |