Interface ProfileBatchManager

All Superinterfaces:

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

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

supportsProfileBatchAdmin, supportsProfileEntryBatchAdmin, supportsProfileItemBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsProfileBatchAdmin()	Tests if bulk administration of profiles is available.
boolean	supportsProfileEntryBatchAdmin()	Tests if bulk administration of profile entries is available.
boolean	supportsProfileItemBatchAdmin()	Tests if bulk administration of profile items 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

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 {@code supportsProfileEntryBatchAdmin()} is {@code 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 {@code supportsProfileEntryBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProfileItemBatchAdmin()} is {@code 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 {@code supportsProfileItemBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProfileBatchAdmin()} is {@code true} .