OSID Logo
OSID Specifications
contact batch package
Version 3.1.0
Interfaceosid.contact.batch.AddressBookBatchForm
Implementsosid.contact.AddressBookForm
Used Byosid.contact.batch.AddressBookBatchFormList
Description

This is the form for creating and updating address books in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AddressBookBatchAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetAddressBookId
Description

Gets the Address Book Id of the address book to be updated if this is an update transaction.

Returnosid.id.Id the address book Id
ErrorsILLEGAL_STATE isForUpdate() is false
Compliancemandatory This method must be implemented.
MethodgetParentsMetadata
Description

Gets the metadata for setting the hierarchical parents of this address book.

Returnosid.Metadata metadata for the parents
Compliancemandatory This method must be implemented.
MethodsetParents
Description

Sets the hierarchical parents.

Parametersosid.id.Id[]parents the new parents
ErrorsINVALID_ARGUMENT parents is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT parents is null
Compliancemandatory This method must be implemented.
MethodclearParents
Description

Removes the hierarchical parents.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.