public interface CustomerForm extends OsidObjectForm, OsidTemporalForm
This is the form for creating and updating Customers.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
CustomerAdminSession.
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 |
clearActivity()
Removes the activity.
|
void |
clearCustomerNumber()
Clears the customer number.
|
Metadata |
getActivityMetadata()
Gets the metadata for an activity.
|
CustomerFormRecord |
getCustomerFormRecord(Type customerRecordType)
Gets the
CustomerFormRecord corresponding to the given
customer record Type. |
Metadata |
getCustomerNumberMetadata()
Gets the metadata for the customer number.
|
void |
setActivity(Id activityId)
Sets the activity.
|
void |
setCustomerNumber(java.lang.String number)
Sets the customer number.
|
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 getCustomerNumberMetadata()
mandatory
- This method must be implemented. void setCustomerNumber(java.lang.String number)
number
- the new numberInvalidArgumentException
- number
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- number
is
null
mandatory
- This method must be implemented. void clearCustomerNumber()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getActivityMetadata()
mandatory
- This method must be implemented. void setActivity(Id activityId)
activityId
- the new activityInvalidArgumentException
- activityId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- activityId
is
null
mandatory
- This method must be implemented. void clearActivity()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CustomerFormRecord getCustomerFormRecord(Type customerRecordType) throws OperationFailedException
CustomerFormRecord
corresponding to the given
customer record Type.
customerRecordType
- a customer record typeNullArgumentException
- customerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(customerRecordType)
is false
mandatory
- This method must be implemented.