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.
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. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the person lookup
service.proxy
- a proxy PersonLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonLookup()
is false
optional
- This method must be implemented if
supportsPersonLookup()
is true.
PersonLookupSession getPersonLookupSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the person lookup
service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy PersonLookupSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the person query
service.proxy
- a proxy PersonQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonQuery()
is false
optional
- This method must be implemented if
supportsPersonQuery()
is true.
PersonQuerySession getPersonQuerySessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the person query
service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy PersonQuerySession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the person search
service.proxy
- a proxy PersonSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonSearch()
is false
optional
- This method must be implemented if
supportsPersonSearch()
is true.
PersonSearchSession getPersonSearchSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the person search
service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy PersonSearchSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the person
administration service.proxy
- a proxy PersonAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonAdmin()
is false
optional
- This method must be implemented if
supportsPersonAdmin()
is true.
PersonAdminSession getPersonAdminSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the person
administration service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy PersonAdminSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the person
notification service.personReceiver
- the receiverproxy
- a proxy PersonNotificationSession
NullArgumentException
- personReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the person
notification service for the given realm.personReceiver
- the receiverrealmId
- the Id
of the Realm
proxy
- a proxy PersonNotificationSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- personReceiver, realmId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy PersonRealmSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPersonRealm()
is false
optional
- This method must be implemented if
supportsPersonRealm()
is true.
PersonRealmAssignmentSession getPersonRealmAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy PersonRealmAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPersonRealmAssignment()
is false
optional
- This method must be implemented if
supportsPersonRealmAssignment()
is true.
PersonSmartRealmSession getPersonSmartRealmSession(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
realmId
- the Id
of a realmproxy
- a proxy PersonSmartRealmSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPersonSmartRealm()
is false
optional
- This method must be implemented if
supportsPersonSmartRealm()
is true.
OrganizationLookupSession getOrganizationLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the organization
lookup service.proxy
- a proxy OrganizationLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationLookup()
is false
optional
- This method must be implemented if
supportsOrganizationLookup()
is true.
OrganizationLookupSession getOrganizationLookupSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
lookup service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy OrganizationLookupSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the organization
query service.proxy
- a proxy OrganizationQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationQuery()
is false
optional
- This method must be implemented if
supportsOrganizationQuery()
is true.
OrganizationQuerySession getOrganizationQuerySessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
query service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy OrganizationQuerySession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the organization
search service.proxy
- a proxy OrganizationSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationSearch()
is false
optional
- This method must be implemented if
supportsOrganizationSearch()
is true.
OrganizationSearchSession getOrganizationSearchSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
search service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy OrganizationSearchSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the organization
administration service.proxy
- a proxy OrganizationAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationAdmin()
is false
optional
- This method must be implemented if
supportsOrganizationAdmin()
is true.
OrganizationAdminSession getOrganizationAdminSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
administration service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy OrganizationAdminSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the organization
notification service.organizationReceiver
- the receiverproxy
- a proxy OrganizationNotificationSession
NullArgumentException
- organizationReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
notification service for the given realm.organizationReceiver
- the receiverrealmId
- the Id
of the Realm
proxy
- a proxy OrganizationNotificationSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- organizationReceiver,
realmId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy OrganizationHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationHierarchy() is false
optional
- This method must be implemented if
supportsOrganizationHierarchy()
is true. OrganizationHierarchySession getOrganizationHierarchySessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
heirarchy traversal service for the given realm.realmId
- the Id
of the realmproxy
- a proxy OrganizationHierarchySession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy OrganizationHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationHierarchyDesign() is false
optional
- This method must be implemented if
supportsOrganizationHierarchyDesign()
is true. OrganizationHierarchyDesignSession getOrganizationHierarchyDesignSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the organization
heirarchy design service for the given realm.realmId
- the Id
of the realmproxy
- a proxy OrganizationHierarchyDesignSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy OrganizationRealmSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationRealm()
is false
optional
- This method must be implemented if
supportsOrganizationRealm()
is true.
OrganizationRealmAssignmentSession getOrganizationRealmAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy OrganizationRealmAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationRealmAssignment()
is false
optional
- This method must be implemented if
supportsOrganizationRealmAssignment()
is
true.
OrganizationSmartRealmSession getOrganizationSmartRealmSession(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
realmId
- the Id
of a realmproxy
- a proxy OrganizationSmartRealmSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOrganizationSmartRealm()
is false
optional
- This method must be implemented if
supportsOrganizationSmartRealm()
is true.
PositionLookupSession getPositionLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the position
lookup service.proxy
- a proxy PositionLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionLookup()
is false
optional
- This method must be implemented if
supportsPositionLookup()
is true.
PositionLookupSession getPositionLookupSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the position
lookup service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy PositionLookupSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the position query
service.proxy
- a proxy PositionQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPositionQuery()
is false
optional
- This method must be implemented if
supportsPositionQuery()
is true.
PositionQuerySession getPositionQuerySessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the position query
service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy PositionQuerySession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the position
search service.proxy
- a proxy PositionSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionSearch()
is false
optional
- This method must be implemented if
supportsPositionSearch()
is true.
PositionSearchSession getPositionSearchSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the position
search service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy PositionSearchSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the position
administration service.proxy
- a proxy PositionAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPositionAdmin()
is false
optional
- This method must be implemented if
supportsPositionAdmin()
is true.
PositionAdminSession getPositionAdminSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the position
administration service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy PositionAdminSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the position
notification service.positionReceiver
- the receiverproxy
- a proxy PositionNotificationSession
NullArgumentException
- positionReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the position
notification service for the given realm.positionReceiver
- the receiverrealmId
- the Id
of the Realm
proxy
- a proxy PositionNotificationSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- positionReceiver,
realmId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy PositionRealmSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPositionRealm()
is false
optional
- This method must be implemented if
supportsPositionRealm()
is true.
PositionRealmAssignmentSession getPositionRealmAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy PositionRealmAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionRealmAssignment()
is false
optional
- This method must be implemented if
supportsPositionRealmAssignment()
is true.
PositionSmartRealmSession getPositionSmartRealmSession(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
realmId
- the Id
of a realmproxy
- a proxy PositionSmartRealmSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPositionSmartRealm()
is false
optional
- This method must be implemented if
supportsPositionSmartRealm()
is true.
AppointmentLookupSession getAppointmentLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the appointment
lookup service.proxy
- a proxy AppointmentLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentLookup()
is false
optional
- This method must be implemented if
supportsAppointmentLookup()
is true.
AppointmentLookupSession getAppointmentLookupSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
lookup service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy AppointmentLookupSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the appointment
query service.proxy
- a proxy AppointmentQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentQuery()
is false
optional
- This method must be implemented if
supportsAppointmentQuery()
is true.
AppointmentQuerySession getAppointmentQuerySessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
query service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy AppointmentQuerySession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the appointment
search service.proxy
- a proxy AppointmentSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentSearch()
is false
optional
- This method must be implemented if
supportsAppointmentSearch()
is true.
AppointmentSearchSession getAppointmentSearchSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
search service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy AppointmentSearchSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the appointment
administration service.proxy
- a proxy AppointmentAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentAdmin()
is false
optional
- This method must be implemented if
supportsAppointmentAdmin()
is true.
AppointmentAdminSession getAppointmentAdminSessionForRealm(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
administration service for the given realm.realmId
- the Id
of the Realm
proxy
- a proxy AppointmentAdminSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- realmId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the appointment
notification service.appointmentReceiver
- the receiverproxy
- a proxy AppointmentNotificationSession
NullArgumentException
- appointmentReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the appointment
notification service for the given realm.appointmentReceiver
- the receiverrealmId
- the Id
of the Realm
proxy
- a proxy AppointmentNotificationSession
NotFoundException
- no Realm
found by
the given Id
NullArgumentException
- appointmentReceiver,
realmId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy AppointmentRealmSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentRealm()
is false
optional
- This method must be implemented if
supportsAppointmentRealm()
is true.
AppointmentRealmAssignmentSession getAppointmentRealmAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AppointmentRealmAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentRealmAssignment()
is false
optional
- This method must be implemented if
supportsAppointmentRealmAssignment()
is
true.
AppointmentSmartRealmSession getAppointmentSmartRealmSession(Id realmId, Proxy proxy) throws NotFoundException, OperationFailedException
realmId
- the Id
of a realmproxy
- a proxy AppointmentSmartRealmSession
NotFoundException
- realmId
not foundNullArgumentException
- realmId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAppointmentSmartRealm()
is false
optional
- This method must be implemented if
supportsAppointmentSmartRealm()
is true.
RealmLookupSession getRealmLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the realm lookup
service.proxy
- a proxy RealmLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRealmLookup()
is false
optional
- This method must be implemented if
supportsRealmLookup()
is true.
RealmQuerySession getRealmQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the realm query
service.proxy
- a proxy RealmQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRealmQuery()
is false
optional
- This method must be implemented if
supportsRealmQuery()
is true.
RealmSearchSession getRealmSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the realm search
service.proxy
- a proxy RealmSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRealmSearch()
is false
optional
- This method must be implemented if
supportsRealmSearch()
is true.
RealmAdminSession getRealmAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the realm
administrative service.proxy
- a proxy RealmAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRealmAdmin()
is false
optional
- This method must be implemented if
supportsRealmAdmin()
is true.
RealmNotificationSession getRealmNotificationSession(RealmReceiver realmReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the realm
notification service.realmReceiver
- the receiverproxy
- a proxy RealmNotificationSession
NullArgumentException
- realmReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRealmNotification()
is false
optional
- This method must be implemented if
supportsRealmNotification()
is true.
RealmHierarchySession getRealmHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the realm
hierarchy service.proxy
- a proxy RealmHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRealmHierarchy()
is false
optional
- This method must be implemented if
supportsRealmHierarchy()
is true.
RealmHierarchyDesignSession getRealmHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the realm
hierarchy design service.proxy
- a proxy RealmHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRealmHierarchyDesign()
is false
optional
- This method must be implemented if
supportsRealmHierarchyDesign()
is true.
PersonnelBatchProxyManager getPersonnelBatchProxyManager() throws OperationFailedException
PersonnelBatchProxyManager.
PersonnelBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPersonnelBatch()
is false
optional
- This method must be implemented if
supportsPersonnelBatch()
is true.