| Interface | osid.personnel.batch.PersonnelBatchManager | ||
|---|---|---|---|
| Implements | osid.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: 
  | ||
| Method | getPersonBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.personnel.batch.PersonBatchAdminSession | a  PersonBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsPersonBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPersonBatchAdmin() 
 is  true.   | |
| Method | getPersonBatchAdminSessionForRealm | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | realmId | the  Id  of the  Realm   | 
| Return | osid.personnel.batch.PersonBatchAdminSession | a  PersonBatchAdminSession   | |
| Errors | NOT_FOUND | no  Realm  found by the given  Id   |                 |
| NULL_ARGUMENT |  realmId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsPersonBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPersonBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getOrganizationBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.personnel.batch.OrganizationBatchAdminSession | an  OrganizationBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsOrganizationBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsOrganizationBatchAdmin() 
 is  true.   | |
| Method | getOrganizationBatchAdminSessionForRealm | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | realmId | the  Id  of the  Realm   | 
| Return | osid.personnel.batch.OrganizationBatchAdminSession | an  OrganizationBatchAdminSession   | |
| Errors | NOT_FOUND | no  Realm  found by the given  Id   |                 |
| NULL_ARGUMENT |  realmId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsOrganizationBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsOrganizationBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getPositionBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.personnel.batch.PositionBatchAdminSession | a  PositionBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsPositionBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPositionBatchAdmin() 
 is  true.   | |
| Method | getPositionBatchAdminSessionForRealm | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | realmId | the  Id  of the  Realm   | 
| Return | osid.personnel.batch.PositionBatchAdminSession | a  PositionBatchAdminSession   | |
| Errors | NOT_FOUND | no  Realm  found by the given  Id   |                 |
| NULL_ARGUMENT |  realmId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsPositionBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsPositionBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getAppointmentBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.personnel.batch.AppointmentBatchAdminSession | an  AppointmentBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsAppointmentBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsAppointmentBatchAdmin() 
 is  true.   | |
| Method | getAppointmentBatchAdminSessionForRealm | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | realmId | the  Id  of the  Realm   | 
| Return | osid.personnel.batch.AppointmentBatchAdminSession | an  AppointmentBatchAdminSession   | |
| Errors | NOT_FOUND | no  Realm  found by the given  Id   |                 |
| NULL_ARGUMENT |  realmId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsAppointmentBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsAppointmentBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getRealmBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.personnel.batch.RealmBatchAdminSession | a  RealmBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsRealmBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsRealmBatchAdmin()  
is  true.   | |