| Interface | osid.personnel.PersonnelManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.personnel.PersonnelProfile | |||
| 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:
The personnel manager also provides a profile for determing the supported search types supported by this service. | ||
| Method | getPersonLookupSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.PersonLookupSession | a PersonLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPersonLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonLookup() is
true. | |
| Method | getPersonLookupSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.PersonLookupSession | a PersonLookupSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPersonLookup()
and supportsVisibleFederation() are true | |
| Method | getPersonQuerySession | ||
| Description |
Gets the | ||
| Return | osid.personnel.PersonQuerySession | a PersonQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPersonQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonQuery() is
true. | |
| Method | getPersonQuerySessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.PersonQuerySession | a PersonQuerySession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPersonQuery() and
supportsVisibleFederation() are true | |
| Method | getPersonSearchSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.PersonSearchSession | a PersonSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPersonSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonSearch() is
true. | |
| Method | getPersonSearchSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.PersonSearchSession | a PersonSearchSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPersonSearch()
and supportsVisibleFederation() are true | |
| Method | getPersonAdminSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.PersonAdminSession | a PersonAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPersonAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonAdmin() is
true. | |
| Method | getPersonAdminSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.PersonAdminSession | a PersonAdminSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPersonAdmin() and
supportsVisibleFederation() are true | |
| Method | getPersonNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.PersonReceiver | personReceiver | the receiver |
| Return | osid.personnel.PersonNotificationSession | a PersonNotificationSession | |
| Errors | NULL_ARGUMENT | personReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPersonNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonNotification()
is true. | |
| Method | getPersonNotificationSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.PersonReceiver | personReceiver | the receiver |
osid.id.Id | realmId | the Id of the Realm | |
| Return | osid.personnel.PersonNotificationSession | a PersonNotificationSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPersonNotification()
and supportsVisibleFederation() are true | |
| Method | getPersonRealmSession | ||
| Description |
Gets the session for retrieving person to realm mappings. | ||
| Return | osid.personnel.PersonRealmSession | a PersonRealmSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPersonRealm() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonRealm() is
true. | |
| Method | getPersonRealmAssignmentSession | ||
| Description |
Gets the session for assigning person to realm mappings. | ||
| Return | osid.personnel.PersonRealmAssignmentSession | a PersonRealmAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPersonRealmAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonRealmAssignment()
is true. | |
| Method | getPersonSmartRealmSession | ||
| Description |
Gets the session associated with the person smart realm for the given realm. | ||
| Parameters | osid.id.Id | realmId | the Id of the realm |
| Return | osid.personnel.PersonSmartRealmSession | a PersonSmartRealmSession | |
| Errors | NOT_FOUND | realmId not found | |
| NULL_ARGUMENT | realmId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPersonSmartRealm() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonSmartRealm()
is true. | |
| Method | getOrganizationLookupSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.OrganizationLookupSession | an OrganizationLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOrganizationLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsOrganizationLookup()
is true. | |
| Method | getOrganizationLookupSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.OrganizationLookupSession | an OrganizationLookupSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsOrganizationLookup()
and supportsVisibleFederation() are true | |
| Method | getOrganizationQuerySession | ||
| Description |
Gets the | ||
| Return | osid.personnel.OrganizationQuerySession | an OrganizationQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOrganizationQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsOrganizationQuery()
is true. | |
| Method | getOrganizationQuerySessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.OrganizationQuerySession | an OrganizationQuerySession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsOrganizationQuery()
and supportsVisibleFederation() are true | |
| Method | getOrganizationSearchSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.OrganizationSearchSession | an OrganizationSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOrganizationSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsOrganizationSearch()
is true. | |
| Method | getOrganizationSearchSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.OrganizationSearchSession | an OrganizationSearchSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsOrganizationSearch()
and supportsVisibleFederation() are true | |
| Method | getOrganizationAdminSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.OrganizationAdminSession | an OrganizationAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOrganizationAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsOrganizationAdmin()
is true. | |
| Method | getOrganizationAdminSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.OrganizationAdminSession | an OrganizationAdminSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsOrganizationAdmin()
and supportsVisibleFederation() are true | |
| Method | getOrganizationNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.OrganizationReceiver | organizationReceiver | the receiver |
| Return | osid.personnel.OrganizationNotificationSession | an OrganizationNotificationSession | |
| Errors | NULL_ARGUMENT | organizationReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsOrganizationNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsOrganizationNotification() is true. | |
| Method | getOrganizationNotificationSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.OrganizationReceiver | organizationReceiver | the receiver |
osid.id.Id | realmId | the Id of the Realm | |
| Return | osid.personnel.OrganizationNotificationSession | an OrganizationNotificationSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if
supportsOrganizationNotification() and
supportsVisibleFederation() are true | |
| Method | getOrganizationHierarchySession | ||
| Description |
Gets the session traversing organization hierarchies. | ||
| Return | osid.personnel.OrganizationHierarchySession | an OrganizationHierarchySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOrganizationHierarchy() is false | ||
| Compliance | optional | This method must be implemented if supportsOrganizationHierarchy()
is true. | |
| Method | getOrganizationHierarchySessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the realm |
| Return | osid.personnel.OrganizationHierarchySession | an OrganizationHierarchySession | |
| Errors | NOT_FOUND | realmId not found | |
| NULL_ARGUMENT | realmId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsOrganizationHierarchy() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsOrganizationHierarchy()
and supportsVisibleFederation() are true.
| |
| Method | getOrganizationHierarchyDesignSession | ||
| Description |
Gets the session designing organization hierarchies. | ||
| Return | osid.personnel.OrganizationHierarchyDesignSession | an OrganizationHierarchyDesignSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOrganizationHierarchyDesign() is false | ||
| Compliance | optional | This method must be implemented if
supportsOrganizationHierarchyDesign() is true. | |
| Method | getOrganizationHierarchyDesignSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the realm |
| Return | osid.personnel.OrganizationHierarchyDesignSession | an OrganizationHierarchyDesignSession | |
| Errors | NOT_FOUND | realmId not found | |
| NULL_ARGUMENT | realmId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsOrganizationHierarchyDesign() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsOrganizationHierarchyDesign() and
supportsVisibleFederation() are true. | |
| Method | getOrganizationRealmSession | ||
| Description |
Gets the session for retrieving organization to realm mappings. | ||
| Return | osid.personnel.OrganizationRealmSession | an OrganizationRealmSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOrganizationRealm() is false | ||
| Compliance | optional | This method must be implemented if supportsOrganizationRealm()
is true. | |
| Method | getOrganizationRealmAssignmentSession | ||
| Description |
Gets the session for assigning organization to realm mappings. | ||
| Return | osid.personnel.OrganizationRealmAssignmentSession | an OrganizationRealmAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOrganizationRealmAssignment() is false
| ||
| Compliance | optional | This method must be implemented if
supportsOrganizationRealmAssignment() is true. | |
| Method | getOrganizationSmartRealmSession | ||
| Description |
Gets the session associated with the organization smart realm for the given realm. | ||
| Parameters | osid.id.Id | realmId | the Id of the realm |
| Return | osid.personnel.OrganizationSmartRealmSession | an OrganizationSmartRealmSession | |
| Errors | NOT_FOUND | realmId not found | |
| NULL_ARGUMENT | realmId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsOrganizationSmartRealm() is false | ||
| Compliance | optional | This method must be implemented if supportsOrganizationSmartRealm()
is true. | |
| Method | getPositionLookupSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.PositionLookupSession | a PositionLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPositionLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsPositionLookup()
is true. | |
| Method | getPositionLookupSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.PositionLookupSession | a PositionLookupSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPositionLookup()
and supportsVisibleFederation() are true | |
| Method | getPositionQuerySession | ||
| Description |
Gets the | ||
| Return | osid.personnel.PositionQuerySession | a PositionQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPositionQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsPositionQuery()
is true. | |
| Method | getPositionQuerySessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.PositionQuerySession | a PositionQuerySession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPositionQuery()
and supportsVisibleFederation() are true | |
| Method | getPositionSearchSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.PositionSearchSession | a PositionSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPositionSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsPositionSearch()
is true. | |
| Method | getPositionSearchSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.PositionSearchSession | a PositionSearchSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPositionSearch()
and supportsVisibleFederation() are true | |
| Method | getPositionAdminSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.PositionAdminSession | a PositionAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPositionAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsPositionAdmin()
is true. | |
| Method | getPositionAdminSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.PositionAdminSession | a PositionAdminSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPositionAdmin()
and supportsVisibleFederation() are true | |
| Method | getPositionNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.PositionReceiver | positionReceiver | the receiver |
| Return | osid.personnel.PositionNotificationSession | a PositionNotificationSession | |
| Errors | NULL_ARGUMENT | positionReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPositionNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsPositionNotification()
is true. | |
| Method | getPositionNotificationSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.PositionReceiver | positionReceiver | the receiver |
osid.id.Id | realmId | the Id of the Realm | |
| Return | osid.personnel.PositionNotificationSession | a PositionNotificationSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsPositionNotification()
and supportsVisibleFederation() are true | |
| Method | getPositionRealmSession | ||
| Description |
Gets the session for retrieving position to realm mappings. | ||
| Return | osid.personnel.PositionRealmSession | a PositionRealmSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPositionRealm() is false | ||
| Compliance | optional | This method must be implemented if supportsPositionRealm()
is true. | |
| Method | getPositionRealmAssignmentSession | ||
| Description |
Gets the session for assigning position to realm mappings. | ||
| Return | osid.personnel.PositionRealmAssignmentSession | a PositionRealmAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPositionRealmAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsPositionRealmAssignment()
is true. | |
| Method | getPositionSmartRealmSession | ||
| Description |
Gets the session associated with the position smart realm for the given realm. | ||
| Parameters | osid.id.Id | realmId | the Id of the realm |
| Return | osid.personnel.PositionSmartRealmSession | a PositionSmartRealmSession | |
| Errors | NOT_FOUND | realmId not found | |
| NULL_ARGUMENT | realmId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPositionSmartRealm() is false | ||
| Compliance | optional | This method must be implemented if supportsPositionSmartRealm()
is true. | |
| Method | getAppointmentLookupSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.AppointmentLookupSession | an AppointmentLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAppointmentLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsAppointmentLookup()
is true. | |
| Method | getAppointmentLookupSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.AppointmentLookupSession | an AppointmentLookupSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsAppointmentLookup()
and supportsVisibleFederation() are true | |
| Method | getAppointmentQuerySession | ||
| Description |
Gets the | ||
| Return | osid.personnel.AppointmentQuerySession | an AppointmentQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAppointmentQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsAppointmentQuery()
is true. | |
| Method | getAppointmentQuerySessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.AppointmentQuerySession | an AppointmentQuerySession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsAppointmentQuery()
and supportsVisibleFederation() are true | |
| Method | getAppointmentSearchSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.AppointmentSearchSession | an AppointmentSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAppointmentSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsAppointmentSearch()
is true. | |
| Method | getAppointmentSearchSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.AppointmentSearchSession | an AppointmentSearchSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsAppointmentSearch()
and supportsVisibleFederation() are true | |
| Method | getAppointmentAdminSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.AppointmentAdminSession | an AppointmentAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAppointmentAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsAppointmentAdmin()
is true. | |
| Method | getAppointmentAdminSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | realmId | the Id of the Realm |
| Return | osid.personnel.AppointmentAdminSession | an AppointmentAdminSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsAppointmentAdmin()
and supportsVisibleFederation() are true | |
| Method | getAppointmentNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.AppointmentReceiver | appointmentReceiver | the receiver |
| Return | osid.personnel.AppointmentNotificationSession | an AppointmentNotificationSession | |
| Errors | NULL_ARGUMENT | appointmentReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAppointmentNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsAppointmentNotification()
is true. | |
| Method | getAppointmentNotificationSessionForRealm | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.AppointmentReceiver | appointmentReceiver | the receiver |
osid.id.Id | realmId | the Id of the Realm | |
| Return | osid.personnel.AppointmentNotificationSession | an AppointmentNotificationSession | |
| Errors | NOT_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 | ||
| Compliance | optional | This method must be implemented if supportsAppointmentNotification()
and supportsVisibleFederation() are true | |
| Method | getAppointmentRealmSession | ||
| Description |
Gets the session for retrieving appointment to realm mappings. | ||
| Return | osid.personnel.AppointmentRealmSession | an AppointmentRealmSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAppointmentRealm() is false | ||
| Compliance | optional | This method must be implemented if supportsAppointmentRealm()
is true. | |
| Method | getAppointmentRealmAssignmentSession | ||
| Description |
Gets the session for assigning appointment to realm mappings. | ||
| Return | osid.personnel.AppointmentRealmAssignmentSession | an AppointmentRealmAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAppointmentRealmAssignment() is false | ||
| Compliance | optional | This method must be implemented if
supportsAppointmentRealmAssignment() is true. | |
| Method | getAppointmentSmartRealmSession | ||
| Description |
Gets the session associated with the appointment smart realm for the given realm. | ||
| Parameters | osid.id.Id | realmId | the Id of the realm |
| Return | osid.personnel.AppointmentSmartRealmSession | an AppointmentSmartRealmSession | |
| Errors | NOT_FOUND | realmId not found | |
| NULL_ARGUMENT | realmId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAppointmentSmartRealm() is false | ||
| Compliance | optional | This method must be implemented if supportsAppointmenSmarttRealm()
is true. | |
| Method | getRealmLookupSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.RealmLookupSession | a RealmLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRealmLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsRealmLookup() is
true. | |
| Method | getRealmQuerySession | ||
| Description |
Gets the | ||
| Return | osid.personnel.RealmQuerySession | a RealmQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRealmQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsRealmQuery() is
true. | |
| Method | getRealmSearchSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.RealmSearchSession | a RealmSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRealmSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsRealmSearch() is
true. | |
| Method | getRealmAdminSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.RealmAdminSession | a RealmAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRealmAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsRealmAdmin() is
true. | |
| Method | getRealmNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.personnel.RealmReceiver | realmReceiver | the receiver |
| Return | osid.personnel.RealmNotificationSession | a RealmNotificationSession | |
| Errors | NULL_ARGUMENT | realmReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsRealmNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsRealmNotification()
is true. | |
| Method | getRealmHierarchySession | ||
| Description |
Gets the | ||
| Return | osid.personnel.RealmHierarchySession | a RealmHierarchySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRealmHierarchy() is false | ||
| Compliance | optional | This method must be implemented if supportsRealmHierarchy()
is true. | |
| Method | getRealmHierarchyDesignSession | ||
| Description |
Gets the | ||
| Return | osid.personnel.RealmHierarchyDesignSession | a RealmHierarchyDesignSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsRealmHierarchyDesign() is false | ||
| Compliance | optional | This method must be implemented if supportsRealmHierarchyDesign()
is true. | |
| Method | getPersonnelBatchManager | ||
| Description |
Gets a | ||
| Return | osid.personnel.batch.PersonnelBatchManager | a PersonnelBatchManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPersonnelBatch() is false | ||
| Compliance | optional | This method must be implemented if supportsPersonnelBatch()
is true. | |