OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PersonnelProfile
Implementsosid.OsidProfile
Description

The personnel profile describes the interoperability among personnel services.

MethodsupportsVisibleFederation
Description

Tests if any realm federation is exposed. Federation is exposed when a specific realm may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of realms appears as a single realm.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonLookup
Description

Tests for the availability of a person lookup service.

Returnboolean true if person lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonQuery
Description

Tests for the availability of a person query service.

Returnboolean true if person query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonSearch
Description

Tests if searching for persons is available.

Returnboolean true if person search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonAdmin
Description

Tests if managing for persons is available.

Returnboolean true if a person adminstrative service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonNotification
Description

Tests if person notification is available.

Returnboolean true if person notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonRealm
Description

Tests if a person to realm lookup session is available.

Returnboolean true if person realm lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonRealmAssignment
Description

Tests if a person to realm assignment session is available.

Returnboolean true if person realm assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonSmartRealm
Description

Tests if a person smart realm session is available.

Returnboolean true if person smart realm is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationLookup
Description

Tests for the availability of an organization lookup service.

Returnboolean true if organization lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationQuery
Description

Tests for the availability of an organization query service.

Returnboolean true if organization query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationSearch
Description

Tests if searching for organizations is available.

Returnboolean true if organization search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationAdmin
Description

Tests if managing for organizations is available.

Returnboolean true if an organization adminstrative service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationNotification
Description

Tests if organization notification is available.

Returnboolean true if organization notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationHierarchy
Description

Tests if an organization hierarchy traversal is supported.

Returnboolean true if an organization hierarchy traversal is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationHierarchyDesign
Description

Tests if organization hierarchy design is supported.

Returnboolean true if an organization hierarchy design is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationRealm
Description

Tests if an organization to realm lookup session is available.

Returnboolean true if organization realm lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationRealmAssignment
Description

Tests if an organization to realm assignment session is available.

Returnboolean true if organization realm assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationSmartRealm
Description

Tests if an organization smart realm session is available.

Returnboolean true if organization smart realm is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionLookup
Description

Tests for the availability of a position lookup service.

Returnboolean true if position lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionQuery
Description

Tests for the availability of a position query service.

Returnboolean true if position query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionSearch
Description

Tests if searching for positions is available.

Returnboolean true if position search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionAdmin
Description

Tests if managing for positions is available.

Returnboolean true if a position adminstrative service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionNotification
Description

Tests if position notification is available.

Returnboolean true if position notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionRealm
Description

Tests if a position to realm lookup session is available.

Returnboolean true if position realm lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionRealmAssignment
Description

Tests if a position to realm assignment session is available.

Returnboolean true if position realm assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionSmartRealm
Description

Tests if a position smart realm session is available.

Returnboolean true if position smart realm is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentLookup
Description

Tests for the availability of an appointment lookup service.

Returnboolean true if appointment lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentQuery
Description

Tests for the availability of an appointment query service.

Returnboolean true if appointment query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentSearch
Description

Tests if searching for appointments is available.

Returnboolean true if appointment search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentAdmin
Description

Tests if managing for appointments is available.

Returnboolean true if an appointment adminstrative service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentNotification
Description

Tests if appointment notification is available.

Returnboolean true if appointment notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentRealm
Description

Tests if an appointment to realm lookup session is available.

Returnboolean true if appointment realm lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentRealmAssignment
Description

Tests if an appointment to realm assignment session is available.

Returnboolean true if appointment realm assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentSmartRealm
Description

Tests if an appointment smart realm session is available.

Returnboolean true if appointment smart realm is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRealmLookup
Description

Tests for the availability of an realm lookup service.

Returnboolean true if realm lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRealmQuery
Description

Tests if querying realms is available.

Returnboolean true if realm query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRealmSearch
Description

Tests if searching for realms is available.

Returnboolean true if realm search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRealmAdmin
Description

Tests for the availability of a realm administrative service for creating and deleting realms.

Returnboolean true if realm administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRealmNotification
Description

Tests for the availability of a realm notification service.

Returnboolean true if realm notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsRealmHierarchy
Description

Tests for the availability of a realm hierarchy traversal service.

Returnboolean true if realm hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRealmHierarchyDesign
Description

Tests for the availability of a realm hierarchy design service.

Returnboolean true if realm hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsPersonnelBatch
Description

Tests for the availability of a personnel batch service.

Returnboolean true if a personnel batch service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodgetPersonRecordTypes
Description

Gets the supported Person record types.

Returnosid.type.TypeLista list containing the supported person record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonRecordType
Description

Tests if the given Person record type is supported.

Parametersosid.type.TypepersonRecordTypea Type indicating a Person record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT personRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPersonSearchRecordTypes
Description

Gets the supported person search record types.

Returnosid.type.TypeLista list containing the supported person search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPersonSearchRecordType
Description

Tests if the given person search record type is supported.

Parametersosid.type.TypepersonSearchRecordTypea Type indicating a person record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT personSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationRecordTypes
Description

Gets the supported Organization record types.

Returnosid.type.TypeLista list containing the supported organization record types
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationRecordType
Description

Tests if the given Organization record type is supported.

Parametersosid.type.TypeorganizationRecordTypea Type indicating an Organization record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT organizationRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationSearchRecordTypes
Description

Gets the supported organization search record types.

Returnosid.type.TypeLista list containing the supported organization search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationSearchRecordType
Description

Tests if the given organization search record type is supported.

Parametersosid.type.TypeorganizationSearchRecordTypea Type indicating an organization record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT organizationSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPositionRecordTypes
Description

Gets the supported Position record types.

Returnosid.type.TypeLista list containing the supported position record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionRecordType
Description

Tests if the given Position record type is supported.

Parametersosid.type.TypepositionRecordTypea Type indicating a Position record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT positionRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPositionSearchRecordTypes
Description

Gets the supported position search record types.

Returnosid.type.TypeLista list containing the supported position search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPositionSearchRecordType
Description

Tests if the given position search record type is supported.

Parametersosid.type.TypepositionSearchRecordTypea Type indicating a position record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT positionSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentRecordTypes
Description

Gets the supported Appointment record types.

Returnosid.type.TypeLista list containing the supported appointment record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentRecordType
Description

Tests if the given Appointment record type is supported.

Parametersosid.type.TypeappointmentRecordTypea Type indicating an Appointment record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT appointmentRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentSearchRecordTypes
Description

Gets the supported appointment search record types.

Returnosid.type.TypeLista list containing the supported appointment search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAppointmentSearchRecordType
Description

Tests if the given appointment search record type is supported.

Parametersosid.type.TypeappointmentSearchRecordTypea Type indicating an appointment record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT appointmentSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetRealmRecordTypes
Description

Gets the supported Realm record types.

Returnosid.type.TypeLista list containing the supported realm record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRealmRecordType
Description

Tests if the given Realm record type is supported.

Parametersosid.type.TyperealmRecordTypea Type indicating a Realm record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT realmRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetRealmSearchRecordTypes
Description

Gets the supported realm search record types.

Returnosid.type.TypeLista list containing the supported realm search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRealmSearchRecordType
Description

Tests if the given realm search record type is supported.

Parametersosid.type.TyperealmSearchRecordTypea Type indicating a realm record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT realmSearchRecordType is null
CompliancemandatoryThis method must be implemented.