Interface PersonnelProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
PersonnelManager, PersonnelProxyManager
public interface PersonnelProfile extends OsidProfile

The personnel profile describes the interoperability among personnel services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      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.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonLookup

      boolean supportsPersonLookup()
      Tests for the availability of a person lookup service.
      Returns:
      true if person lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonQuery

      boolean supportsPersonQuery()
      Tests for the availability of a person query service.
      Returns:
      true if person query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonSearch

      boolean supportsPersonSearch()
      Tests if searching for persons is available.
      Returns:
      true if person search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonAdmin

      boolean supportsPersonAdmin()
      Tests if managing for persons is available.
      Returns:
      true if a person administrative service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonNotification

      boolean supportsPersonNotification()
      Tests if person notification is available.
      Returns:
      true if person notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonRealm

      boolean supportsPersonRealm()
      Tests if a person to realm lookup session is available.
      Returns:
      true if person realm lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonRealmAssignment

      boolean supportsPersonRealmAssignment()
      Tests if a person to realm assignment session is available.
      Returns:
      true if person realm assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonSmartRealm

      boolean supportsPersonSmartRealm()
      Tests if a person smart realm session is available.
      Returns:
      true if person smart realm is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationLookup

      boolean supportsOrganizationLookup()
      Tests for the availability of an organization lookup service.
      Returns:
      true if organization lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationQuery

      boolean supportsOrganizationQuery()
      Tests for the availability of an organization query service.
      Returns:
      true if organization query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationSearch

      boolean supportsOrganizationSearch()
      Tests if searching for organizations is available.
      Returns:
      true if organization search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationAdmin

      boolean supportsOrganizationAdmin()
      Tests if managing for organizations is available.
      Returns:
      true if an organization administrative service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationNotification

      boolean supportsOrganizationNotification()
      Tests if organization notification is available.
      Returns:
      true if organization notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationHierarchy

      boolean supportsOrganizationHierarchy()
      Tests if an organization hierarchy traversal is supported.
      Returns:
      true if an organization hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationHierarchyDesign

      boolean supportsOrganizationHierarchyDesign()
      Tests if organization hierarchy design is supported.
      Returns:
      true if an organization hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationRealm

      boolean supportsOrganizationRealm()
      Tests if an organization to realm lookup session is available.
      Returns:
      true if organization realm lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationRealmAssignment

      boolean supportsOrganizationRealmAssignment()
      Tests if an organization to realm assignment session is available.
      Returns:
      true if organization realm assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationSmartRealm

      boolean supportsOrganizationSmartRealm()
      Tests if an organization smart realm session is available.
      Returns:
      true if organization smart realm is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionLookup

      boolean supportsPositionLookup()
      Tests for the availability of a position lookup service.
      Returns:
      true if position lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionQuery

      boolean supportsPositionQuery()
      Tests for the availability of a position query service.
      Returns:
      true if position query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionSearch

      boolean supportsPositionSearch()
      Tests if searching for positions is available.
      Returns:
      true if position search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionAdmin

      boolean supportsPositionAdmin()
      Tests if managing for positions is available.
      Returns:
      true if a position administrative service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionNotification

      boolean supportsPositionNotification()
      Tests if position notification is available.
      Returns:
      true if position notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionRealm

      boolean supportsPositionRealm()
      Tests if a position to realm lookup session is available.
      Returns:
      true if position realm lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionRealmAssignment

      boolean supportsPositionRealmAssignment()
      Tests if a position to realm assignment session is available.
      Returns:
      true if position realm assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionSmartRealm

      boolean supportsPositionSmartRealm()
      Tests if a position smart realm session is available.
      Returns:
      true if position smart realm is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentLookup

      boolean supportsAppointmentLookup()
      Tests for the availability of an appointment lookup service.
      Returns:
      true if appointment lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentQuery

      boolean supportsAppointmentQuery()
      Tests for the availability of an appointment query service.
      Returns:
      true if appointment query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentSearch

      boolean supportsAppointmentSearch()
      Tests if searching for appointments is available.
      Returns:
      true if appointment search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentAdmin

      boolean supportsAppointmentAdmin()
      Tests if managing for appointments is available.
      Returns:
      true if an appointment administrative service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentNotification

      boolean supportsAppointmentNotification()
      Tests if appointment notification is available.
      Returns:
      true if appointment notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentRealm

      boolean supportsAppointmentRealm()
      Tests if an appointment to realm lookup session is available.
      Returns:
      true if appointment realm lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentRealmAssignment

      boolean supportsAppointmentRealmAssignment()
      Tests if an appointment to realm assignment session is available.
      Returns:
      true if appointment realm assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentSmartRealm

      boolean supportsAppointmentSmartRealm()
      Tests if an appointment smart realm session is available.
      Returns:
      true if appointment smart realm is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRealmLookup

      boolean supportsRealmLookup()
      Tests for the availability of a realm lookup service.
      Returns:
      true if realm lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRealmQuery

      boolean supportsRealmQuery()
      Tests if querying realms is available.
      Returns:
      true if realm query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRealmSearch

      boolean supportsRealmSearch()
      Tests if searching for realms is available.
      Returns:
      true if realm search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRealmAdmin

      boolean supportsRealmAdmin()
      Tests for the availability of a realm administrative service for creating and deleting realms.
      Returns:
      true if realm administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRealmNotification

      boolean supportsRealmNotification()
      Tests for the availability of a realm notification service.
      Returns:
      true if realm notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsRealmHierarchy

      boolean supportsRealmHierarchy()
      Tests for the availability of a realm hierarchy traversal service.
      Returns:
      true if realm hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRealmHierarchyDesign

      boolean supportsRealmHierarchyDesign()
      Tests for the availability of a realm hierarchy design service.
      Returns:
      true if realm hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsPersonnelBatch

      boolean supportsPersonnelBatch()
      Tests for the availability of a personnel batch service.
      Returns:
      true if a personnel batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getPersonRecordTypes

      TypeList getPersonRecordTypes()
      Gets the supported Person record types.
      Returns:
      a list containing the supported person record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonRecordType

      boolean supportsPersonRecordType(Type personRecordType)
      Tests if the given Person record type is supported.
      Parameters:
      personRecordType - a Type indicating a Person record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - personRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPersonSearchRecordTypes

      TypeList getPersonSearchRecordTypes()
      Gets the supported person search record types.
      Returns:
      a list containing the supported person search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonSearchRecordType

      boolean supportsPersonSearchRecordType(Type personSearchRecordType)
      Tests if the given person search record type is supported.
      Parameters:
      personSearchRecordType - a Type indicating a person record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - personSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOrganizationRecordTypes

      TypeList getOrganizationRecordTypes()
      Gets the supported Organization record types.
      Returns:
      a list containing the supported organization record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationRecordType

      boolean supportsOrganizationRecordType(Type organizationRecordType)
      Tests if the given Organization record type is supported.
      Parameters:
      organizationRecordType - a Type indicating an Organization record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - organizationRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOrganizationSearchRecordTypes

      TypeList getOrganizationSearchRecordTypes()
      Gets the supported organization search record types.
      Returns:
      a list containing the supported organization search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationSearchRecordType

      boolean supportsOrganizationSearchRecordType(Type organizationSearchRecordType)
      Tests if the given organization search record type is supported.
      Parameters:
      organizationSearchRecordType - a Type indicating an organization record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - organizationSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPositionRecordTypes

      TypeList getPositionRecordTypes()
      Gets the supported Position record types.
      Returns:
      a list containing the supported position record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionRecordType

      boolean supportsPositionRecordType(Type positionRecordType)
      Tests if the given Position record type is supported.
      Parameters:
      positionRecordType - a Type indicating a Position record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - positionRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPositionSearchRecordTypes

      TypeList getPositionSearchRecordTypes()
      Gets the supported position search record types.
      Returns:
      a list containing the supported position search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionSearchRecordType

      boolean supportsPositionSearchRecordType(Type positionSearchRecordType)
      Tests if the given position search record type is supported.
      Parameters:
      positionSearchRecordType - a Type indicating a position record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - positionSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentRecordTypes

      TypeList getAppointmentRecordTypes()
      Gets the supported Appointment record types.
      Returns:
      a list containing the supported appointment record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentRecordType

      boolean supportsAppointmentRecordType(Type appointmentRecordType)
      Tests if the given Appointment record type is supported.
      Parameters:
      appointmentRecordType - a Type indicating an Appointment record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - appointmentRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentSearchRecordTypes

      TypeList getAppointmentSearchRecordTypes()
      Gets the supported appointment search record types.
      Returns:
      a list containing the supported appointment search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentSearchRecordType

      boolean supportsAppointmentSearchRecordType(Type appointmentSearchRecordType)
      Tests if the given appointment search record type is supported.
      Parameters:
      appointmentSearchRecordType - a Type indicating an appointment record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - appointmentSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRealmRecordTypes

      TypeList getRealmRecordTypes()
      Gets the supported Realm record types.
      Returns:
      a list containing the supported realm record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRealmRecordType

      boolean supportsRealmRecordType(Type realmRecordType)
      Tests if the given Realm record type is supported.
      Parameters:
      realmRecordType - a Type indicating a Realm record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - realmRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRealmSearchRecordTypes

      TypeList getRealmSearchRecordTypes()
      Gets the supported realm search record types.
      Returns:
      a list containing the supported realm search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRealmSearchRecordType

      boolean supportsRealmSearchRecordType(Type realmSearchRecordType)
      Tests if the given realm search record type is supported.
      Parameters:
      realmSearchRecordType - a Type indicating a realm record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - realmSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.