public interface AddressBookBatchForm extends AddressBookForm
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.
Modifier and Type | Method and Description |
---|---|
void |
clearParents()
Removes the hierarchical parents.
|
Id |
getAddressBookId()
Gets the
Address Book Id of the address book to be
updated if this is an update transaction. |
Metadata |
getParentsMetadata()
Gets the metadata for setting the hierarchical parents of this address
book.
|
void |
setParents(Id[] parents)
Sets the hierarchical parents.
|
getAddressBookFormRecord
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
Id getAddressBookId()
Address Book Id
of the address book to be
updated if this is an update transaction. Id
IllegalStateException
- isForUpdate()
is
false
mandatory
- This method must be implemented. Metadata getParentsMetadata()
mandatory
- This method must be implemented. void setParents(Id[] parents)
parents
- the new parentsInvalidArgumentException
- parents
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- parents
is
null
mandatory
- This method must be implemented. void clearParents()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented.