public interface Customer extends OsidObject, Temporal
A Customer
represents data associated to a resource
representing a customer. Contact information for this object can be
managed in the Contact OSID.
Modifier and Type | Method and Description |
---|---|
Activity |
getActivity()
Gets the activity.
|
Id |
getActivityId()
Gets the activity
Id. |
java.lang.String |
getCustomerNumber()
Gets the customer account number.
|
CustomerRecord |
getCustomerRecord(Type customerRecordType)
Gets the customer record corresponding to the given
Customer
record Type. |
Resource |
getResource()
Gets the resource.
|
Id |
getResourceId()
Gets the resource
Id representing the customer. |
boolean |
hasActivity()
Tests if this customer is linked to a financial activity,
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getResourceId()
Id
representing the customer. Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.lang.String getCustomerNumber()
mandatory
- This method must be implemented. boolean hasActivity()
true
if this customer has an activity,
false
otherwisemandatory
- This method must be implemented. Id getActivityId()
Id.
Id
IllegalStateException
- hasActivity()
is
false
mandatory
- This method must be implemented. Activity getActivity() throws OperationFailedException
IllegalStateException
- hasActivity()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CustomerRecord getCustomerRecord(Type customerRecordType) throws OperationFailedException
Customer
record Type.
This method is used to retrieve an
object implementing the requested record. The
customerRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(customerRecordType)
is true
.customerRecordType
- the type of customer record to retrieveNullArgumentException
- customerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(customerRecordType)
is false
mandatory
- This method must be implemented.