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

The personnel batch manager provides access to personnel batch sessions and provides interoperability tests for various aspects of this service. 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.

Returnosid.personnel.batch.PersonBatchAdminSessiona PersonBatchAdminSession
ErrorsOPERATION_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
Returnosid.personnel.batch.PersonBatchAdminSessiona PersonBatchAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId 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.

Returnosid.personnel.batch.OrganizationBatchAdminSessionan OrganizationBatchAdminSession
ErrorsOPERATION_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
Returnosid.personnel.batch.OrganizationBatchAdminSessionan OrganizationBatchAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId 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.

Returnosid.personnel.batch.PositionBatchAdminSessiona PositionBatchAdminSession
ErrorsOPERATION_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
Returnosid.personnel.batch.PositionBatchAdminSessiona PositionBatchAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId 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.

Returnosid.personnel.batch.AppointmentBatchAdminSessionan AppointmentBatchAdminSession
ErrorsOPERATION_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
Returnosid.personnel.batch.AppointmentBatchAdminSessionan AppointmentBatchAdminSession
ErrorsNOT_FOUNDno Realm found by the given Id
NULL_ARGUMENT realmId 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.

Returnosid.personnel.batch.RealmBatchAdminSessiona RealmBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRealmBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRealmBatchAdmin() is true.