public interface SubscriptionBatchForm extends SubscriptionForm
This is the form for creating and updating subscriptions in bulk.
Like all OsidForm
objects, various data
elements may be set here for use in the create and update methods in the
PublisherBatchAdminSession.
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 |
---|---|
Id |
getDispatchId()
Gets the
Dispatch of the subscription if this is a
create transaction. |
Id |
getSubscriberId()
Gets the
Id of the subscriber resource if this is a
create transaction. |
Id |
getSubscriptionId()
Gets the
Id of the subscription to be updated if this
is an update transaction. |
clearAddress, getAddressMetadata, getSubscriptionFormRecord, setAddress
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Id getDispatchId()
Dispatch
of the subscription if this is a
create transaction. Id
IllegalStateException
- isForUpdate()
is
true
mandatory
- This method must be implemented. Id getSubscriberId()
Id
of the subscriber resource if this is a
create transaction. Id
IllegalStateException
- isForUpdate()
is
true
mandatory
- This method must be implemented. Id getSubscriptionId()
Id
of the subscription to be updated if this
is an update transaction. Id
IllegalStateException
- isForUpdate()
is
false
mandatory
- This method must be implemented.