org.osid.personnel

Interface PersonnelManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, PersonnelProfile, Sourceable

public interface PersonnelManager
extends OsidManager, PersonnelProfile

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.

Method Summary

Methods

Modifier and Type	Method and Description
AppointmentAdminSession	getAppointmentAdminSession() Gets the OsidSession associated with the appointment administration service.
AppointmentAdminSession	getAppointmentAdminSessionForRealm(Id realmId) Gets the OsidSession associated with the appointment administration service for the given realm.
AppointmentLookupSession	getAppointmentLookupSession() Gets the OsidSession associated with the appointment lookup service.
AppointmentLookupSession	getAppointmentLookupSessionForRealm(Id realmId) Gets the OsidSession associated with the appointment lookup service for the given realm.
AppointmentNotificationSession	getAppointmentNotificationSession(AppointmentReceiver appointmentReceiver) Gets the OsidSession associated with the appointment notification service.
AppointmentNotificationSession	getAppointmentNotificationSessionForRealm(AppointmentReceiver appointmentReceiver, Id realmId) Gets the OsidSession associated with the appointment notification service for the given realm.
AppointmentQuerySession	getAppointmentQuerySession() Gets the OsidSession associated with the appointment query service.
AppointmentQuerySession	getAppointmentQuerySessionForRealm(Id realmId) Gets the OsidSession associated with the appointment query service for the given realm.
AppointmentRealmAssignmentSession	getAppointmentRealmAssignmentSession() Gets the session for assigning appointment to realm mappings.
AppointmentRealmSession	getAppointmentRealmSession() Gets the session for retrieving appointment to realm mappings.
AppointmentSearchSession	getAppointmentSearchSession() Gets the OsidSession associated with the appointment search service.
AppointmentSearchSession	getAppointmentSearchSessionForRealm(Id realmId) Gets the OsidSession associated with the appointment search service for the given realm.
AppointmentSmartRealmSession	getAppointmentSmartRealmSession(Id realmId) Gets the session associated with the appointment smart realm for the given realm.
OrganizationAdminSession	getOrganizationAdminSession() Gets the OsidSession associated with the organization administration service.
OrganizationAdminSession	getOrganizationAdminSessionForRealm(Id realmId) Gets the OsidSession associated with the organization administration service for the given realm.
OrganizationHierarchyDesignSession	getOrganizationHierarchyDesignSession() Gets the session designing organization hierarchies.
OrganizationHierarchyDesignSession	getOrganizationHierarchyDesignSessionForRealm(Id realmId) Gets the OsidSession associated with the organization heirarchy design service for the given realm.
OrganizationHierarchySession	getOrganizationHierarchySession() Gets the session traversing organization hierarchies.
OrganizationHierarchySession	getOrganizationHierarchySessionForRealm(Id realmId) Gets the OsidSession associated with the organization heirarchy traversal service for the given realm.
OrganizationLookupSession	getOrganizationLookupSession() Gets the OsidSession associated with the organization lookup service.
OrganizationLookupSession	getOrganizationLookupSessionForRealm(Id realmId) Gets the OsidSession associated with the organization lookup service for the given realm.
OrganizationNotificationSession	getOrganizationNotificationSession(OrganizationReceiver organizationReceiver) Gets the OsidSession associated with the organization notification service.
OrganizationNotificationSession	getOrganizationNotificationSessionForRealm(OrganizationReceiver organizationReceiver, Id realmId) Gets the OsidSession associated with the organization notification service for the given realm.
OrganizationQuerySession	getOrganizationQuerySession() Gets the OsidSession associated with the organization query service.
OrganizationQuerySession	getOrganizationQuerySessionForRealm(Id realmId) Gets the OsidSession associated with the organization query service for the given realm.
OrganizationRealmAssignmentSession	getOrganizationRealmAssignmentSession() Gets the session for assigning organization to realm mappings.
OrganizationRealmSession	getOrganizationRealmSession() Gets the session for retrieving organization to realm mappings.
OrganizationSearchSession	getOrganizationSearchSession() Gets the OsidSession associated with the organization search service.
OrganizationSearchSession	getOrganizationSearchSessionForRealm(Id realmId) Gets the OsidSession associated with the organization search service for the given realm.
OrganizationSmartRealmSession	getOrganizationSmartRealmSession(Id realmId) Gets the session associated with the organization smart realm for the given realm.
PersonAdminSession	getPersonAdminSession() Gets the OsidSession associated with the person administration service.
PersonAdminSession	getPersonAdminSessionForRealm(Id realmId) Gets the OsidSession associated with the person administration service for the given realm.
PersonLookupSession	getPersonLookupSession() Gets the OsidSession associated with the person lookup service.
PersonLookupSession	getPersonLookupSessionForRealm(Id realmId) Gets the OsidSession associated with the person lookup service for the given realm.
PersonnelBatchManager	getPersonnelBatchManager() Gets a PersonnelBatchManager.
PersonNotificationSession	getPersonNotificationSession(PersonReceiver personReceiver) Gets the OsidSession associated with the person notification service.
PersonNotificationSession	getPersonNotificationSessionForRealm(PersonReceiver personReceiver, Id realmId) Gets the OsidSession associated with the person notification service for the given realm.
PersonQuerySession	getPersonQuerySession() Gets the OsidSession associated with the person query service.
PersonQuerySession	getPersonQuerySessionForRealm(Id realmId) Gets the OsidSession associated with the person query service for the given realm.
PersonRealmAssignmentSession	getPersonRealmAssignmentSession() Gets the session for assigning person to realm mappings.
PersonRealmSession	getPersonRealmSession() Gets the session for retrieving person to realm mappings.
PersonSearchSession	getPersonSearchSession() Gets the OsidSession associated with the person search service.
PersonSearchSession	getPersonSearchSessionForRealm(Id realmId) Gets the OsidSession associated with the person search service for the given realm.
PersonSmartRealmSession	getPersonSmartRealmSession(Id realmId) Gets the session associated with the person smart realm for the given realm.
PositionAdminSession	getPositionAdminSession() Gets the OsidSession associated with the position administration service.
PositionAdminSession	getPositionAdminSessionForRealm(Id realmId) Gets the OsidSession associated with the position administration service for the given realm.
PositionLookupSession	getPositionLookupSession() Gets the OsidSession associated with the position lookup service.
PositionLookupSession	getPositionLookupSessionForRealm(Id realmId) Gets the OsidSession associated with the position lookup service for the given realm.
PositionNotificationSession	getPositionNotificationSession(PositionReceiver positionReceiver) Gets the OsidSession associated with the position notification service.
PositionNotificationSession	getPositionNotificationSessionForRealm(PositionReceiver positionReceiver, Id realmId) Gets the OsidSession associated with the position notification service for the given realm.
PositionQuerySession	getPositionQuerySession() Gets the OsidSession associated with the position query service.
PositionQuerySession	getPositionQuerySessionForRealm(Id realmId) Gets the OsidSession associated with the position query service for the given realm.
PositionRealmAssignmentSession	getPositionRealmAssignmentSession() Gets the session for assigning position to realm mappings.
PositionRealmSession	getPositionRealmSession() Gets the session for retrieving position to realm mappings.
PositionSearchSession	getPositionSearchSession() Gets the OsidSession associated with the position search service.
PositionSearchSession	getPositionSearchSessionForRealm(Id realmId) Gets the OsidSession associated with the position search service for the given realm.
PositionSmartRealmSession	getPositionSmartRealmSession(Id realmId) Gets the session associated with the position smart realm for the given realm.
RealmAdminSession	getRealmAdminSession() Gets the OsidSession associated with the realm administrative service.
RealmHierarchyDesignSession	getRealmHierarchyDesignSession() Gets the OsidSession associated with the realm hierarchy design service.
RealmHierarchySession	getRealmHierarchySession() Gets the OsidSession associated with the realm hierarchy service.
RealmLookupSession	getRealmLookupSession() Gets the OsidSession associated with the realm lookup service.
RealmNotificationSession	getRealmNotificationSession(RealmReceiver realmReceiver) Gets the OsidSession associated with the realm notification service.
RealmQuerySession	getRealmQuerySession() Gets the OsidSession associated with the realm query service.
RealmSearchSession	getRealmSearchSession() Gets the OsidSession associated with the realm search service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.personnel.PersonnelProfile

getAppointmentRecordTypes, getAppointmentSearchRecordTypes, getOrganizationRecordTypes, getOrganizationSearchRecordTypes, getPersonRecordTypes, getPersonSearchRecordTypes, getPositionRecordTypes, getPositionSearchRecordTypes, getRealmRecordTypes, getRealmSearchRecordTypes, supportsAppointmentAdmin, supportsAppointmentLookup, supportsAppointmentNotification, supportsAppointmentQuery, supportsAppointmentRealm, supportsAppointmentRealmAssignment, supportsAppointmentRecordType, supportsAppointmentSearch, supportsAppointmentSearchRecordType, supportsAppointmentSmartRealm, supportsOrganizationAdmin, supportsOrganizationHierarchy, supportsOrganizationHierarchyDesign, supportsOrganizationLookup, supportsOrganizationNotification, supportsOrganizationQuery, supportsOrganizationRealm, supportsOrganizationRealmAssignment, supportsOrganizationRecordType, supportsOrganizationSearch, supportsOrganizationSearchRecordType, supportsOrganizationSmartRealm, supportsPersonAdmin, supportsPersonLookup, supportsPersonnelBatch, supportsPersonNotification, supportsPersonQuery, supportsPersonRealm, supportsPersonRealmAssignment, supportsPersonRecordType, supportsPersonSearch, supportsPersonSearchRecordType, supportsPersonSmartRealm, supportsPositionAdmin, supportsPositionLookup, supportsPositionNotification, supportsPositionQuery, supportsPositionRealm, supportsPositionRealmAssignment, supportsPositionRecordType, supportsPositionSearch, supportsPositionSearchRecordType, supportsPositionSmartRealm, supportsRealmAdmin, supportsRealmHierarchy, supportsRealmHierarchyDesign, supportsRealmLookup, supportsRealmNotification, supportsRealmQuery, supportsRealmRecordType, supportsRealmSearch, supportsRealmSearchRecordType, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPersonLookupSession

PersonLookupSession getPersonLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the person lookup service.

Returns:

a PersonLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonLookup() is false

Compliance:

optional - This method must be implemented if supportsPersonLookup() is true.

getPersonLookupSessionForRealm

PersonLookupSession getPersonLookupSessionForRealm(Id realmId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the person lookup service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

a PersonLookupSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPersonLookup() and supportsVisibleFederation() are true

getPersonQuerySession

PersonQuerySession getPersonQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the person query service.

Returns:

a PersonQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonQuery() is false

Compliance:

optional - This method must be implemented if supportsPersonQuery() is true.

getPersonQuerySessionForRealm

PersonQuerySession getPersonQuerySessionForRealm(Id realmId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the person query service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

a PersonQuerySession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPersonQuery() and supportsVisibleFederation() are true

getPersonSearchSession

PersonSearchSession getPersonSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the person search service.

Returns:

a PersonSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonSearch() is false

Compliance:

optional - This method must be implemented if supportsPersonSearch() is true.

getPersonSearchSessionForRealm

PersonSearchSession getPersonSearchSessionForRealm(Id realmId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the person search service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

a PersonSearchSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPersonSearch() and supportsVisibleFederation() are true

getPersonAdminSession

PersonAdminSession getPersonAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the person administration service.

Returns:

a PersonAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonAdmin() is false

Compliance:

optional - This method must be implemented if supportsPersonAdmin() is true.

getPersonAdminSessionForRealm

PersonAdminSession getPersonAdminSessionForRealm(Id realmId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the person administration service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

a PersonAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPersonAdmin() and supportsVisibleFederation() are true

getPersonNotificationSession

PersonNotificationSession getPersonNotificationSession(PersonReceiver personReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the person notification service.

Parameters:

personReceiver - the receiver

Returns:

a PersonNotificationSession

Throws:

NullArgumentException - personReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonNotification() is false

Compliance:

optional - This method must be implemented if supportsPersonNotification() is true.

getPersonNotificationSessionForRealm

PersonNotificationSession getPersonNotificationSessionForRealm(PersonReceiver personReceiver,
                                                             Id realmId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the person notification service for the given realm.

Parameters:

personReceiver - the receiver

realmId - the Id of the Realm

Returns:

a PersonNotificationSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - personReceiver or realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPersonNotification() and supportsVisibleFederation() are true

getPersonRealmSession

PersonRealmSession getPersonRealmSession()
                                         throws OperationFailedException

Gets the session for retrieving person to realm mappings.

Returns:

a PersonRealmSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonRealm() is false

Compliance:

optional - This method must be implemented if supportsPersonRealm() is true.

getPersonRealmAssignmentSession

PersonRealmAssignmentSession getPersonRealmAssignmentSession()
                                                             throws OperationFailedException

Gets the session for assigning person to realm mappings.

Returns:

a PersonRealmAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonRealmAssignment() is false

Compliance:

optional - This method must be implemented if supportsPersonRealmAssignment() is true.

getPersonSmartRealmSession

PersonSmartRealmSession getPersonSmartRealmSession(Id realmId)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

realmId - the Id of the realm

Returns:

a PersonSmartRealmSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonSmartRealm() is false

Compliance:

optional - This method must be implemented if supportsPersonSmartRealm() is true.

getOrganizationLookupSession

OrganizationLookupSession getOrganizationLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the organization lookup service.

Returns:

an OrganizationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationLookup() is false

Compliance:

optional - This method must be implemented if supportsOrganizationLookup() is true.

getOrganizationLookupSessionForRealm

OrganizationLookupSession getOrganizationLookupSessionForRealm(Id realmId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the organization lookup service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

an OrganizationLookupSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrganizationLookup() and supportsVisibleFederation() are true

getOrganizationQuerySession

OrganizationQuerySession getOrganizationQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the organization query service.

Returns:

an OrganizationQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationQuery() is false

Compliance:

optional - This method must be implemented if supportsOrganizationQuery() is true.

getOrganizationQuerySessionForRealm

OrganizationQuerySession getOrganizationQuerySessionForRealm(Id realmId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the organization query service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

an OrganizationQuerySession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrganizationQuery() and supportsVisibleFederation() are true

getOrganizationSearchSession

OrganizationSearchSession getOrganizationSearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the organization search service.

Returns:

an OrganizationSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationSearch() is false

Compliance:

optional - This method must be implemented if supportsOrganizationSearch() is true.

getOrganizationSearchSessionForRealm

OrganizationSearchSession getOrganizationSearchSessionForRealm(Id realmId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the organization search service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

an OrganizationSearchSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrganizationSearch() and supportsVisibleFederation() are true

getOrganizationAdminSession

OrganizationAdminSession getOrganizationAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the organization administration service.

Returns:

an OrganizationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationAdmin() is false

Compliance:

optional - This method must be implemented if supportsOrganizationAdmin() is true.

getOrganizationAdminSessionForRealm

OrganizationAdminSession getOrganizationAdminSessionForRealm(Id realmId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the organization administration service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

an OrganizationAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrganizationAdmin() and supportsVisibleFederation() are true

getOrganizationNotificationSession

OrganizationNotificationSession getOrganizationNotificationSession(OrganizationReceiver organizationReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the organization notification service.

Parameters:

organizationReceiver - the receiver

Returns:

an OrganizationNotificationSession

Throws:

NullArgumentException - organizationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationNotification() is false

Compliance:

optional - This method must be implemented if supportsOrganizationNotification() is true.

getOrganizationNotificationSessionForRealm

OrganizationNotificationSession getOrganizationNotificationSessionForRealm(OrganizationReceiver organizationReceiver,
                                                                         Id realmId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

Gets the OsidSession associated with the organization notification service for the given realm.

Parameters:

organizationReceiver - the receiver

realmId - the Id of the Realm

Returns:

an OrganizationNotificationSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - organizationReceiver or realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrganizationNotification() and supportsVisibleFederation() are true

getOrganizationHierarchySession

OrganizationHierarchySession getOrganizationHierarchySession()
                                                             throws OperationFailedException

Gets the session traversing organization hierarchies.

Returns:

an OrganizationHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationHierarchy() is false

Compliance:

optional - This method must be implemented if supportsOrganizationHierarchy() is true.

getOrganizationHierarchySessionForRealm

OrganizationHierarchySession getOrganizationHierarchySessionForRealm(Id realmId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the OsidSession associated with the organization heirarchy traversal service for the given realm.

Parameters:

realmId - the Id of the realm

Returns:

an OrganizationHierarchySession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrganizationHierarchy() and supportsVisibleFederation() are true.

getOrganizationHierarchyDesignSession

OrganizationHierarchyDesignSession getOrganizationHierarchyDesignSession()
                                                                         throws OperationFailedException

Gets the session designing organization hierarchies.

Returns:

an OrganizationHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsOrganizationHierarchyDesign() is true.

getOrganizationHierarchyDesignSessionForRealm

OrganizationHierarchyDesignSession getOrganizationHierarchyDesignSessionForRealm(Id realmId)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with the organization heirarchy design service for the given realm.

Parameters:

realmId - the Id of the realm

Returns:

an OrganizationHierarchyDesignSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrganizationHierarchyDesign() and supportsVisibleFederation() are true.

getOrganizationRealmSession

OrganizationRealmSession getOrganizationRealmSession()
                                                     throws OperationFailedException

Gets the session for retrieving organization to realm mappings.

Returns:

an OrganizationRealmSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationRealm() is false

Compliance:

optional - This method must be implemented if supportsOrganizationRealm() is true.

getOrganizationRealmAssignmentSession

OrganizationRealmAssignmentSession getOrganizationRealmAssignmentSession()
                                                                         throws OperationFailedException

Gets the session for assigning organization to realm mappings.

Returns:

an OrganizationRealmAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationRealmAssignment() is false

Compliance:

optional - This method must be implemented if supportsOrganizationRealmAssignment() is true.

getOrganizationSmartRealmSession

OrganizationSmartRealmSession getOrganizationSmartRealmSession(Id realmId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

realmId - the Id of the realm

Returns:

an OrganizationSmartRealmSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationSmartRealm() is false

Compliance:

optional - This method must be implemented if supportsOrganizationSmartRealm() is true.

getPositionLookupSession

PositionLookupSession getPositionLookupSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the position lookup service.

Returns:

a PositionLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionLookup() is false

Compliance:

optional - This method must be implemented if supportsPositionLookup() is true.

getPositionLookupSessionForRealm

PositionLookupSession getPositionLookupSessionForRealm(Id realmId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the position lookup service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

a PositionLookupSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPositionLookup() and supportsVisibleFederation() are true

getPositionQuerySession

PositionQuerySession getPositionQuerySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the position query service.

Returns:

a PositionQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionQuery() is false

Compliance:

optional - This method must be implemented if supportsPositionQuery() is true.

getPositionQuerySessionForRealm

PositionQuerySession getPositionQuerySessionForRealm(Id realmId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the position query service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

a PositionQuerySession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPositionQuery() and supportsVisibleFederation() are true

getPositionSearchSession

PositionSearchSession getPositionSearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the position search service.

Returns:

a PositionSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionSearch() is false

Compliance:

optional - This method must be implemented if supportsPositionSearch() is true.

getPositionSearchSessionForRealm

PositionSearchSession getPositionSearchSessionForRealm(Id realmId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the position search service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

a PositionSearchSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPositionSearch() and supportsVisibleFederation() are true

getPositionAdminSession

PositionAdminSession getPositionAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the position administration service.

Returns:

a PositionAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionAdmin() is false

Compliance:

optional - This method must be implemented if supportsPositionAdmin() is true.

getPositionAdminSessionForRealm

PositionAdminSession getPositionAdminSessionForRealm(Id realmId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the position administration service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

a PositionAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPositionAdmin() and supportsVisibleFederation() are true

getPositionNotificationSession

PositionNotificationSession getPositionNotificationSession(PositionReceiver positionReceiver)
                                                           throws OperationFailedException

Gets the OsidSession associated with the position notification service.

Parameters:

positionReceiver - the receiver

Returns:

a PositionNotificationSession

Throws:

NullArgumentException - positionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionNotification() is false

Compliance:

optional - This method must be implemented if supportsPositionNotification() is true.

getPositionNotificationSessionForRealm

PositionNotificationSession getPositionNotificationSessionForRealm(PositionReceiver positionReceiver,
                                                                 Id realmId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the position notification service for the given realm.

Parameters:

positionReceiver - the receiver

realmId - the Id of the Realm

Returns:

a PositionNotificationSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - positionReceiver or realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPositionNotification() and supportsVisibleFederation() are true

getPositionRealmSession

PositionRealmSession getPositionRealmSession()
                                             throws OperationFailedException

Gets the session for retrieving position to realm mappings.

Returns:

a PositionRealmSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionRealm() is false

Compliance:

optional - This method must be implemented if supportsPositionRealm() is true.

getPositionRealmAssignmentSession

PositionRealmAssignmentSession getPositionRealmAssignmentSession()
                                                                 throws OperationFailedException

Gets the session for assigning position to realm mappings.

Returns:

a PositionRealmAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionRealmAssignment() is false

Compliance:

optional - This method must be implemented if supportsPositionRealmAssignment() is true.

getPositionSmartRealmSession

PositionSmartRealmSession getPositionSmartRealmSession(Id realmId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

realmId - the Id of the realm

Returns:

a PositionSmartRealmSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionSmartRealm() is false

Compliance:

optional - This method must be implemented if supportsPositionSmartRealm() is true.

getAppointmentLookupSession

AppointmentLookupSession getAppointmentLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the appointment lookup service.

Returns:

an AppointmentLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentLookup() is false

Compliance:

optional - This method must be implemented if supportsAppointmentLookup() is true.

getAppointmentLookupSessionForRealm

AppointmentLookupSession getAppointmentLookupSessionForRealm(Id realmId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the appointment lookup service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

an AppointmentLookupSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAppointmentLookup() and supportsVisibleFederation() are true

getAppointmentQuerySession

AppointmentQuerySession getAppointmentQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the appointment query service.

Returns:

an AppointmentQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentQuery() is false

Compliance:

optional - This method must be implemented if supportsAppointmentQuery() is true.

getAppointmentQuerySessionForRealm

AppointmentQuerySession getAppointmentQuerySessionForRealm(Id realmId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the appointment query service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

an AppointmentQuerySession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAppointmentQuery() and supportsVisibleFederation() are true

getAppointmentSearchSession

AppointmentSearchSession getAppointmentSearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the appointment search service.

Returns:

an AppointmentSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentSearch() is false

Compliance:

optional - This method must be implemented if supportsAppointmentSearch() is true.

getAppointmentSearchSessionForRealm

AppointmentSearchSession getAppointmentSearchSessionForRealm(Id realmId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the appointment search service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

an AppointmentSearchSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAppointmentSearch() and supportsVisibleFederation() are true

getAppointmentAdminSession

AppointmentAdminSession getAppointmentAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the appointment administration service.

Returns:

an AppointmentAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentAdmin() is false

Compliance:

optional - This method must be implemented if supportsAppointmentAdmin() is true.

getAppointmentAdminSessionForRealm

AppointmentAdminSession getAppointmentAdminSessionForRealm(Id realmId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the appointment administration service for the given realm.

Parameters:

realmId - the Id of the Realm

Returns:

an AppointmentAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAppointmentAdmin() and supportsVisibleFederation() are true

getAppointmentNotificationSession

AppointmentNotificationSession getAppointmentNotificationSession(AppointmentReceiver appointmentReceiver)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the appointment notification service.

Parameters:

appointmentReceiver - the receiver

Returns:

an AppointmentNotificationSession

Throws:

NullArgumentException - appointmentReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentNotification() is false

Compliance:

optional - This method must be implemented if supportsAppointmentNotification() is true.

getAppointmentNotificationSessionForRealm

AppointmentNotificationSession getAppointmentNotificationSessionForRealm(AppointmentReceiver appointmentReceiver,
                                                                       Id realmId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the appointment notification service for the given realm.

Parameters:

appointmentReceiver - the receiver

realmId - the Id of the Realm

Returns:

an AppointmentNotificationSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - appointmentReceiver or realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAppointmentNotification() and supportsVisibleFederation() are true

getAppointmentRealmSession

AppointmentRealmSession getAppointmentRealmSession()
                                                   throws OperationFailedException

Gets the session for retrieving appointment to realm mappings.

Returns:

an AppointmentRealmSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentRealm() is false

Compliance:

optional - This method must be implemented if supportsAppointmentRealm() is true.

getAppointmentRealmAssignmentSession

AppointmentRealmAssignmentSession getAppointmentRealmAssignmentSession()
                                                                       throws OperationFailedException

Gets the session for assigning appointment to realm mappings.

Returns:

an AppointmentRealmAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentRealmAssignment() is false

Compliance:

optional - This method must be implemented if supportsAppointmentRealmAssignment() is true.

getAppointmentSmartRealmSession

AppointmentSmartRealmSession getAppointmentSmartRealmSession(Id realmId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

realmId - the Id of the realm

Returns:

an AppointmentSmartRealmSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentSmartRealm() is false

Compliance:

optional - This method must be implemented if supportsAppointmenSmarttRealm() is true.

getRealmLookupSession

RealmLookupSession getRealmLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the realm lookup service.

Returns:

a RealmLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmLookup() is false

Compliance:

optional - This method must be implemented if supportsRealmLookup() is true.

getRealmQuerySession

RealmQuerySession getRealmQuerySession()
                                       throws OperationFailedException

Gets the OsidSession associated with the realm query service.

Returns:

a RealmQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmQuery() is false

Compliance:

optional - This method must be implemented if supportsRealmQuery() is true.

getRealmSearchSession

RealmSearchSession getRealmSearchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the realm search service.

Returns:

a RealmSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmSearch() is false

Compliance:

optional - This method must be implemented if supportsRealmSearch() is true.

getRealmAdminSession

RealmAdminSession getRealmAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the realm administrative service.

Returns:

a RealmAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmAdmin() is false

Compliance:

optional - This method must be implemented if supportsRealmAdmin() is true.

getRealmNotificationSession

RealmNotificationSession getRealmNotificationSession(RealmReceiver realmReceiver)
                                                     throws OperationFailedException

Gets the OsidSession associated with the realm notification service.

Parameters:

realmReceiver - the receiver

Returns:

a RealmNotificationSession

Throws:

NullArgumentException - realmReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmNotification() is false

Compliance:

optional - This method must be implemented if supportsRealmNotification() is true.

getRealmHierarchySession

RealmHierarchySession getRealmHierarchySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the realm hierarchy service.

Returns:

a RealmHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmHierarchy() is false

Compliance:

optional - This method must be implemented if supportsRealmHierarchy() is true.

getRealmHierarchyDesignSession

RealmHierarchyDesignSession getRealmHierarchyDesignSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the realm hierarchy design service.

Returns:

a RealmHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsRealmHierarchyDesign() is true.

getPersonnelBatchManager

PersonnelBatchManager getPersonnelBatchManager()
                                               throws OperationFailedException

Gets a PersonnelBatchManager.

Returns:

a PersonnelBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonnelBatch() is false

Compliance:

optional - This method must be implemented if supportsPersonnelBatch() is true.