org.xbrlapi
Interface Period

All Superinterfaces:

Comparable<XML>, ContextComponent, Fragment, Serializable, XML

All Known Implementing Classes:

PeriodImpl

public interface Period
extends ContextComponent

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

boolean	endHasTimezone()
boolean	endIsDateOnly()
String	getEnd()
XMLGregorianCalendar	getEndCalendar()
String	getInstant() Get the instant.
XMLGregorianCalendar	getInstantCalendar()
String	getStart()
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()

Methods inherited from interface org.xbrlapi.ContextComponent

getContext

Methods inherited from interface org.xbrlapi.Fragment

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

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isFiniteDurationPeriod

boolean isFiniteDurationPeriod()
                               throws XBRLException

Returns true if the period is a duration.

Throws:

XBRLException

isInstantPeriod

boolean isInstantPeriod()
                        throws XBRLException

Returns true if the period is an instant.

Throws:

XBRLException

isForeverPeriod

boolean isForeverPeriod()
                        throws XBRLException

Returns true if the period is forever.

Throws:

XBRLException

getInstant

String getInstant()
                  throws XBRLException

Get the instant.

Returns:

the string value of the instant.

Throws:

XBRLException - if the period is not an instant.

getInstantCalendar

XMLGregorianCalendar getInstantCalendar()
                                        throws XBRLException

Returns:

the instant moment as a java.util.Calendar value. Note that the value is adjusted if necessary to reflect the AM/PM specifics of instant dates in the XBRL 2.1 specification.

Throws:

XBRLException - if the period is not a finite duration.

See Also:

Calendar

getStart

String getStart()
                throws XBRLException

Returns:

the start of the period.

Throws:

XBRLException - if the period is not a finite duration.

getStartCalendar

XMLGregorianCalendar getStartCalendar()
                                      throws XBRLException

Returns:

the start moment as a java.util.Calendar value.

Throws:

XBRLException - if the period is not a finite duration.

See Also:

Calendar

getEndCalendar

XMLGregorianCalendar getEndCalendar()
                                    throws XBRLException

Returns:

the end moment as a java.util.Calendar value. Note that the value is adjusted if necessary to reflect the AM/PM specifics of end dates in the XBRL 2.1 specification.

Throws:

XBRLException - if the period is not a finite duration.

See Also:

Calendar

getEnd

String getEnd()
              throws XBRLException

Returns:

the end of the period.

Throws:

XBRLException - if the period is not a finite duration.

endIsDateOnly

boolean endIsDateOnly()
                      throws XBRLException

Returns:

true if the end of a finite duration is specified as a date only, with no time (or timezone information) and false otherwise.

Throws:

XBRLException - if the period is not a finite duration.

startIsDateOnly

boolean startIsDateOnly()
                        throws XBRLException

Returns:

true if the start of a finite duration is specified as a date only, with no time (or timezone information) and false otherwise.

Throws:

XBRLException - if the period is not a finite duration.

instantIsDateOnly

boolean instantIsDateOnly()
                          throws XBRLException

Returns:

true if an instant is specified as a date only, with no time (or timezone information) and false otherwise.

Throws:

XBRLException - if the period is not an instant.

endHasTimezone

boolean endHasTimezone()
                       throws XBRLException

Returns:

true if the end of a finite duration specifies the timezone and false otherwise.

Throws:

XBRLException - if the period is not a finite duration.

startHasTimezone

boolean startHasTimezone()
                         throws XBRLException

Returns:

true if the start of a finite duration specifies the timezone and false otherwise.

Throws:

XBRLException - if the period is not a finite duration.

instantHasTimezone

boolean instantHasTimezone()
                           throws XBRLException

Returns:

true if an instant specifies the timezone and false otherwise.

Throws:

XBRLException - if the period is not an instant.