OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PersonnelProxyManager
Implementsosid.OsidProxyManager
osid.personnel.PersonnelProfile
Description

The personnel manager provides access to personnel sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy interface for passing information from a server environment. The sessions included in this manager are:

  • PersonLookupSession: a session to lookup persons
  • PersonQuerySession: a session for querying persons
  • PersonSearchSession: a session to search persons
  • PersonAdminSession: a session to manage persons
  • PersonNotificationSession: a session to subscribe to notifications of person changes
  • PersonRealmSession: a session to look up person to realm mappings
  • PersonRealmAssignmentSession: a session to manage person to realm mappings
  • PersonSmartRealmSession: a session to manage dynamic person to realm mappings
  • OrganizationLookupSession: a session to lookup organizations
  • OrganizationQuerySession: a session for querying organizations
  • OrganizationSearchSession: a session to search organizations
  • OrganizationAdminSession: a session to manage organizations
  • OrganizationNotificationSession: a session to subscribe to notifications of organization changes
  • OrganizationHierarchySession: a session to traverse organization hierarchies
  • OrganizationHierarchyDesignSession: a sesion to manage organization hierarchies
  • OrganizationRealmSession: a session to look up organization to realm mappings
  • OrganizationRealmAssignmentSession: a session to manage organization to realm mappings
  • OrganizationSmartRealmSession: a session to manage dynamic organization to realm mappings
  • PositionLookupSession: a session to lookup positions
  • PositionQuerySession: a session for querying positions
  • PositionSearchSession: a session to search positions
  • PositionAdminSession: a session to manage positions
  • PositionNotificationSession: a session to subscribe to notifications of position changes
  • PositionRealmSession: a session to look up position to realm mappings
  • PositionRealmAssignmentSession: a session to manage position to realm mappings
  • PositionSmartRealmSession: a session to manage dynamic position to realm mappings
  • AppointmentLookupSession: a session to lookup appointments
  • AppointmentQuerySession: a session for querying appointments
  • AppointmentSearchSession: a session to search appointments
  • AppointmentAdminSession: a session to manage appointments
  • AppointmentNotificationSession: a session to subscribe to notifications of appointment changes
  • AppointmentRealmSession: a session to look up appointment to realm mappings
  • AppointmentRealmAssignmentSession: a session to manage appointment to realm mappings
  • AppointmentSmartRealmSession: a session to manage dynamic appointment to realm mappings
  • RealmLookupSession: a session to retrieve realms
  • RealmQuerySession: a session for querying realms
  • RealmSearchSession: a session to search for realms
  • RealmAdminSession: a session to create, update and delete realms
  • RealmNotificationSession: a session to receive notifications for changes in realms
  • RealmHierarchyTraversalSession: a session to traverse hierarchies of realms
  • RealmHierarchyDesignSession: a session to manage hierarchies of realms

The personnel manager also provides a profile for determing the supported search types supported by this service.

MethodgetPersonLookupSession
Description

Gets the OsidSession associated with the person lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonLookupSessiona PersonLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonLookup() is false
ComplianceoptionalThis method must be implemented if supportsPersonLookup() is true.
MethodgetPersonLookupSessionForRealm
Description

Gets the OsidSession associated with the person lookup service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonLookupSessiona PersonLookupSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPersonLookup() and supportsVisibleFederation() are true
MethodgetPersonQuerySession
Description

Gets the OsidSession associated with the person query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonQuerySessiona PersonQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonQuery() is false
ComplianceoptionalThis method must be implemented if supportsPersonQuery() is true.
MethodgetPersonQuerySessionForRealm
Description

Gets the OsidSession associated with the person query service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonQuerySessiona PersonQuerySession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPersonQuery() and supportsVisibleFederation() are true
MethodgetPersonSearchSession
Description

Gets the OsidSession associated with the person search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonSearchSessiona PersonSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonSearch() is false
ComplianceoptionalThis method must be implemented if supportsPersonSearch() is true.
MethodgetPersonSearchSessionForRealm
Description

Gets the OsidSession associated with the person search service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonSearchSessiona PersonSearchSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPersonSearch() and supportsVisibleFederation() are true
MethodgetPersonAdminSession
Description

Gets the OsidSession associated with the person administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonAdminSessiona PersonAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPersonAdmin() is true.
MethodgetPersonAdminSessionForRealm
Description

Gets the OsidSession associated with the person administration service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonAdminSessiona PersonAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPersonAdmin() and supportsVisibleFederation() are true
MethodgetPersonNotificationSession
Description

Gets the OsidSession associated with the person notification service.

Parametersosid.personnel.PersonReceiverpersonReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonNotificationSessiona PersonNotificationSession
ErrorsNULL_ARGUMENT personReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonNotification() is false
ComplianceoptionalThis method must be implemented if supportsPersonNotification() is true.
MethodgetPersonNotificationSessionForRealm
Description

Gets the OsidSession associated with the person notification service for the given realm.

Parametersosid.personnel.PersonReceiverpersonReceiverthe receiver
osid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonNotificationSessiona PersonNotificationSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT personReceiver, realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPersonNotification() and supportsVisibleFederation() are true
MethodgetPersonRealmSession
Description

Gets the session for retrieving person to realm mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonRealmSessiona PersonRealmSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonRealm() is false
ComplianceoptionalThis method must be implemented if supportsPersonRealm() is true.
MethodgetPersonRealmAssignmentSession
Description

Gets the session for assigning person to realm mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonRealmAssignmentSessiona PersonRealmAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonRealmAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPersonRealmAssignment() is true.
MethodgetPersonSmartRealmSession
Description

Gets the session for managing dynamic person realms for the given realm.

Parametersosid.id.IdrealmIdthe Id of a realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PersonSmartRealmSessiona PersonSmartRealmSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonSmartRealm() is false
ComplianceoptionalThis method must be implemented if supportsPersonSmartRealm() is true.
MethodgetOrganizationLookupSession
Description

Gets the OsidSession associated with the organization lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationLookupSessionan OrganizationLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationLookup() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationLookup() is true.
MethodgetOrganizationLookupSessionForRealm
Description

Gets the OsidSession associated with the organization lookup service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationLookupSessionan OrganizationLookupSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationLookup() and supportsVisibleFederation() are true
MethodgetOrganizationQuerySession
Description

Gets the OsidSession associated with the organization query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationQuerySessionan OrganizationQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationQuery() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationQuery() is true.
MethodgetOrganizationQuerySessionForRealm
Description

Gets the OsidSession associated with the organization query service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationQuerySessionan OrganizationQuerySession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationQuery() and supportsVisibleFederation() are true
MethodgetOrganizationSearchSession
Description

Gets the OsidSession associated with the organization search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationSearchSessionan OrganizationSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationSearch() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationSearch() is true.
MethodgetOrganizationSearchSessionForRealm
Description

Gets the OsidSession associated with the organization search service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationSearchSessionan OrganizationSearchSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationSearch() and supportsVisibleFederation() are true
MethodgetOrganizationAdminSession
Description

Gets the OsidSession associated with the organization administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationAdminSessionan OrganizationAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationAdmin() is true.
MethodgetOrganizationAdminSessionForRealm
Description

Gets the OsidSession associated with the organization administration service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationAdminSessionan OrganizationAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationAdmin() and supportsVisibleFederation() are true
MethodgetOrganizationNotificationSession
Description

Gets the OsidSession associated with the organization notification service.

Parametersosid.personnel.OrganizationReceiverorganizationReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationNotificationSessionan OrganizationNotificationSession
ErrorsNULL_ARGUMENT organizationReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationNotification() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationNotification() is true.
MethodgetOrganizationNotificationSessionForRealm
Description

Gets the OsidSession associated with the organization notification service for the given realm.

Parametersosid.personnel.OrganizationReceiverorganizationReceiverthe receiver
osid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationNotificationSessionan OrganizationNotificationSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT organizationReceiver, realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationNotification() and supportsVisibleFederation() are true
MethodgetOrganizationHierarchySession
Description

Gets the session traversing organization hierarchies.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationHierarchySessionan OrganizationHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationHierarchy() is true.
MethodgetOrganizationHierarchySessionForRealm
Description

Gets the OsidSession associated with the organization heirarchy traversal service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationHierarchySessionan OrganizationHierarchySession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationHierarchy() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationHierarchy() and supportsVisibleFederation() are true.
MethodgetOrganizationHierarchyDesignSession
Description

Gets the session designing organization hierarchies.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationHierarchyDesignSessionan OrganizationHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationHierarchyDesign() is true.
MethodgetOrganizationHierarchyDesignSessionForRealm
Description

Gets the OsidSession associated with the organization heirarchy design service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationHierarchyDesignSessionan OrganizationHierarchyDesignSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationHierarchyDesign() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationHierarchyDesign() and supportsVisibleFederation() are true.
MethodgetOrganizationRealmSession
Description

Gets the session for retrieving organization to realm mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationRealmSessionan OrganizationRealmSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationRealm() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationRealm() is true.
MethodgetOrganizationRealmAssignmentSession
Description

Gets the session for assigning organization to realm mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationRealmAssignmentSessionan OrganizationRealmAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationRealmAssignment() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationRealmAssignment() is true.
MethodgetOrganizationSmartRealmSession
Description

Gets the session for managing dynamic organization realms for the given realm.

Parametersosid.id.IdrealmIdthe Id of a realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.OrganizationSmartRealmSessionan OrganizationSmartRealmSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationSmartRealm() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationSmartRealm() is true.
MethodgetPositionLookupSession
Description

Gets the OsidSession associated with the position lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionLookupSessiona PositionLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionLookup() is false
ComplianceoptionalThis method must be implemented if supportsPositionLookup() is true.
MethodgetPositionLookupSessionForRealm
Description

Gets the OsidSession associated with the position lookup service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionLookupSessiona PositionLookupSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPositionLookup() and supportsVisibleFederation() are true
MethodgetPositionQuerySession
Description

Gets the OsidSession associated with the position query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionQuerySessiona PositionQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionQuery() is false
ComplianceoptionalThis method must be implemented if supportsPositionQuery() is true.
MethodgetPositionQuerySessionForRealm
Description

Gets the OsidSession associated with the position query service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionQuerySessiona PositionQuerySession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPositionQuery() and supportsVisibleFederation() are true
MethodgetPositionSearchSession
Description

Gets the OsidSession associated with the position search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionSearchSessiona PositionSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionSearch() is false
ComplianceoptionalThis method must be implemented if supportsPositionSearch() is true.
MethodgetPositionSearchSessionForRealm
Description

Gets the OsidSession associated with the position search service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionSearchSessiona PositionSearchSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPositionSearch() and supportsVisibleFederation() are true
MethodgetPositionAdminSession
Description

Gets the OsidSession associated with the position administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionAdminSessiona PositionAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPositionAdmin() is true.
MethodgetPositionAdminSessionForRealm
Description

Gets the OsidSession associated with the position administration service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionAdminSessiona PositionAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPositionAdmin() and supportsVisibleFederation() are true
MethodgetPositionNotificationSession
Description

Gets the OsidSession associated with the position notification service.

Parametersosid.personnel.PositionReceiverpositionReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionNotificationSessiona PositionNotificationSession
ErrorsNULL_ARGUMENT positionReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionNotification() is false
ComplianceoptionalThis method must be implemented if supportsPositionNotification() is true.
MethodgetPositionNotificationSessionForRealm
Description

Gets the OsidSession associated with the position notification service for the given realm.

Parametersosid.personnel.PositionReceiverpositionReceiverthe receiver
osid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionNotificationSessiona PositionNotificationSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT positionReceiver, realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPositionNotification() and supportsVisibleFederation() are true
MethodgetPositionRealmSession
Description

Gets the session for retrieving position to realm mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionRealmSessiona PositionRealmSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionRealm() is false
ComplianceoptionalThis method must be implemented if supportsPositionRealm() is true.
MethodgetPositionRealmAssignmentSession
Description

Gets the session for assigning position to realm mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionRealmAssignmentSessiona PositionRealmAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionRealmAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPositionRealmAssignment() is true.
MethodgetPositionSmartRealmSession
Description

Gets the session for managing dynamic position realms for the given realm.

Parametersosid.id.IdrealmIdthe Id of a realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.PositionSmartRealmSessiona PositionSmartRealmSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionSmartRealm() is false
ComplianceoptionalThis method must be implemented if supportsPositionSmartRealm() is true.
MethodgetAppointmentLookupSession
Description

Gets the OsidSession associated with the appointment lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentLookupSessionan AppointmentLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentLookup() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentLookup() is true.
MethodgetAppointmentLookupSessionForRealm
Description

Gets the OsidSession associated with the appointment lookup service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentLookupSessionan AppointmentLookupSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentLookup() and supportsVisibleFederation() are true
MethodgetAppointmentQuerySession
Description

Gets the OsidSession associated with the appointment query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentQuerySessionan AppointmentQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentQuery() is true.
MethodgetAppointmentQuerySessionForRealm
Description

Gets the OsidSession associated with the appointment query service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentQuerySessionan AppointmentQuerySession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentQuery() and supportsVisibleFederation() are true
MethodgetAppointmentSearchSession
Description

Gets the OsidSession associated with the appointment search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentSearchSessionan AppointmentSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentSearch() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentSearch() is true.
MethodgetAppointmentSearchSessionForRealm
Description

Gets the OsidSession associated with the appointment search service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentSearchSessionan AppointmentSearchSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentSearch() and supportsVisibleFederation() are true
MethodgetAppointmentAdminSession
Description

Gets the OsidSession associated with the appointment administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentAdminSessionan AppointmentAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentAdmin() is true.
MethodgetAppointmentAdminSessionForRealm
Description

Gets the OsidSession associated with the appointment administration service for the given realm.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentAdminSessionan AppointmentAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentAdmin() and supportsVisibleFederation() are true
MethodgetAppointmentNotificationSession
Description

Gets the OsidSession associated with the appointment notification service.

Parametersosid.personnel.AppointmentReceiverappointmentReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentNotificationSessionan AppointmentNotificationSession
ErrorsNULL_ARGUMENT appointmentReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentNotification() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentNotification() is true.
MethodgetAppointmentNotificationSessionForRealm
Description

Gets the OsidSession associated with the appointment notification service for the given realm.

Parametersosid.personnel.AppointmentReceiverappointmentReceiverthe receiver
osid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentNotificationSessionan AppointmentNotificationSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT appointmentReceiver, realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentNotification() and supportsVisibleFederation() are true
MethodgetAppointmentRealmSession
Description

Gets the session for retrieving appointment to realm mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentRealmSessionan AppointmentRealmSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentRealm() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentRealm() is true.
MethodgetAppointmentRealmAssignmentSession
Description

Gets the session for assigning appointment to realm mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentRealmAssignmentSessionan AppointmentRealmAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentRealmAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentRealmAssignment() is true.
MethodgetAppointmentSmartRealmSession
Description

Gets the session for managing dynamic appointment realms for the given realm.

Parametersosid.id.IdrealmIdthe Id of a realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.AppointmentSmartRealmSessionan AppointmentSmartRealmSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentSmartRealm() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentSmartRealm() is true.
MethodgetRealmLookupSession
Description

Gets the OsidSession associated with the realm lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.RealmLookupSessiona RealmLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmLookup() is false
ComplianceoptionalThis method must be implemented if supportsRealmLookup() is true.
MethodgetRealmQuerySession
Description

Gets the OsidSession associated with the realm query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.RealmQuerySessiona RealmQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmQuery() is false
ComplianceoptionalThis method must be implemented if supportsRealmQuery() is true.
MethodgetRealmSearchSession
Description

Gets the OsidSession associated with the realm search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.RealmSearchSessiona RealmSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmSearch() is false
ComplianceoptionalThis method must be implemented if supportsRealmSearch() is true.
MethodgetRealmAdminSession
Description

Gets the OsidSession associated with the realm administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.RealmAdminSessiona RealmAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRealmAdmin() is true.
MethodgetRealmNotificationSession
Description

Gets the OsidSession associated with the realm notification service.

Parametersosid.personnel.RealmReceiverrealmReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.personnel.RealmNotificationSessiona RealmNotificationSession
ErrorsNULL_ARGUMENT realmReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmNotification() is false
ComplianceoptionalThis method must be implemented if supportsRealmNotification() is true.
MethodgetRealmHierarchySession
Description

Gets the OsidSession associated with the realm hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.RealmHierarchySessiona RealmHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsRealmHierarchy() is true.
MethodgetRealmHierarchyDesignSession
Description

Gets the OsidSession associated with the realm hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.RealmHierarchyDesignSessiona RealmHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsRealmHierarchyDesign() is true.
MethodgetPersonnelBatchProxyManager
Description

Gets a PersonnelBatchProxyManager.

Returnosid.personnel.batch.PersonnelBatchProxyManagera PersonnelBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonnelBatch() is false
ComplianceoptionalThis method must be implemented if supportsPersonnelBatch() is true.