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.
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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
PersonLookupSession getPersonLookupSession() throws OperationFailedException
OsidSession
associated with the person lookup
service. PersonLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonLookup()
is false
optional
- This method must be implemented if
supportsPersonLookup()
is true.
PersonLookupSession getPersonLookupSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the person lookup
service for the given realm.realmId
- the Id
of the Realm
PersonLookupSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPersonLookup()
and
supportsVisibleFederation()
are true
PersonQuerySession getPersonQuerySession() throws OperationFailedException
OsidSession
associated with the person query
service. PersonQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonQuery()
is false
optional
- This method must be implemented if
supportsPersonQuery()
is true.
PersonQuerySession getPersonQuerySessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the person query
service for the given realm.realmId
- the Id
of the Realm
PersonQuerySession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPersonQuery()
and
supportsVisibleFederation()
are true
PersonSearchSession getPersonSearchSession() throws OperationFailedException
OsidSession
associated with the person search
service. PersonSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonSearch()
is false
optional
- This method must be implemented if
supportsPersonSearch()
is true.
PersonSearchSession getPersonSearchSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the person search
service for the given realm.realmId
- the Id
of the Realm
PersonSearchSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPersonSearch()
and
supportsVisibleFederation()
are true
PersonAdminSession getPersonAdminSession() throws OperationFailedException
OsidSession
associated with the person
administration service. PersonAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonAdmin()
is false
optional
- This method must be implemented if
supportsPersonAdmin()
is true.
PersonAdminSession getPersonAdminSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the person
administration service for the given realm.realmId
- the Id
of the Realm
PersonAdminSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPersonAdmin()
and
supportsVisibleFederation()
are true
PersonNotificationSession getPersonNotificationSession(PersonReceiver personReceiver) throws OperationFailedException
OsidSession
associated with the person
notification service.personReceiver
- the receiver PersonNotificationSession
NullArgumentException
- personReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPersonNotification()
is false
optional
- This method must be implemented if
supportsPersonNotification()
is true.
PersonNotificationSession getPersonNotificationSessionForRealm(PersonReceiver personReceiver, Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the person
notification service for the given realm.personReceiver
- the receiverrealmId
- the Id
of the Realm
PersonNotificationSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- personReceiver
or realmId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPersonNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPersonNotification()
and
supportsVisibleFederation()
are true
PersonRealmSession getPersonRealmSession() throws OperationFailedException
PersonRealmSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonRealm()
is false
optional
- This method must be implemented if
supportsPersonRealm()
is true.
PersonRealmAssignmentSession getPersonRealmAssignmentSession() throws OperationFailedException
PersonRealmAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPersonRealmAssignment()
is false
optional
- This method must be implemented if
supportsPersonRealmAssignment()
is true.
PersonSmartRealmSession getPersonSmartRealmSession(Id realmId) throws NotFoundException, OperationFailedException
realmId
- the Id
of the realm PersonSmartRealmSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPersonSmartRealm()
is false
optional
- This method must be implemented if
supportsPersonSmartRealm()
is true.
OrganizationLookupSession getOrganizationLookupSession() throws OperationFailedException
OsidSession
associated with the organization
lookup service. OrganizationLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationLookup()
is false
optional
- This method must be implemented if
supportsOrganizationLookup()
is true.
OrganizationLookupSession getOrganizationLookupSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
lookup service for the given realm.realmId
- the Id
of the Realm
OrganizationLookupSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOrganizationLookup()
and
supportsVisibleFederation()
are true
OrganizationQuerySession getOrganizationQuerySession() throws OperationFailedException
OsidSession
associated with the organization
query service. OrganizationQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationQuery()
is false
optional
- This method must be implemented if
supportsOrganizationQuery()
is true.
OrganizationQuerySession getOrganizationQuerySessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
query service for the given realm.realmId
- the Id
of the Realm
OrganizationQuerySession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOrganizationQuery()
and
supportsVisibleFederation()
are true
OrganizationSearchSession getOrganizationSearchSession() throws OperationFailedException
OsidSession
associated with the organization
search service. OrganizationSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationSearch()
is false
optional
- This method must be implemented if
supportsOrganizationSearch()
is true.
OrganizationSearchSession getOrganizationSearchSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
search service for the given realm.realmId
- the Id
of the Realm
OrganizationSearchSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOrganizationSearch()
and
supportsVisibleFederation()
are true
OrganizationAdminSession getOrganizationAdminSession() throws OperationFailedException
OsidSession
associated with the organization
administration service. OrganizationAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationAdmin()
is false
optional
- This method must be implemented if
supportsOrganizationAdmin()
is true.
OrganizationAdminSession getOrganizationAdminSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
administration service for the given realm.realmId
- the Id
of the Realm
OrganizationAdminSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOrganizationAdmin()
and
supportsVisibleFederation()
are true
OrganizationNotificationSession getOrganizationNotificationSession(OrganizationReceiver organizationReceiver) throws OperationFailedException
OsidSession
associated with the organization
notification service.organizationReceiver
- the receiver OrganizationNotificationSession
NullArgumentException
- organizationReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationNotification()
is false
optional
- This method must be implemented if
supportsOrganizationNotification()
is true.
OrganizationNotificationSession getOrganizationNotificationSessionForRealm(OrganizationReceiver organizationReceiver, Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
notification service for the given realm.organizationReceiver
- the receiverrealmId
- the Id
of the Realm
OrganizationNotificationSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- organizationReceiver
or realmId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOrganizationNotification()
and
supportsVisibleFederation()
are true
OrganizationHierarchySession getOrganizationHierarchySession() throws OperationFailedException
OrganizationHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationHierarchy() is false
optional
- This method must be implemented if
supportsOrganizationHierarchy()
is true. OrganizationHierarchySession getOrganizationHierarchySessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
heirarchy traversal service for the given realm.realmId
- the Id
of the realm OrganizationHierarchySession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsOrganizationHierarchy()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOrganizationHierarchy()
and
supportsVisibleFederation()
are true.
OrganizationHierarchyDesignSession getOrganizationHierarchyDesignSession() throws OperationFailedException
OrganizationHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationHierarchyDesign() is false
optional
- This method must be implemented if
supportsOrganizationHierarchyDesign()
is true. OrganizationHierarchyDesignSession getOrganizationHierarchyDesignSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
heirarchy design service for the given realm.realmId
- the Id
of the realm OrganizationHierarchyDesignSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsOrganizationHierarchyDesign()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOrganizationHierarchyDesign()
and
supportsVisibleFederation()
are true.
OrganizationRealmSession getOrganizationRealmSession() throws OperationFailedException
OrganizationRealmSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationRealm()
is false
optional
- This method must be implemented if
supportsOrganizationRealm()
is true.
OrganizationRealmAssignmentSession getOrganizationRealmAssignmentSession() throws OperationFailedException
OrganizationRealmAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationRealmAssignment()
is false
optional
- This method must be implemented if
supportsOrganizationRealmAssignment()
is
true.
OrganizationSmartRealmSession getOrganizationSmartRealmSession(Id realmId) throws NotFoundException, OperationFailedException
realmId
- the Id
of the realm OrganizationSmartRealmSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationSmartRealm()
is false
optional
- This method must be implemented if
supportsOrganizationSmartRealm()
is true.
PositionLookupSession getPositionLookupSession() throws OperationFailedException
OsidSession
associated with the position
lookup service. PositionLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionLookup()
is false
optional
- This method must be implemented if
supportsPositionLookup()
is true.
PositionLookupSession getPositionLookupSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the position
lookup service for the given realm.realmId
- the Id
of the Realm
PositionLookupSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPositionLookup()
and
supportsVisibleFederation()
are true
PositionQuerySession getPositionQuerySession() throws OperationFailedException
OsidSession
associated with the position query
service. PositionQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPositionQuery()
is false
optional
- This method must be implemented if
supportsPositionQuery()
is true.
PositionQuerySession getPositionQuerySessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the position query
service for the given realm.realmId
- the Id
of the Realm
PositionQuerySession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPositionQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPositionQuery()
and
supportsVisibleFederation()
are true
PositionSearchSession getPositionSearchSession() throws OperationFailedException
OsidSession
associated with the position
search service. PositionSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionSearch()
is false
optional
- This method must be implemented if
supportsPositionSearch()
is true.
PositionSearchSession getPositionSearchSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the position
search service for the given realm.realmId
- the Id
of the Realm
PositionSearchSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPositionSearch()
and
supportsVisibleFederation()
are true
PositionAdminSession getPositionAdminSession() throws OperationFailedException
OsidSession
associated with the position
administration service. PositionAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPositionAdmin()
is false
optional
- This method must be implemented if
supportsPositionAdmin()
is true.
PositionAdminSession getPositionAdminSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the position
administration service for the given realm.realmId
- the Id
of the Realm
PositionAdminSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPositionAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPositionAdmin()
and
supportsVisibleFederation()
are true
PositionNotificationSession getPositionNotificationSession(PositionReceiver positionReceiver) throws OperationFailedException
OsidSession
associated with the position
notification service.positionReceiver
- the receiver PositionNotificationSession
NullArgumentException
- positionReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionNotification()
is false
optional
- This method must be implemented if
supportsPositionNotification()
is true.
PositionNotificationSession getPositionNotificationSessionForRealm(PositionReceiver positionReceiver, Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the position
notification service for the given realm.positionReceiver
- the receiverrealmId
- the Id
of the Realm
PositionNotificationSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- positionReceiver
or realmId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPositionNotification()
and
supportsVisibleFederation()
are true
PositionRealmSession getPositionRealmSession() throws OperationFailedException
PositionRealmSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPositionRealm()
is false
optional
- This method must be implemented if
supportsPositionRealm()
is true.
PositionRealmAssignmentSession getPositionRealmAssignmentSession() throws OperationFailedException
PositionRealmAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionRealmAssignment()
is false
optional
- This method must be implemented if
supportsPositionRealmAssignment()
is true.
PositionSmartRealmSession getPositionSmartRealmSession(Id realmId) throws NotFoundException, OperationFailedException
realmId
- the Id
of the realm PositionSmartRealmSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionSmartRealm()
is false
optional
- This method must be implemented if
supportsPositionSmartRealm()
is true.
AppointmentLookupSession getAppointmentLookupSession() throws OperationFailedException
OsidSession
associated with the appointment
lookup service. AppointmentLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentLookup()
is false
optional
- This method must be implemented if
supportsAppointmentLookup()
is true.
AppointmentLookupSession getAppointmentLookupSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
lookup service for the given realm.realmId
- the Id
of the Realm
AppointmentLookupSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAppointmentLookup()
and
supportsVisibleFederation()
are true
AppointmentQuerySession getAppointmentQuerySession() throws OperationFailedException
OsidSession
associated with the appointment
query service. AppointmentQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentQuery()
is false
optional
- This method must be implemented if
supportsAppointmentQuery()
is true.
AppointmentQuerySession getAppointmentQuerySessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
query service for the given realm.realmId
- the Id
of the Realm
AppointmentQuerySession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAppointmentQuery()
and
supportsVisibleFederation()
are true
AppointmentSearchSession getAppointmentSearchSession() throws OperationFailedException
OsidSession
associated with the appointment
search service. AppointmentSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentSearch()
is false
optional
- This method must be implemented if
supportsAppointmentSearch()
is true.
AppointmentSearchSession getAppointmentSearchSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
search service for the given realm.realmId
- the Id
of the Realm
AppointmentSearchSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAppointmentSearch()
and
supportsVisibleFederation()
are true
AppointmentAdminSession getAppointmentAdminSession() throws OperationFailedException
OsidSession
associated with the appointment
administration service. AppointmentAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentAdmin()
is false
optional
- This method must be implemented if
supportsAppointmentAdmin()
is true.
AppointmentAdminSession getAppointmentAdminSessionForRealm(Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
administration service for the given realm.realmId
- the Id
of the Realm
AppointmentAdminSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAppointmentAdmin()
and
supportsVisibleFederation()
are true
AppointmentNotificationSession getAppointmentNotificationSession(AppointmentReceiver appointmentReceiver) throws OperationFailedException
OsidSession
associated with the appointment
notification service.appointmentReceiver
- the receiver AppointmentNotificationSession
NullArgumentException
- appointmentReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentNotification()
is false
optional
- This method must be implemented if
supportsAppointmentNotification()
is true.
AppointmentNotificationSession getAppointmentNotificationSessionForRealm(AppointmentReceiver appointmentReceiver, Id realmId) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
notification service for the given realm.appointmentReceiver
- the receiverrealmId
- the Id
of the Realm
AppointmentNotificationSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- appointmentReceiver
or realmId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAppointmentNotification()
and
supportsVisibleFederation()
are true
AppointmentRealmSession getAppointmentRealmSession() throws OperationFailedException
AppointmentRealmSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentRealm()
is false
optional
- This method must be implemented if
supportsAppointmentRealm()
is true.
AppointmentRealmAssignmentSession getAppointmentRealmAssignmentSession() throws OperationFailedException
AppointmentRealmAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentRealmAssignment()
is false
optional
- This method must be implemented if
supportsAppointmentRealmAssignment()
is
true.
AppointmentSmartRealmSession getAppointmentSmartRealmSession(Id realmId) throws NotFoundException, OperationFailedException
realmId
- the Id
of the realm AppointmentSmartRealmSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentSmartRealm()
is false
optional
- This method must be implemented if
supportsAppointmenSmarttRealm()
is true.
RealmLookupSession getRealmLookupSession() throws OperationFailedException
OsidSession
associated with the realm lookup
service. RealmLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRealmLookup()
is false
optional
- This method must be implemented if
supportsRealmLookup()
is true.
RealmQuerySession getRealmQuerySession() throws OperationFailedException
OsidSession
associated with the realm query
service. RealmQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRealmQuery()
is false
optional
- This method must be implemented if
supportsRealmQuery()
is true.
RealmSearchSession getRealmSearchSession() throws OperationFailedException
OsidSession
associated with the realm search
service. RealmSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRealmSearch()
is false
optional
- This method must be implemented if
supportsRealmSearch()
is true.
RealmAdminSession getRealmAdminSession() throws OperationFailedException
OsidSession
associated with the realm
administrative service. RealmAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRealmAdmin()
is false
optional
- This method must be implemented if
supportsRealmAdmin()
is true.
RealmNotificationSession getRealmNotificationSession(RealmReceiver realmReceiver) throws OperationFailedException
OsidSession
associated with the realm
notification service.realmReceiver
- the receiver RealmNotificationSession
NullArgumentException
- realmReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRealmNotification()
is false
optional
- This method must be implemented if
supportsRealmNotification()
is true.
RealmHierarchySession getRealmHierarchySession() throws OperationFailedException
OsidSession
associated with the realm
hierarchy service. RealmHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRealmHierarchy()
is false
optional
- This method must be implemented if
supportsRealmHierarchy()
is true.
RealmHierarchyDesignSession getRealmHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the realm
hierarchy design service. RealmHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRealmHierarchyDesign()
is false
optional
- This method must be implemented if
supportsRealmHierarchyDesign()
is true.
PersonnelBatchManager getPersonnelBatchManager() throws OperationFailedException
PersonnelBatchManager.
PersonnelBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPersonnelBatch()
is false
optional
- This method must be implemented if
supportsPersonnelBatch()
is true.