OSID Logo
OSID Specifications
personnel package
Version 3.1.0
Interfaceosid.personnel.PersonnelManager
Implementsosid.OsidManager
osid.personnel.PersonnelProfile
Used Byosid.orchestration.OrchestrationManager
Description

The personnel manager provides access to personnel sessions and provides interoperability tests for various aspects of this service. 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.

Returnosid.personnel.PersonLookupSession a PersonLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonLookup() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.PersonLookupSession a PersonLookupSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPersonLookup() and supportsVisibleFederation() are true
MethodgetPersonQuerySession
Description

Gets the OsidSession associated with the person query service.

Returnosid.personnel.PersonQuerySession a PersonQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonQuery() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.PersonQuerySession a PersonQuerySession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPersonQuery() and supportsVisibleFederation() are true
MethodgetPersonSearchSession
Description

Gets the OsidSession associated with the person search service.

Returnosid.personnel.PersonSearchSession a PersonSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonSearch() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.PersonSearchSession a PersonSearchSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPersonSearch() and supportsVisibleFederation() are true
MethodgetPersonAdminSession
Description

Gets the OsidSession associated with the person administration service.

Returnosid.personnel.PersonAdminSession a PersonAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonAdmin() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.PersonAdminSession a PersonAdminSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPersonAdmin() and supportsVisibleFederation() are true
MethodgetPersonNotificationSession
Description

Gets the OsidSession associated with the person notification service.

Parametersosid.personnel.PersonReceiverpersonReceiver the receiver
Returnosid.personnel.PersonNotificationSession a PersonNotificationSession
ErrorsNULL_ARGUMENT personReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonNotification() is false
Complianceoptional This 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.PersonReceiverpersonReceiver the receiver
osid.id.IdrealmId the Id of the Realm
Returnosid.personnel.PersonNotificationSession a PersonNotificationSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT personReceiver or realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPersonNotification() and supportsVisibleFederation() are true
MethodgetPersonRealmSession
Description

Gets the session for retrieving person to realm mappings.

Returnosid.personnel.PersonRealmSession a PersonRealmSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonRealm() is false
Complianceoptional This method must be implemented if supportsPersonRealm() is true.
MethodgetPersonRealmAssignmentSession
Description

Gets the session for assigning person to realm mappings.

Returnosid.personnel.PersonRealmAssignmentSession a PersonRealmAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonRealmAssignment() is false
Complianceoptional This method must be implemented if supportsPersonRealmAssignment() is true.
MethodgetPersonSmartRealmSession
Description

Gets the session associated with the person smart realm for the given realm.

Parametersosid.id.IdrealmId the Id of the realm
Returnosid.personnel.PersonSmartRealmSession a PersonSmartRealmSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonSmartRealm() is false
Complianceoptional This method must be implemented if supportsPersonSmartRealm() is true.
MethodgetOrganizationLookupSession
Description

Gets the OsidSession associated with the organization lookup service.

Returnosid.personnel.OrganizationLookupSession an OrganizationLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationLookup() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.OrganizationLookupSession an OrganizationLookupSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOrganizationLookup() and supportsVisibleFederation() are true
MethodgetOrganizationQuerySession
Description

Gets the OsidSession associated with the organization query service.

Returnosid.personnel.OrganizationQuerySession an OrganizationQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationQuery() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.OrganizationQuerySession an OrganizationQuerySession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOrganizationQuery() and supportsVisibleFederation() are true
MethodgetOrganizationSearchSession
Description

Gets the OsidSession associated with the organization search service.

Returnosid.personnel.OrganizationSearchSession an OrganizationSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationSearch() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.OrganizationSearchSession an OrganizationSearchSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOrganizationSearch() and supportsVisibleFederation() are true
MethodgetOrganizationAdminSession
Description

Gets the OsidSession associated with the organization administration service.

Returnosid.personnel.OrganizationAdminSession an OrganizationAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationAdmin() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.OrganizationAdminSession an OrganizationAdminSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOrganizationAdmin() and supportsVisibleFederation() are true
MethodgetOrganizationNotificationSession
Description

Gets the OsidSession associated with the organization notification service.

Parametersosid.personnel.OrganizationReceiverorganizationReceiver the receiver
Returnosid.personnel.OrganizationNotificationSession an OrganizationNotificationSession
ErrorsNULL_ARGUMENT organizationReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationNotification() is false
Complianceoptional This 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.OrganizationReceiverorganizationReceiver the receiver
osid.id.IdrealmId the Id of the Realm
Returnosid.personnel.OrganizationNotificationSession an OrganizationNotificationSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT organizationReceiver or realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOrganizationNotification() and supportsVisibleFederation() are true
MethodgetOrganizationHierarchySession
Description

Gets the session traversing organization hierarchies.

Returnosid.personnel.OrganizationHierarchySession an OrganizationHierarchySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationHierarchy() is false
Complianceoptional This 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.IdrealmId the Id of the realm
Returnosid.personnel.OrganizationHierarchySession an OrganizationHierarchySession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationHierarchy() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOrganizationHierarchy() and supportsVisibleFederation() are true.
MethodgetOrganizationHierarchyDesignSession
Description

Gets the session designing organization hierarchies.

Returnosid.personnel.OrganizationHierarchyDesignSession an OrganizationHierarchyDesignSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationHierarchyDesign() is false
Complianceoptional This 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.IdrealmId the Id of the realm
Returnosid.personnel.OrganizationHierarchyDesignSession an OrganizationHierarchyDesignSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationHierarchyDesign() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOrganizationHierarchyDesign() and supportsVisibleFederation() are true.
MethodgetOrganizationRealmSession
Description

Gets the session for retrieving organization to realm mappings.

Returnosid.personnel.OrganizationRealmSession an OrganizationRealmSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationRealm() is false
Complianceoptional This method must be implemented if supportsOrganizationRealm() is true.
MethodgetOrganizationRealmAssignmentSession
Description

Gets the session for assigning organization to realm mappings.

Returnosid.personnel.OrganizationRealmAssignmentSession an OrganizationRealmAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationRealmAssignment() is false
Complianceoptional This method must be implemented if supportsOrganizationRealmAssignment() is true.
MethodgetOrganizationSmartRealmSession
Description

Gets the session associated with the organization smart realm for the given realm.

Parametersosid.id.IdrealmId the Id of the realm
Returnosid.personnel.OrganizationSmartRealmSession an OrganizationSmartRealmSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrganizationSmartRealm() is false
Complianceoptional This method must be implemented if supportsOrganizationSmartRealm() is true.
MethodgetPositionLookupSession
Description

Gets the OsidSession associated with the position lookup service.

Returnosid.personnel.PositionLookupSession a PositionLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionLookup() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.PositionLookupSession a PositionLookupSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPositionLookup() and supportsVisibleFederation() are true
MethodgetPositionQuerySession
Description

Gets the OsidSession associated with the position query service.

Returnosid.personnel.PositionQuerySession a PositionQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionQuery() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.PositionQuerySession a PositionQuerySession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPositionQuery() and supportsVisibleFederation() are true
MethodgetPositionSearchSession
Description

Gets the OsidSession associated with the position search service.

Returnosid.personnel.PositionSearchSession a PositionSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionSearch() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.PositionSearchSession a PositionSearchSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPositionSearch() and supportsVisibleFederation() are true
MethodgetPositionAdminSession
Description

Gets the OsidSession associated with the position administration service.

Returnosid.personnel.PositionAdminSession a PositionAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionAdmin() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.PositionAdminSession a PositionAdminSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPositionAdmin() and supportsVisibleFederation() are true
MethodgetPositionNotificationSession
Description

Gets the OsidSession associated with the position notification service.

Parametersosid.personnel.PositionReceiverpositionReceiver the receiver
Returnosid.personnel.PositionNotificationSession a PositionNotificationSession
ErrorsNULL_ARGUMENT positionReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionNotification() is false
Complianceoptional This 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.PositionReceiverpositionReceiver the receiver
osid.id.IdrealmId the Id of the Realm
Returnosid.personnel.PositionNotificationSession a PositionNotificationSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT positionReceiver or realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPositionNotification() and supportsVisibleFederation() are true
MethodgetPositionRealmSession
Description

Gets the session for retrieving position to realm mappings.

Returnosid.personnel.PositionRealmSession a PositionRealmSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionRealm() is false
Complianceoptional This method must be implemented if supportsPositionRealm() is true.
MethodgetPositionRealmAssignmentSession
Description

Gets the session for assigning position to realm mappings.

Returnosid.personnel.PositionRealmAssignmentSession a PositionRealmAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionRealmAssignment() is false
Complianceoptional This method must be implemented if supportsPositionRealmAssignment() is true.
MethodgetPositionSmartRealmSession
Description

Gets the session associated with the position smart realm for the given realm.

Parametersosid.id.IdrealmId the Id of the realm
Returnosid.personnel.PositionSmartRealmSession a PositionSmartRealmSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPositionSmartRealm() is false
Complianceoptional This method must be implemented if supportsPositionSmartRealm() is true.
MethodgetAppointmentLookupSession
Description

Gets the OsidSession associated with the appointment lookup service.

Returnosid.personnel.AppointmentLookupSession an AppointmentLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentLookup() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.AppointmentLookupSession an AppointmentLookupSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAppointmentLookup() and supportsVisibleFederation() are true
MethodgetAppointmentQuerySession
Description

Gets the OsidSession associated with the appointment query service.

Returnosid.personnel.AppointmentQuerySession an AppointmentQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentQuery() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.AppointmentQuerySession an AppointmentQuerySession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAppointmentQuery() and supportsVisibleFederation() are true
MethodgetAppointmentSearchSession
Description

Gets the OsidSession associated with the appointment search service.

Returnosid.personnel.AppointmentSearchSession an AppointmentSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentSearch() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.AppointmentSearchSession an AppointmentSearchSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAppointmentSearch() and supportsVisibleFederation() are true
MethodgetAppointmentAdminSession
Description

Gets the OsidSession associated with the appointment administration service.

Returnosid.personnel.AppointmentAdminSession an AppointmentAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentAdmin() is false
Complianceoptional This 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.IdrealmId the Id of the Realm
Returnosid.personnel.AppointmentAdminSession an AppointmentAdminSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAppointmentAdmin() and supportsVisibleFederation() are true
MethodgetAppointmentNotificationSession
Description

Gets the OsidSession associated with the appointment notification service.

Parametersosid.personnel.AppointmentReceiverappointmentReceiver the receiver
Returnosid.personnel.AppointmentNotificationSession an AppointmentNotificationSession
ErrorsNULL_ARGUMENT appointmentReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentNotification() is false
Complianceoptional This 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.AppointmentReceiverappointmentReceiver the receiver
osid.id.IdrealmId the Id of the Realm
Returnosid.personnel.AppointmentNotificationSession an AppointmentNotificationSession
ErrorsNOT_FOUND no Realm found by the given Id
NULL_ARGUMENT appointmentReceiver or realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAppointmentNotification() and supportsVisibleFederation() are true
MethodgetAppointmentRealmSession
Description

Gets the session for retrieving appointment to realm mappings.

Returnosid.personnel.AppointmentRealmSession an AppointmentRealmSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentRealm() is false
Complianceoptional This method must be implemented if supportsAppointmentRealm() is true.
MethodgetAppointmentRealmAssignmentSession
Description

Gets the session for assigning appointment to realm mappings.

Returnosid.personnel.AppointmentRealmAssignmentSession an AppointmentRealmAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentRealmAssignment() is false
Complianceoptional This method must be implemented if supportsAppointmentRealmAssignment() is true.
MethodgetAppointmentSmartRealmSession
Description

Gets the session associated with the appointment smart realm for the given realm.

Parametersosid.id.IdrealmId the Id of the realm
Returnosid.personnel.AppointmentSmartRealmSession an AppointmentSmartRealmSession
ErrorsNOT_FOUND realmId not found
NULL_ARGUMENT realmId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAppointmentSmartRealm() is false
Complianceoptional This method must be implemented if supportsAppointmenSmarttRealm() is true.
MethodgetRealmLookupSession
Description

Gets the OsidSession associated with the realm lookup service.

Returnosid.personnel.RealmLookupSession a RealmLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRealmLookup() is false
Complianceoptional This method must be implemented if supportsRealmLookup() is true.
MethodgetRealmQuerySession
Description

Gets the OsidSession associated with the realm query service.

Returnosid.personnel.RealmQuerySession a RealmQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRealmQuery() is false
Complianceoptional This method must be implemented if supportsRealmQuery() is true.
MethodgetRealmSearchSession
Description

Gets the OsidSession associated with the realm search service.

Returnosid.personnel.RealmSearchSession a RealmSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRealmSearch() is false
Complianceoptional This method must be implemented if supportsRealmSearch() is true.
MethodgetRealmAdminSession
Description

Gets the OsidSession associated with the realm administrative service.

Returnosid.personnel.RealmAdminSession a RealmAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRealmAdmin() is false
Complianceoptional This method must be implemented if supportsRealmAdmin() is true.
MethodgetRealmNotificationSession
Description

Gets the OsidSession associated with the realm notification service.

Parametersosid.personnel.RealmReceiverrealmReceiver the receiver
Returnosid.personnel.RealmNotificationSession a RealmNotificationSession
ErrorsNULL_ARGUMENT realmReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRealmNotification() is false
Complianceoptional This method must be implemented if supportsRealmNotification() is true.
MethodgetRealmHierarchySession
Description

Gets the OsidSession associated with the realm hierarchy service.

Returnosid.personnel.RealmHierarchySession a RealmHierarchySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRealmHierarchy() is false
Complianceoptional This method must be implemented if supportsRealmHierarchy() is true.
MethodgetRealmHierarchyDesignSession
Description

Gets the OsidSession associated with the realm hierarchy design service.

Returnosid.personnel.RealmHierarchyDesignSession a RealmHierarchyDesignSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRealmHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsRealmHierarchyDesign() is true.
MethodgetPersonnelBatchManager
Description

Gets a PersonnelBatchManager.

Returnosid.personnel.batch.PersonnelBatchManager a PersonnelBatchManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPersonnelBatch() is false
Complianceoptional This method must be implemented if supportsPersonnelBatch() is true.