| Interface | osid.contact.batch.AddressBookBatchForm | ||
|---|---|---|---|
| Implements | osid.contact.AddressBookForm | ||
| Description |
This is the form for creating and updating address books in
bulk. | ||
| Method | getAddressBookId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the address book Id | |
| Errors | ILLEGAL_STATE | isForUpdate() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParentsMetadata | ||
| Description |
Gets the metadata for setting the hierarchical parents of this address book. | ||
| Return | osid.Metadata | metadata for the parents | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setParents | ||
| Description |
Sets the hierarchical parents. | ||
| Parameters | osid.id.Id[] | parents | the new parents |
| Errors | INVALID_ARGUMENT | parents is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | parents is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearParents | ||
| Description |
Removes the hierarchical parents. | ||
| Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
| Compliance | mandatory | This method must be implemented. | |