public interface SubscriptionForm extends OsidRelationshipForm
This is the form for creating and updating Subscription
objects. Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
SubscriptionAdminSession.
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 |
clearAddress()
Clears the address.
|
Metadata |
getAddressMetadata()
Gets the metadata for an address.
|
SubscriptionFormRecord |
getSubscriptionFormRecord(Type subscriptionRecordType)
Gets the
SubscriptionFormRecord corresponding to the
given subscription record Type. |
void |
setAddress(Id addressId)
Sets the address.
|
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
Metadata getAddressMetadata()
mandatory
- This method must be implemented. void setAddress(Id addressId)
addressId
- the new addressInvalidArgumentException
- addressId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- addressId
is
null
mandatory
- This method must be implemented. void clearAddress()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. SubscriptionFormRecord getSubscriptionFormRecord(Type subscriptionRecordType) throws OperationFailedException
SubscriptionFormRecord
corresponding to the
given subscription record Type.
subscriptionRecordType
- the subscription record typeNullArgumentException
- subscriptionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(subscriptionRecordType)
is false
mandatory
- This method must be implemented.