org.osid.personnel

Interface PersonnelProxyManager

All Superinterfaces:

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

public interface PersonnelProxyManager
extends OsidProxyManager, PersonnelProfile

The personnel manager provides access to personnel sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy interface for passing information from a server environment. 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(Proxy proxy) Gets the OsidSession associated with the appointment administration service.
AppointmentAdminSession	getAppointmentAdminSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the appointment administration service for the given realm.
AppointmentLookupSession	getAppointmentLookupSession(Proxy proxy) Gets the OsidSession associated with the appointment lookup service.
AppointmentLookupSession	getAppointmentLookupSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the appointment lookup service for the given realm.
AppointmentNotificationSession	getAppointmentNotificationSession(AppointmentReceiver appointmentReceiver, Proxy proxy) Gets the OsidSession associated with the appointment notification service.
AppointmentNotificationSession	getAppointmentNotificationSessionForRealm(AppointmentReceiver appointmentReceiver, Id realmId, Proxy proxy) Gets the OsidSession associated with the appointment notification service for the given realm.
AppointmentQuerySession	getAppointmentQuerySession(Proxy proxy) Gets the OsidSession associated with the appointment query service.
AppointmentQuerySession	getAppointmentQuerySessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the appointment query service for the given realm.
AppointmentRealmAssignmentSession	getAppointmentRealmAssignmentSession(Proxy proxy) Gets the session for assigning appointment to realm mappings.
AppointmentRealmSession	getAppointmentRealmSession(Proxy proxy) Gets the session for retrieving appointment to realm mappings.
AppointmentSearchSession	getAppointmentSearchSession(Proxy proxy) Gets the OsidSession associated with the appointment search service.
AppointmentSearchSession	getAppointmentSearchSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the appointment search service for the given realm.
AppointmentSmartRealmSession	getAppointmentSmartRealmSession(Id realmId, Proxy proxy) Gets the session for managing dynamic appointment realms for the given realm.
OrganizationAdminSession	getOrganizationAdminSession(Proxy proxy) Gets the OsidSession associated with the organization administration service.
OrganizationAdminSession	getOrganizationAdminSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the organization administration service for the given realm.
OrganizationHierarchyDesignSession	getOrganizationHierarchyDesignSession(Proxy proxy) Gets the session designing organization hierarchies.
OrganizationHierarchyDesignSession	getOrganizationHierarchyDesignSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the organization heirarchy design service for the given realm.
OrganizationHierarchySession	getOrganizationHierarchySession(Proxy proxy) Gets the session traversing organization hierarchies.
OrganizationHierarchySession	getOrganizationHierarchySessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the organization heirarchy traversal service for the given realm.
OrganizationLookupSession	getOrganizationLookupSession(Proxy proxy) Gets the OsidSession associated with the organization lookup service.
OrganizationLookupSession	getOrganizationLookupSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the organization lookup service for the given realm.
OrganizationNotificationSession	getOrganizationNotificationSession(OrganizationReceiver organizationReceiver, Proxy proxy) Gets the OsidSession associated with the organization notification service.
OrganizationNotificationSession	getOrganizationNotificationSessionForRealm(OrganizationReceiver organizationReceiver, Id realmId, Proxy proxy) Gets the OsidSession associated with the organization notification service for the given realm.
OrganizationQuerySession	getOrganizationQuerySession(Proxy proxy) Gets the OsidSession associated with the organization query service.
OrganizationQuerySession	getOrganizationQuerySessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the organization query service for the given realm.
OrganizationRealmAssignmentSession	getOrganizationRealmAssignmentSession(Proxy proxy) Gets the session for assigning organization to realm mappings.
OrganizationRealmSession	getOrganizationRealmSession(Proxy proxy) Gets the session for retrieving organization to realm mappings.
OrganizationSearchSession	getOrganizationSearchSession(Proxy proxy) Gets the OsidSession associated with the organization search service.
OrganizationSearchSession	getOrganizationSearchSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the organization search service for the given realm.
OrganizationSmartRealmSession	getOrganizationSmartRealmSession(Id realmId, Proxy proxy) Gets the session for managing dynamic organization realms for the given realm.
PersonAdminSession	getPersonAdminSession(Proxy proxy) Gets the OsidSession associated with the person administration service.
PersonAdminSession	getPersonAdminSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the person administration service for the given realm.
PersonLookupSession	getPersonLookupSession(Proxy proxy) Gets the OsidSession associated with the person lookup service.
PersonLookupSession	getPersonLookupSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the person lookup service for the given realm.
PersonnelBatchProxyManager	getPersonnelBatchProxyManager() Gets a PersonnelBatchProxyManager.
PersonNotificationSession	getPersonNotificationSession(PersonReceiver personReceiver, Proxy proxy) Gets the OsidSession associated with the person notification service.
PersonNotificationSession	getPersonNotificationSessionForRealm(PersonReceiver personReceiver, Id realmId, Proxy proxy) Gets the OsidSession associated with the person notification service for the given realm.
PersonQuerySession	getPersonQuerySession(Proxy proxy) Gets the OsidSession associated with the person query service.
PersonQuerySession	getPersonQuerySessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the person query service for the given realm.
PersonRealmAssignmentSession	getPersonRealmAssignmentSession(Proxy proxy) Gets the session for assigning person to realm mappings.
PersonRealmSession	getPersonRealmSession(Proxy proxy) Gets the session for retrieving person to realm mappings.
PersonSearchSession	getPersonSearchSession(Proxy proxy) Gets the OsidSession associated with the person search service.
PersonSearchSession	getPersonSearchSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the person search service for the given realm.
PersonSmartRealmSession	getPersonSmartRealmSession(Id realmId, Proxy proxy) Gets the session for managing dynamic person realms for the given realm.
PositionAdminSession	getPositionAdminSession(Proxy proxy) Gets the OsidSession associated with the position administration service.
PositionAdminSession	getPositionAdminSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the position administration service for the given realm.
PositionLookupSession	getPositionLookupSession(Proxy proxy) Gets the OsidSession associated with the position lookup service.
PositionLookupSession	getPositionLookupSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the position lookup service for the given realm.
PositionNotificationSession	getPositionNotificationSession(PositionReceiver positionReceiver, Proxy proxy) Gets the OsidSession associated with the position notification service.
PositionNotificationSession	getPositionNotificationSessionForRealm(PositionReceiver positionReceiver, Id realmId, Proxy proxy) Gets the OsidSession associated with the position notification service for the given realm.
PositionQuerySession	getPositionQuerySession(Proxy proxy) Gets the OsidSession associated with the position query service.
PositionQuerySession	getPositionQuerySessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the position query service for the given realm.
PositionRealmAssignmentSession	getPositionRealmAssignmentSession(Proxy proxy) Gets the session for assigning position to realm mappings.
PositionRealmSession	getPositionRealmSession(Proxy proxy) Gets the session for retrieving position to realm mappings.
PositionSearchSession	getPositionSearchSession(Proxy proxy) Gets the OsidSession associated with the position search service.
PositionSearchSession	getPositionSearchSessionForRealm(Id realmId, Proxy proxy) Gets the OsidSession associated with the position search service for the given realm.
PositionSmartRealmSession	getPositionSmartRealmSession(Id realmId, Proxy proxy) Gets the session for managing dynamic position realms for the given realm.
RealmAdminSession	getRealmAdminSession(Proxy proxy) Gets the OsidSession associated with the realm administrative service.
RealmHierarchyDesignSession	getRealmHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the realm hierarchy design service.
RealmHierarchySession	getRealmHierarchySession(Proxy proxy) Gets the OsidSession associated with the realm hierarchy service.
RealmLookupSession	getRealmLookupSession(Proxy proxy) Gets the OsidSession associated with the realm lookup service.
RealmNotificationSession	getRealmNotificationSession(RealmReceiver realmReceiver, Proxy proxy) Gets the OsidSession associated with the realm notification service.
RealmQuerySession	getRealmQuerySession(Proxy proxy) Gets the OsidSession associated with the realm query service.
RealmSearchSession	getRealmSearchSession(Proxy proxy) Gets the OsidSession associated with the realm search service.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the person lookup service.

Parameters:

proxy - a proxy

Returns:

a PersonLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PersonLookupSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the person query service.

Parameters:

proxy - a proxy

Returns:

a PersonQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PersonQuerySession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the person search service.

Parameters:

proxy - a proxy

Returns:

a PersonSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PersonSearchSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the person administration service.

Parameters:

proxy - a proxy

Returns:

a PersonAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PersonAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the person notification service.

Parameters:

personReceiver - the receiver

proxy - a proxy

Returns:

a PersonNotificationSession

Throws:

NullArgumentException - personReceiver or proxy 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,
                                                             Proxy proxy)
                                                               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

proxy - a proxy

Returns:

a PersonNotificationSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - personReceiver, realmId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the session for retrieving person to realm mappings.

Parameters:

proxy - a proxy

Returns:

a PersonRealmSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonRealm() is false

Compliance:

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

getPersonRealmAssignmentSession

PersonRealmAssignmentSession getPersonRealmAssignmentSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the session for assigning person to realm mappings.

Parameters:

proxy - a proxy

Returns:

a PersonRealmAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the session for managing dynamic person realms for the given realm.

Parameters:

realmId - the Id of a realm

proxy - a proxy

Returns:

a PersonSmartRealmSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the organization lookup service.

Parameters:

proxy - a proxy

Returns:

an OrganizationLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an OrganizationLookupSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the organization query service.

Parameters:

proxy - a proxy

Returns:

an OrganizationQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an OrganizationQuerySession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the organization search service.

Parameters:

proxy - a proxy

Returns:

an OrganizationSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an OrganizationSearchSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the organization administration service.

Parameters:

proxy - a proxy

Returns:

an OrganizationAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an OrganizationAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the organization notification service.

Parameters:

organizationReceiver - the receiver

proxy - a proxy

Returns:

an OrganizationNotificationSession

Throws:

NullArgumentException - organizationReceiver or proxy 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,
                                                                         Proxy proxy)
                                                                           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

proxy - a proxy

Returns:

an OrganizationNotificationSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - organizationReceiver, realmId or proxy 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(Proxy proxy)
                                                             throws OperationFailedException

Gets the session traversing organization hierarchies.

Parameters:

proxy - a proxy

Returns:

an OrganizationHierarchySession

Throws:

NullArgumentException - proxy is null

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,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

realmId - the Id of the realm

proxy - a proxy

Returns:

an OrganizationHierarchySession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                                         throws OperationFailedException

Gets the session designing organization hierarchies.

Parameters:

proxy - a proxy

Returns:

an OrganizationHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

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,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

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

Parameters:

realmId - the Id of the realm

proxy - a proxy

Returns:

an OrganizationHierarchyDesignSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the session for retrieving organization to realm mappings.

Parameters:

proxy - a proxy

Returns:

an OrganizationRealmSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationRealm() is false

Compliance:

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

getOrganizationRealmAssignmentSession

OrganizationRealmAssignmentSession getOrganizationRealmAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the session for assigning organization to realm mappings.

Parameters:

proxy - a proxy

Returns:

an OrganizationRealmAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the session for managing dynamic organization realms for the given realm.

Parameters:

realmId - the Id of a realm

proxy - a proxy

Returns:

an OrganizationSmartRealmSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the position lookup service.

Parameters:

proxy - a proxy

Returns:

a PositionLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PositionLookupSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the position query service.

Parameters:

proxy - a proxy

Returns:

a PositionQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PositionQuerySession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the position search service.

Parameters:

proxy - a proxy

Returns:

a PositionSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PositionSearchSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the position administration service.

Parameters:

proxy - a proxy

Returns:

a PositionAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PositionAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the position notification service.

Parameters:

positionReceiver - the receiver

proxy - a proxy

Returns:

a PositionNotificationSession

Throws:

NullArgumentException - positionReceiver or proxy 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,
                                                                 Proxy proxy)
                                                                   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

proxy - a proxy

Returns:

a PositionNotificationSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - positionReceiver, realmId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the session for retrieving position to realm mappings.

Parameters:

proxy - a proxy

Returns:

a PositionRealmSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionRealm() is false

Compliance:

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

getPositionRealmAssignmentSession

PositionRealmAssignmentSession getPositionRealmAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the session for assigning position to realm mappings.

Parameters:

proxy - a proxy

Returns:

a PositionRealmAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session for managing dynamic position realms for the given realm.

Parameters:

realmId - the Id of a realm

proxy - a proxy

Returns:

a PositionSmartRealmSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the appointment lookup service.

Parameters:

proxy - a proxy

Returns:

an AppointmentLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an AppointmentLookupSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the appointment query service.

Parameters:

proxy - a proxy

Returns:

an AppointmentQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an AppointmentQuerySession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the appointment search service.

Parameters:

proxy - a proxy

Returns:

an AppointmentSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an AppointmentSearchSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the appointment administration service.

Parameters:

proxy - a proxy

Returns:

an AppointmentAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an AppointmentAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the appointment notification service.

Parameters:

appointmentReceiver - the receiver

proxy - a proxy

Returns:

an AppointmentNotificationSession

Throws:

NullArgumentException - appointmentReceiver or proxy 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,
                                                                       Proxy proxy)
                                                                         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

proxy - a proxy

Returns:

an AppointmentNotificationSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - appointmentReceiver, realmId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the session for retrieving appointment to realm mappings.

Parameters:

proxy - a proxy

Returns:

an AppointmentRealmSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentRealm() is false

Compliance:

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

getAppointmentRealmAssignmentSession

AppointmentRealmAssignmentSession getAppointmentRealmAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the session for assigning appointment to realm mappings.

Parameters:

proxy - a proxy

Returns:

an AppointmentRealmAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the session for managing dynamic appointment realms for the given realm.

Parameters:

realmId - the Id of a realm

proxy - a proxy

Returns:

an AppointmentSmartRealmSession

Throws:

NotFoundException - realmId not found

NullArgumentException - realmId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentSmartRealm() is false

Compliance:

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

getRealmLookupSession

RealmLookupSession getRealmLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the realm lookup service.

Parameters:

proxy - a proxy

Returns:

a RealmLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmLookup() is false

Compliance:

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

getRealmQuerySession

RealmQuerySession getRealmQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the realm query service.

Parameters:

proxy - a proxy

Returns:

a RealmQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmQuery() is false

Compliance:

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

getRealmSearchSession

RealmSearchSession getRealmSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the realm search service.

Parameters:

proxy - a proxy

Returns:

a RealmSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmSearch() is false

Compliance:

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

getRealmAdminSession

RealmAdminSession getRealmAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the realm administrative service.

Parameters:

proxy - a proxy

Returns:

a RealmAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the realm notification service.

Parameters:

realmReceiver - the receiver

proxy - a proxy

Returns:

a RealmNotificationSession

Throws:

NullArgumentException - realmReceiver or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the realm hierarchy service.

Parameters:

proxy - a proxy

Returns:

a RealmHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmHierarchy() is false

Compliance:

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

getRealmHierarchyDesignSession

RealmHierarchyDesignSession getRealmHierarchyDesignSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the realm hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a RealmHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmHierarchyDesign() is false

Compliance:

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

getPersonnelBatchProxyManager

PersonnelBatchProxyManager getPersonnelBatchProxyManager()
                                                         throws OperationFailedException

Gets a PersonnelBatchProxyManager.

Returns:

a PersonnelBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonnelBatch() is false

Compliance:

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