org.osid.personnel.batch

Interface PersonnelBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, PersonnelBatchProfile, Sourceable

public interface PersonnelBatchManager
extends OsidManager, PersonnelBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AppointmentBatchAdminSession	getAppointmentBatchAdminSession() Gets the OsidSession associated with the bulk appointment administration service.
AppointmentBatchAdminSession	getAppointmentBatchAdminSessionForRealm(Id realmId) Gets the OsidSession associated with the bulk appointment administration service for the given realm.
OrganizationBatchAdminSession	getOrganizationBatchAdminSession() Gets the OsidSession associated with the bulk organization administration service.
OrganizationBatchAdminSession	getOrganizationBatchAdminSessionForRealm(Id realmId) Gets the OsidSession associated with the bulk organization administration service for the given realm.
PersonBatchAdminSession	getPersonBatchAdminSession() Gets the OsidSession associated with the bulk person administration service.
PersonBatchAdminSession	getPersonBatchAdminSessionForRealm(Id realmId) Gets the OsidSession associated with the bulk person administration service for the given realm.
PositionBatchAdminSession	getPositionBatchAdminSession() Gets the OsidSession associated with the bulk position administration service.
PositionBatchAdminSession	getPositionBatchAdminSessionForRealm(Id realmId) Gets the OsidSession associated with the bulk position administration service for the given realm.
RealmBatchAdminSession	getRealmBatchAdminSession() Gets the OsidSession associated with the bulk realm administration service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.personnel.batch.PersonnelBatchProfile

supportsAppointmentBatchAdmin, supportsOrganizationBatchAdmin, supportsPersonBatchAdmin, supportsPositionBatchAdmin, supportsRealmBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPersonBatchAdminSession

PersonBatchAdminSession getPersonBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk person administration service.

Returns:

a PersonBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsPersonBatchAdmin() is true.

getPersonBatchAdminSessionForRealm

PersonBatchAdminSession getPersonBatchAdminSessionForRealm(Id realmId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

realmId - the Id of the Realm

Returns:

a PersonBatchAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPersonBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPersonBatchAdmin() and supportsVisibleFederation() are true

getOrganizationBatchAdminSession

OrganizationBatchAdminSession getOrganizationBatchAdminSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk organization administration service.

Returns:

an OrganizationBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsOrganizationBatchAdmin() is true.

getOrganizationBatchAdminSessionForRealm

OrganizationBatchAdminSession getOrganizationBatchAdminSessionForRealm(Id realmId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

realmId - the Id of the Realm

Returns:

an OrganizationBatchAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrganizationBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrganizationBatchAdmin() and supportsVisibleFederation() are true

getPositionBatchAdminSession

PositionBatchAdminSession getPositionBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk position administration service.

Returns:

a PositionBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsPositionBatchAdmin() is true.

getPositionBatchAdminSessionForRealm

PositionBatchAdminSession getPositionBatchAdminSessionForRealm(Id realmId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

realmId - the Id of the Realm

Returns:

a PositionBatchAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPositionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPositionBatchAdmin() and supportsVisibleFederation() are true

getAppointmentBatchAdminSession

AppointmentBatchAdminSession getAppointmentBatchAdminSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk appointment administration service.

Returns:

an AppointmentBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsAppointmentBatchAdmin() is true.

getAppointmentBatchAdminSessionForRealm

AppointmentBatchAdminSession getAppointmentBatchAdminSessionForRealm(Id realmId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

realmId - the Id of the Realm

Returns:

an AppointmentBatchAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAppointmentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAppointmentBatchAdmin() and supportsVisibleFederation() are true

getRealmBatchAdminSession

RealmBatchAdminSession getRealmBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk realm administration service.

Returns:

a RealmBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsRealmBatchAdmin() is true.