org.osid.profile.batch

Interface ProfileBatchProxyManager

All Superinterfaces:

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

public interface ProfileBatchProxyManager
extends OsidProxyManager, ProfileBatchProfile

The profile batch proxy manager provides access to profile 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:

• 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(Proxy proxy) Gets the OsidSession associated with the bulk profile administration service.
ProfileEntryBatchAdminSession	getProfileEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk profile entry administration service.
ProfileEntryBatchAdminSession	getProfileEntryBatchAdminSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the bulk profile entry administration service for the given profile.
ProfileItemBatchAdminSession	getProfileItemBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk profile item administration service.
ProfileItemBatchAdminSession	getProfileItemBatchAdminSessionForProfile(Id profileId, Proxy proxy) Gets the OsidSession associated with the bulk profile item administration service for the given profile.

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

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

Parameters:

proxy - a proxy

Returns:

a ProfileEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

a ProfileEntryBatchAdminSession

Throws:

NotFoundException - no Profile found by the given Id

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

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

Parameters:

proxy - a proxy

Returns:

a ProfileItemBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

proxy - a proxy

Returns:

a ProfileItemBatchAdminSession

Throws:

NotFoundException - no Profile found by the given Id

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

Gets the OsidSession associated with the bulk profile administration service.

Parameters:

proxy - a proxy

Returns:

a ProfileBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProfileBatchAdmin() is false

Compliance:

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