Interface | osid.personnel.OrganizationRealmSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupOrganizationRealmMappings | ||
Description |
Tests if this user can perform lookups of
organization/realm mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeRealmView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryRealmView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getOrganizationIdsByRealm | ||
Description |
Gets the list of Organization Ids associated with a
| ||
Parameters | osid.id.Id | realmId | Id of a Realms. |
Return | osid.id.IdList | list of related organization Ids | |
Errors | NOT_FOUND | realmId is not found | |
NULL_ARGUMENT | realmId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationsByRealm | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | realmId | Id of a Realm |
Return | osid.personnel.OrganizationList | list of related organizations | |
Errors | NOT_FOUND | realmId is not found | |
NULL_ARGUMENT | realmId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationIdsByRealms | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | realmIds | list of realm Ids |
Return | osid.id.IdList | list of organization Ids | |
Errors | NULL_ARGUMENT | realmIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationsByRealms | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | realmIds | list of realm Ids |
Return | osid.personnel.OrganizationList | list of organizations | |
Errors | NULL_ARGUMENT | realmIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRealmIdsByOrganization | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | organizationId | Id of an Organization |
Return | osid.id.IdList | list of realm Ids | |
Errors | NOT_FOUND | organizationId is not found | |
NULL_ARGUMENT | organizationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRealmsByOrganization | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | organizationId | Id of an Organization |
Return | osid.personnel.RealmList | list of realms | |
Errors | NOT_FOUND | organizationId is not found | |
NULL_ARGUMENT | organizationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |