Interface | osid.profile.batch.ProfileBatchManager | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getProfileEntryBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.profile.batch.ProfileEntryBatchAdminSession | a ProfileEntryBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProfileEntryBatchAdmin()
is true. | |
Method | getProfileEntryBatchAdminSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.batch.ProfileEntryBatchAdminSession | a ProfileEntryBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsProfileEntryBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getProfileItemBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.profile.batch.ProfileItemBatchAdminSession | a ProfileItemBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileItemBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProfileItemBatchAdmin()
is true. | |
Method | getProfileItemBatchAdminSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.batch.ProfileItemBatchAdminSession | a ProfileItemBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsProfileItemBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getProfileBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.profile.batch.ProfileBatchAdminSession | a ProfileBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProfileBatchAdmin()
is true. |