Interface | osid.personnel.PersonnelProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The personnel profile describes the interoperability among personnel services. | ||
Method | supportsVisibleFederation | ||
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. | ||
Return | boolean | true if visible federation is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonLookup | ||
Description |
Tests for the availability of a person lookup service. | ||
Return | boolean | true if person lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonQuery | ||
Description |
Tests for the availability of a person query service. | ||
Return | boolean | true if person query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonSearch | ||
Description |
Tests if searching for persons is available. | ||
Return | boolean | true if person search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonAdmin | ||
Description |
Tests if managing for persons is available. | ||
Return | boolean | true if a person adminstrative service is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonNotification | ||
Description |
Tests if person notification is available. | ||
Return | boolean | true if person notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonRealm | ||
Description |
Tests if a person to realm lookup session is available. | ||
Return | boolean | true if person realm lookup session is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonRealmAssignment | ||
Description |
Tests if a person to realm assignment session is available. | ||
Return | boolean | true if person realm assignment is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonSmartRealm | ||
Description |
Tests if a person smart realm session is available. | ||
Return | boolean | true if person smart realm is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationLookup | ||
Description |
Tests for the availability of an organization lookup service. | ||
Return | boolean | true if organization lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationQuery | ||
Description |
Tests for the availability of an organization query service. | ||
Return | boolean | true if organization query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationSearch | ||
Description |
Tests if searching for organizations is available. | ||
Return | boolean | true if organization search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationAdmin | ||
Description |
Tests if managing for organizations is available. | ||
Return | boolean | true if an organization adminstrative service is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationNotification | ||
Description |
Tests if organization notification is available. | ||
Return | boolean | true if organization notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationHierarchy | ||
Description |
Tests if an organization hierarchy traversal is supported. | ||
Return | boolean | true if an organization hierarchy traversal is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationHierarchyDesign | ||
Description |
Tests if organization hierarchy design is supported. | ||
Return | boolean | true if an organization hierarchy design is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationRealm | ||
Description |
Tests if an organization to realm lookup session is available. | ||
Return | boolean | true if organization realm lookup session is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationRealmAssignment | ||
Description |
Tests if an organization to realm assignment session is available. | ||
Return | boolean | true if organization realm assignment is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationSmartRealm | ||
Description |
Tests if an organization smart realm session is available. | ||
Return | boolean | true if organization smart realm is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionLookup | ||
Description |
Tests for the availability of a position lookup service. | ||
Return | boolean | true if position lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionQuery | ||
Description |
Tests for the availability of a position query service. | ||
Return | boolean | true if position query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionSearch | ||
Description |
Tests if searching for positions is available. | ||
Return | boolean | true if position search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionAdmin | ||
Description |
Tests if managing for positions is available. | ||
Return | boolean | true if a position adminstrative service is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionNotification | ||
Description |
Tests if position notification is available. | ||
Return | boolean | true if position notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionRealm | ||
Description |
Tests if a position to realm lookup session is available. | ||
Return | boolean | true if position realm lookup session is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionRealmAssignment | ||
Description |
Tests if a position to realm assignment session is available. | ||
Return | boolean | true if position realm assignment is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionSmartRealm | ||
Description |
Tests if a position smart realm session is available. | ||
Return | boolean | true if position smart realm is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentLookup | ||
Description |
Tests for the availability of an appointment lookup service. | ||
Return | boolean | true if appointment lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentQuery | ||
Description |
Tests for the availability of an appointment query service. | ||
Return | boolean | true if appointment query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentSearch | ||
Description |
Tests if searching for appointments is available. | ||
Return | boolean | true if appointment search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentAdmin | ||
Description |
Tests if managing for appointments is available. | ||
Return | boolean | true if an appointment adminstrative service is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentNotification | ||
Description |
Tests if appointment notification is available. | ||
Return | boolean | true if appointment notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentRealm | ||
Description |
Tests if an appointment to realm lookup session is available. | ||
Return | boolean | true if appointment realm lookup session is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentRealmAssignment | ||
Description |
Tests if an appointment to realm assignment session is available. | ||
Return | boolean | true if appointment realm assignment is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentSmartRealm | ||
Description |
Tests if an appointment smart realm session is available. | ||
Return | boolean | true if appointment smart realm is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmLookup | ||
Description |
Tests for the availability of an realm lookup service. | ||
Return | boolean | true if realm lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmQuery | ||
Description |
Tests if querying realms is available. | ||
Return | boolean | true if realm query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmSearch | ||
Description |
Tests if searching for realms is available. | ||
Return | boolean | true if realm search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmAdmin | ||
Description |
Tests for the availability of a realm administrative service for creating and deleting realms. | ||
Return | boolean | true if realm administration is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmNotification | ||
Description |
Tests for the availability of a realm notification service. | ||
Return | boolean | true if realm notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsRealmHierarchy | ||
Description |
Tests for the availability of a realm hierarchy traversal service. | ||
Return | boolean | true if realm hierarchy traversal is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmHierarchyDesign | ||
Description |
Tests for the availability of a realm hierarchy design service. | ||
Return | boolean | true if realm hierarchy design is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsPersonnelBatch | ||
Description |
Tests for the availability of a personnel batch service. | ||
Return | boolean | true if a personnel batch service is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | getPersonRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported person record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | personRecordType | a Type indicating a Person record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | personRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPersonSearchRecordTypes | ||
Description |
Gets the supported person search record types. | ||
Return | osid.type.TypeList | a list containing the supported person search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPersonSearchRecordType | ||
Description |
Tests if the given person search record type is supported. | ||
Parameters | osid.type.Type | personSearchRecordType | a Type indicating a person record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | personSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported organization record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | organizationRecordType | a Type indicating an Organization record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | organizationRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationSearchRecordTypes | ||
Description |
Gets the supported organization search record types. | ||
Return | osid.type.TypeList | a list containing the supported organization search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationSearchRecordType | ||
Description |
Tests if the given organization search record type is supported. | ||
Parameters | osid.type.Type | organizationSearchRecordType | a Type indicating an organization record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | organizationSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPositionRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported position record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | positionRecordType | a Type indicating a Position record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | positionRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPositionSearchRecordTypes | ||
Description |
Gets the supported position search record types. | ||
Return | osid.type.TypeList | a list containing the supported position search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPositionSearchRecordType | ||
Description |
Tests if the given position search record type is supported. | ||
Parameters | osid.type.Type | positionSearchRecordType | a Type indicating a position record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | positionSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported appointment record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | appointmentRecordType | a Type indicating an Appointment record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | appointmentRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentSearchRecordTypes | ||
Description |
Gets the supported appointment search record types. | ||
Return | osid.type.TypeList | a list containing the supported appointment search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAppointmentSearchRecordType | ||
Description |
Tests if the given appointment search record type is supported. | ||
Parameters | osid.type.Type | appointmentSearchRecordType | a Type indicating an appointment record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | appointmentSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealmRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported realm record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | realmRecordType | a Type indicating a Realm record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | realmRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealmSearchRecordTypes | ||
Description |
Gets the supported realm search record types. | ||
Return | osid.type.TypeList | a list containing the supported realm search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmSearchRecordType | ||
Description |
Tests if the given realm search record type is supported. | ||
Parameters | osid.type.Type | realmSearchRecordType | a Type indicating a realm record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | realmSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. |