Interface | osid.relationship.batch.FamilyBatchAdminSession | ||
---|---|---|---|
Implements | osid.relationship.FamilyAdminSession | ||
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 | getFamilyFormsForCreate | ||
Description |
Gets the family forms for creating a bunch of new family. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | familyRecordTypes | array of family record types to be included in each create operation or an empty list if none | |
Return | osid.relationship.batch.FamilyBatchFormList | the family forms | |
Errors | NULL_ARGUMENT | familyRecordTypes 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 | createFamilies | ||
Description |
Creates a new set of | ||
Parameters | osid.relationship.batch.FamilyBatchFormList | familyForms | the family forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | familyForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFamilyFormsForUpdate | ||
Description |
Gets the family forms for updating an existing set of families. A new family form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | familyIds | the Ids of the Families |
Return | osid.relationship.batch.FamilyBatchFormList | the family form | |
Errors | NOT_FOUND | a familyId is not found | |
NULL_ARGUMENT | familyIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateFamilies | ||
Description |
Updates existing families. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.relationship.batch.FamilyBatchFormList | familyForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | familyForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllFamilies | ||
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 | deleteFamilies | ||
Description |
Deletes families for the given | ||
Parameters | osid.id.IdList | familyIds | the Ids of the families to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | familyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasFamilies | ||
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. |