Interface Period

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface Period extends OsidObject

A Period represents a billing period.

  • Method Details

    • getDisplayLabel

      DisplayText getDisplayLabel()
      Gets a display label for this period which may be less formal than the display name.
      Returns:
      the period label
      Compliance:
      mandatory - This method must be implemented.

    • hasOpenDate

      boolean hasOpenDate()
      Tests if this period has an open date.
      Returns:
      true if there is an open date associated with this period, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getOpenDate

      DateTime getOpenDate()
      Gets the open date.
      Returns:
      the open date
      Throws:
      IllegalStateException - hasOpenDate() is false
      Compliance:
      mandatory - This method must be implemented.

    • hasCloseDate

      boolean hasCloseDate()
      Tests if this period has a close date.
      Returns:
      true if there is a close date associated with this period, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCloseDate

      DateTime getCloseDate()
      Gets the close date.
      Returns:
      the close date
      Throws:
      IllegalStateException - hasCloseDate() is false
      Compliance:
      mandatory - This method must be implemented.

    • hasBillingDate

      boolean hasBillingDate()
      Tests if this period has a billing date.
      Returns:
      true if there is a billing date associated with this period, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBillingDate

      DateTime getBillingDate()
      Gets the billing date.
      Returns:
      the billing date
      Throws:
      IllegalStateException - hasBillingDate() is false
      Compliance:
      mandatory - This method must be implemented.

    • hasDueDate

      boolean hasDueDate()
      Tests if this period has a due date.
      Returns:
      true if there is a due date associated with this period, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDueDate

      DateTime getDueDate()
      Gets the due date.
      Returns:
      the due date
      Throws:
      IllegalStateException - hasDueDate() is false
      Compliance:
      mandatory - This method must be implemented.

    • getPeriodRecord

      PeriodRecord getPeriodRecord(Type periodRecordType) throws OperationFailedException
      Gets the period record corresponding to the given Period record Type .This method is used to retrieve an object implementing the requested record. The periodRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(periodRecordType) is true .
      Parameters:
      periodRecordType - the type of period record to retrieve
      Returns:
      the period record
      Throws:
      NullArgumentException - periodRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(periodRecordType) is false
      Compliance:
      mandatory - This method must be implemented.