org.osid.billing

Interface CustomerForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

CustomerBatchForm

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getCustomerNumberMetadata

Metadata getCustomerNumberMetadata()

Gets the metadata for the customer number.

Returns:

metadata for the customer number

Compliance:

mandatory - This method must be implemented.

setCustomerNumber

void setCustomerNumber(java.lang.String number)

Sets the customer number.

Parameters:

number - the new number

Throws:

InvalidArgumentException - number is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - number is null

Compliance:

mandatory - This method must be implemented.

clearCustomerNumber

void clearCustomerNumber()

Clears the customer number.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getActivityMetadata

Metadata getActivityMetadata()

Gets the metadata for an activity.

Returns:

metadata for the activity

Compliance:

mandatory - This method must be implemented.

setActivity

void setActivity(Id activityId)

Sets the activity.

Parameters:

activityId - the new activity

Throws:

InvalidArgumentException - activityId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivity

void clearActivity()

Removes the activity.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCustomerFormRecord

CustomerFormRecord getCustomerFormRecord(Type customerRecordType)
                                         throws OperationFailedException

Gets the CustomerFormRecord corresponding to the given customer record Type.

Parameters:

customerRecordType - a customer record type

Returns:

the customer form record

Throws:

NullArgumentException - customerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(customerRecordType) is false

Compliance:

mandatory - This method must be implemented.