OSID Logo
OSID Specifications
personnel batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.batch.PersonnelBatchProxyManager
Implementsosid.OsidProxyManager
osid.personnel.batch.PersonnelBatchProfile
Description

The personnel batch proxy manager provides access to personnel batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

  • PersonBatchAdminSession: a session to create, modify and delete persons in bulk
  • OrganizationBatchAdminSession: a session to create, modify and delete organizations in bulk
  • PositionBatchSession: a session to create, modify and delete positions in bulk
  • AppointmentBatchAdminSession: a session to create, modify and delete appointments in bulk
  • RealmBatchAdminSession: a session to create, modify and delete realms in bulk
MethodgetPersonBatchAdminSession
Description

Gets the OsidSession associated with the bulk person administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.PersonBatchAdminSessiona PersonBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPersonBatchAdmin() is true.
MethodgetPersonBatchAdminSessionForRealm
Description

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

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.PersonBatchAdminSessiona PersonBatchAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPersonBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPersonBatchAdmin() and supportsVisibleFederation() are true
MethodgetOrganizationBatchAdminSession
Description

Gets the OsidSession associated with the bulk organization administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.OrganizationBatchAdminSessionan OrganizationBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationBatchAdmin() is true.
MethodgetOrganizationBatchAdminSessionForRealm
Description

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

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.OrganizationBatchAdminSessionan OrganizationBatchAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrganizationBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationBatchAdmin() and supportsVisibleFederation() are true
MethodgetPositionBatchAdminSession
Description

Gets the OsidSession associated with the bulk position administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.PositionBatchAdminSessiona PositionBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPositionBatchAdmin() is true.
MethodgetPositionBatchAdminSessionForRealm
Description

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

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.PositionBatchAdminSessiona PositionBatchAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPositionBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPositionBatchAdmin() and supportsVisibleFederation() are true
MethodgetAppointmentBatchAdminSession
Description

Gets the OsidSession associated with the bulk appointment administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.AppointmentBatchAdminSessionan AppointmentBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentBatchAdmin() is true.
MethodgetAppointmentBatchAdminSessionForRealm
Description

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

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.AppointmentBatchAdminSessionan AppointmentBatchAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAppointmentBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAppointmentBatchAdmin() and supportsVisibleFederation() are true
MethodgetRealmBatchAdminSession
Description

Gets the OsidSession associated with the bulk realm administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.personnel.batch.RealmBatchAdminSessiona RealmBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRealmBatchAdmin() is true.