public interface Period extends ContextComponent
Modifier and Type | Method and Description |
---|---|
boolean |
endHasTimezone() |
boolean |
endIsDateOnly() |
java.lang.String |
getEnd() |
javax.xml.datatype.XMLGregorianCalendar |
getEndCalendar() |
java.lang.String |
getInstant()
Get the instant.
|
javax.xml.datatype.XMLGregorianCalendar |
getInstantCalendar() |
java.lang.String |
getStart() |
javax.xml.datatype.XMLGregorianCalendar |
getStartCalendar() |
boolean |
instantHasTimezone() |
boolean |
instantIsDateOnly() |
boolean |
isFiniteDurationPeriod()
Returns true if the period is a duration.
|
boolean |
isForeverPeriod()
Returns true if the period is forever.
|
boolean |
isInstantPeriod()
Returns true if the period is an instant.
|
boolean |
startHasTimezone() |
boolean |
startIsDateOnly() |
getContext
appendElementSchemeXPointer, appendID, getAllChildren, getAllChildrenIndices, getAncestorOrSelf, getChild, getChildren, getChildren, getChildrenIndices, getDataRootElement, getElementSchemeXPointerExpression, getIDXPointerExpression, getLabels, getLabels, getLabels, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, getLanguage, getLanguage, getLanguageName, getLanguageName, getLocalname, getLocalnameFromQName, getNamespace, getNamespaceFromQName, getParent, getParentElement, getParentIndex, getPrefixFromQName, getReferences, getReferencesWithLanguage, getReferencesWithLanguageAndResourceRoleAndLinkRole, getReferencesWithLanguageAndRole, getReferencesWithResourceRole, getReferencingLocators, getSequenceToParentElement, getSequenceToParentElementAsString, getSimpleLinks, getURI, getXPath, getXPointerExpression, isAncestorOf, isChild, isNewFragment, isRoot, setParentIndex, setSequenceToParentElement, setURI
appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore
boolean isFiniteDurationPeriod() throws XBRLException
XBRLException
boolean isInstantPeriod() throws XBRLException
XBRLException
boolean isForeverPeriod() throws XBRLException
XBRLException
java.lang.String getInstant() throws XBRLException
XBRLException
- if the period is not an instant.javax.xml.datatype.XMLGregorianCalendar getInstantCalendar() throws XBRLException
XBRLException
- if the period is not a finite duration.Calendar
java.lang.String getStart() throws XBRLException
XBRLException
- if the period is not a finite duration.javax.xml.datatype.XMLGregorianCalendar getStartCalendar() throws XBRLException
XBRLException
- if the period is not a finite duration.Calendar
javax.xml.datatype.XMLGregorianCalendar getEndCalendar() throws XBRLException
XBRLException
- if the period is not a finite duration.Calendar
java.lang.String getEnd() throws XBRLException
XBRLException
- if the period is not a finite duration.boolean endIsDateOnly() throws XBRLException
XBRLException
- if the period is not a finite duration.boolean startIsDateOnly() throws XBRLException
XBRLException
- if the period is not a finite duration.boolean instantIsDateOnly() throws XBRLException
XBRLException
- if the period is not an instant.boolean endHasTimezone() throws XBRLException
XBRLException
- if the period is not a finite duration.boolean startHasTimezone() throws XBRLException
XBRLException
- if the period is not a finite duration.boolean instantHasTimezone() throws XBRLException
XBRLException
- if the period is not an instant.