org.osid.personnel.batch

Interface PersonnelBatchProxyManager

All Superinterfaces:

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

public interface PersonnelBatchProxyManager
extends OsidProxyManager, PersonnelBatchProfile

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

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk person administration service.

Parameters:

proxy - a proxy

Returns:

a PersonBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PersonBatchAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk organization administration service.

Parameters:

proxy - a proxy

Returns:

an OrganizationBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an OrganizationBatchAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk position administration service.

Parameters:

proxy - a proxy

Returns:

a PositionBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

a PositionBatchAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk appointment administration service.

Parameters:

proxy - a proxy

Returns:

an AppointmentBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

realmId - the Id of the Realm

proxy - a proxy

Returns:

an AppointmentBatchAdminSession

Throws:

NotFoundException - no Realm found by the given Id

NullArgumentException - realmId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk realm administration service.

Parameters:

proxy - a proxy

Returns:

a RealmBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRealmBatchAdmin() is false

Compliance:

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