org.osid.profile.batch

Interface ProfileBatchManager

All Superinterfaces:

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

public interface ProfileBatchManager
extends OsidManager, ProfileBatchProfile

The profile batch manager provides access to profile batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ProfileEntryBatchSession: a session to create, modify and delete profile entries in bulk
• ProfileItemBatchAdminSession: a session to create, modify and delete profile items in bulk
• ProfileBatchAdminSession: a session to create, modify and delete profiles in bulk

Method Summary

Methods

Modifier and Type	Method and Description
ProfileBatchAdminSession	getProfileBatchAdminSession() Gets the OsidSession associated with the bulk profile administration service.
ProfileEntryBatchAdminSession	getProfileEntryBatchAdminSession() Gets the OsidSession associated with the bulk profile entry administration service.
ProfileEntryBatchAdminSession	getProfileEntryBatchAdminSessionForProfile(Id profileId) Gets the OsidSession associated with the bulk profile entry administration service for the given profile.
ProfileItemBatchAdminSession	getProfileItemBatchAdminSession() Gets the OsidSession associated with the bulk profile item administration service.
ProfileItemBatchAdminSession	getProfileItemBatchAdminSessionForProfile(Id profileId) Gets the OsidSession associated with the bulk profile item administration service for the given profile.

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.profile.batch.ProfileBatchProfile

supportsProfileBatchAdmin, supportsProfileEntryBatchAdmin, supportsProfileItemBatchAdmin, 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

getProfileEntryBatchAdminSession

ProfileEntryBatchAdminSession getProfileEntryBatchAdminSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk profile entry administration service.

Returns:

a ProfileEntryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryBatchAdmin() is false

Compliance:

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

getProfileEntryBatchAdminSessionForProfile

ProfileEntryBatchAdminSession getProfileEntryBatchAdminSessionForProfile(Id profileId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the bulk profile entry administration service for the given profile.

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileEntryBatchAdminSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProfileItemBatchAdminSession

ProfileItemBatchAdminSession getProfileItemBatchAdminSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk profile item administration service.

Returns:

a ProfileItemBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemBatchAdmin() is false

Compliance:

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

getProfileItemBatchAdminSessionForProfile

ProfileItemBatchAdminSession getProfileItemBatchAdminSessionForProfile(Id profileId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the bulk profile item administration service for the given profile.

Parameters:

profileId - the Id of the Profile

Returns:

a ProfileItemBatchAdminSession

Throws:

NotFoundException - no Profile found by the given Id

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProfileBatchAdminSession

ProfileBatchAdminSession getProfileBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk profile administration service.

Returns:

a ProfileBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileBatchAdmin() is false

Compliance:

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