OSID Logo
OSID Specifications
profile batch package
Version 3.1.0
Interfaceosid.profile.batch.ProfileBatchManager
Implementsosid.OsidManager
osid.profile.batch.ProfileBatchProfile
Used Byosid.profile.ProfileManager
Description

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
MethodgetProfileEntryBatchAdminSession
Description

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

Returnosid.profile.batch.ProfileEntryBatchAdminSession a ProfileEntryBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProfileEntryBatchAdmin() is false
Complianceoptional This method must be implemented if supportsProfileEntryBatchAdmin() is true.
MethodgetProfileEntryBatchAdminSessionForProfile
Description

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

Parametersosid.id.IdprofileId the Id of the Profile
Returnosid.profile.batch.ProfileEntryBatchAdminSession a ProfileEntryBatchAdminSession
ErrorsNOT_FOUND no Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProfileEntryBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProfileEntryBatchAdmin() and supportsVisibleFederation() are true
MethodgetProfileItemBatchAdminSession
Description

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

Returnosid.profile.batch.ProfileItemBatchAdminSession a ProfileItemBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProfileItemBatchAdmin() is false
Complianceoptional This method must be implemented if supportsProfileItemBatchAdmin() is true.
MethodgetProfileItemBatchAdminSessionForProfile
Description

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

Parametersosid.id.IdprofileId the Id of the Profile
Returnosid.profile.batch.ProfileItemBatchAdminSession a ProfileItemBatchAdminSession
ErrorsNOT_FOUND no Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProfileItemBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProfileItemBatchAdmin() and supportsVisibleFederation() are true
MethodgetProfileBatchAdminSession
Description

Gets the OsidSession associated with the bulk profile administration service.

Returnosid.profile.batch.ProfileBatchAdminSession a ProfileBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProfileBatchAdmin() is false
Complianceoptional This method must be implemented if supportsProfileBatchAdmin() is true.