Interface PersonnelBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface PersonnelBatchProfile

supportsAppointmentBatchAdmin, supportsOrganizationBatchAdmin, supportsPersonBatchAdmin, supportsPositionBatchAdmin, supportsRealmBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAppointmentBatchAdmin()	Tests if bulk administration of appointments is available.
boolean	supportsOrganizationBatchAdmin()	Tests if bulk administration of organizations is available.
boolean	supportsPersonBatchAdmin()	Tests if bulk administration of persons is available.
boolean	supportsPositionBatchAdmin()	Tests if bulk administration of positions is available.
boolean	supportsRealmBatchAdmin()	Tests if bulk administration of realms is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsPersonBatchAdmin()} is {@code 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 {@code supportsPersonBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsOrganizationBatchAdmin()} is {@code 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 {@code supportsOrganizationBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPositionBatchAdmin()} is {@code 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 {@code supportsPositionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAppointmentBatchAdmin()} is {@code 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 {@code supportsAppointmentBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRealmBatchAdmin()} is {@code true} .