OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.OrganizationRealmAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Organizations to Bilings. An Organization may map to multiple Realms and removing the last reference to an Organization is the equivalent of deleting it. Each Realm may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Organization to another Realm is not a copy operation (eg: does not change its Id ).

MethodcanAssignOrganizations
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignOrganizationsToRealm
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdrealmIdthe Id of the Realm
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT realmId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableRealmIds
Description

Gets a list of realms including and under the given realm node in which any organization can be assigned.

Parametersosid.id.IdrealmIdthe Id of the Realm
Returnosid.id.IdListlist of assignable realm Ids
ErrorsNULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableRealmIdsForOrganization
Description

Gets a list of realms including and under the given realm node in which a specific organization can be assigned.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.id.IdorganizationIdthe Id of the Organization
Returnosid.id.IdListlist of assignable realm Ids
ErrorsNULL_ARGUMENT realmId or organizationId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignOrganizationToRealm
Description

Adds an existing Organization to a Realm.

Parametersosid.id.IdorganizationIdthe Id of the Organization
osid.id.IdrealmIdthe Id of the Realm
ErrorsALREADY_EXISTS organizationId already assigned to realmId
NOT_FOUND organizationId or realmId not found
NULL_ARGUMENT organizationId or realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignOrganizationFromRealm
Description

Removes an Organization from a Realm.

Parametersosid.id.IdorganizationIdthe Id of the Organization
osid.id.IdrealmIdthe Id of the Realm
ErrorsNOT_FOUND organizationId or realmId not found or organizationId not mapped to realmId
NULL_ARGUMENT organizationId or realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.