OSID Logo
OSID Specifications
profile batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.batch.ProfileBatchManager
Implementsosid.OsidManager
osid.profile.batch.ProfileBatchProfile
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.ProfileEntryBatchAdminSessiona ProfileEntryBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryBatchAdmin() is false
ComplianceoptionalThis 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.IdprofileIdthe Id of the Profile
Returnosid.profile.batch.ProfileEntryBatchAdminSessiona ProfileEntryBatchAdminSession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileEntryBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ProfileItemBatchAdminSessiona ProfileItemBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileItemBatchAdmin() is false
ComplianceoptionalThis 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.IdprofileIdthe Id of the Profile
Returnosid.profile.batch.ProfileItemBatchAdminSessiona ProfileItemBatchAdminSession
ErrorsNOT_FOUNDno Profile found by the given Id
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileItemBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ProfileBatchAdminSessiona ProfileBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProfileBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProfileBatchAdmin() is true.