Interface | osid.personnel.batch.RealmBatchAdminSession | ||
---|---|---|---|
Implements | osid.personnel.RealmAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getRealmFormsForCreate | ||
Description |
Gets the realm forms for creating a bunch of new realms. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | realmRecordTypes | array of realm record types to be included in each create operation or an empty list if none | |
Return | osid.personnel.batch.RealmBatchFormList | the realm forms | |
Errors | NULL_ARGUMENT | realmRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRealms | ||
Description |
Creates a new set of | ||
Parameters | osid.personnel.batch.RealmBatchFormList | realmForms | the realm forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | realmForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRealmFormsForUpdate | ||
Description |
Gets the realm forms for updating an existing set of realms. A new realm form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | realmIds | the Ids of the Realm |
Return | osid.personnel.batch.RealmBatchFormList | the realm form | |
Errors | NOT_FOUND | a realmId is not found | |
NULL_ARGUMENT | realmIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRealms | ||
Description |
Updates existing realms. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.personnel.batch.RealmBatchFormList | realmForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | realmForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllRealms | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRealms | ||
Description |
Deletes realms for the given | ||
Parameters | osid.id.IdList | realmIds | the Ids of the realms to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | realmIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasRealms | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |