public interface Period extends OsidObject
A Period
represents a billing period.
Modifier and Type | Method and Description |
---|---|
DateTime |
getBillingDate()
Gets the billing date.
|
DateTime |
getCloseDate()
Gets the close date.
|
DisplayText |
getDisplayLabel()
Gets a display label for this period which may be less formal than the
display name.
|
DateTime |
getDueDate()
Gets the due date.
|
DateTime |
getOpenDate()
Gets the open date.
|
PeriodRecord |
getPeriodRecord(Type periodRecordType)
Gets the period record corresponding to the given
Period
record Type. |
boolean |
hasBillingDate()
Tests if this period has a billing date.
|
boolean |
hasCloseDate()
Tests if this period has a close date.
|
boolean |
hasDueDate()
Tests if this period has a due date.
|
boolean |
hasOpenDate()
Tests if this period has an open date.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DisplayText getDisplayLabel()
mandatory
- This method must be implemented. boolean hasOpenDate()
true
if there is an open date associated with
this period, false
otherwisemandatory
- This method must be implemented. DateTime getOpenDate()
IllegalStateException
- hasOpenDate()
is
false
mandatory
- This method must be implemented. boolean hasCloseDate()
true
if there is a close date associated with
this period, false
otherwisemandatory
- This method must be implemented. DateTime getCloseDate()
IllegalStateException
- hasCloseDate()
is false
mandatory
- This method must be implemented. boolean hasBillingDate()
true
if there is a billing date associated with
this period, false
otherwisemandatory
- This method must be implemented. DateTime getBillingDate()
IllegalStateException
- hasBillingDate()
is false
mandatory
- This method must be implemented. boolean hasDueDate()
true
if there is a due date associated with
this period, false
otherwisemandatory
- This method must be implemented. DateTime getDueDate()
IllegalStateException
- hasDueDate()
is
false
mandatory
- This method must be implemented. PeriodRecord getPeriodRecord(Type periodRecordType) throws OperationFailedException
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
.periodRecordType
- the type of period record to retrieveNullArgumentException
- periodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(periodRecordType)
is false
mandatory
- This method must be implemented.