Interface Customer

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Temporal
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.

  • Method Details

    • getResourceId

      Id getResourceId()
      Gets the resource Id representing the customer.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getResource

      Resource getResource() throws OperationFailedException
      Gets the resource.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerNumber

      String getCustomerNumber()
      Gets the customer account number.
      Returns:
      the customer number
      Compliance:
      mandatory - This method must be implemented.

    • hasActivity

      boolean hasActivity()
      Tests if this customer is linked to a financial activity,
      Returns:
      true if this customer has an activity, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getActivityId

      Id getActivityId()
      Gets the activity Id .
      Returns:
      the activity Id
      Throws:
      IllegalStateException - hasActivity() is false
      Compliance:
      mandatory - This method must be implemented.

    • getActivity

      Activity getActivity() throws OperationFailedException
      Gets the activity.
      Returns:
      the activity
      Throws:
      IllegalStateException - hasActivity() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerRecord

      CustomerRecord getCustomerRecord(Type customerRecordType) throws OperationFailedException
      Gets the customer record corresponding to the given 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 .
      Parameters:
      customerRecordType - the type of customer record to retrieve
      Returns:
      the customer record
      Throws:
      NullArgumentException - customerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(customerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.