com.ihr.xbrl.om.formula.aspects

## Class PeriodAspectRule

- java.lang.Object
- - com.ihr.xbrl.om.formula.aspects.CommonAspectRule
  - - com.ihr.xbrl.om.formula.aspects.PeriodAspectRule

- All Implemented Interfaces:
    PeriodAspectInterface

      public class PeriodAspectRule
      extends CommonAspectRule
      implements PeriodAspectInterface

  The Class PeriodAspectRule.
  Author:
    Ignacio

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static javax.xml.namespace.QName` | `duration` The Constant duration.
    `static javax.xml.namespace.QName` | `end` The Constant end.
    `static javax.xml.namespace.QName` | `forever` The Constant forever.
    `static javax.xml.namespace.QName` | `instant` The Constant instant.
    `static javax.xml.namespace.QName` | `resourceName` The Constant resourceName.
    `static javax.xml.namespace.QName` | `start` The Constant start.
    `static javax.xml.namespace.QName` | `value` The Constant value.

    - ### Fields inherited from class com.ihr.xbrl.om.formula.aspects.CommonAspectRule

      `ALLDIMENSIONALASPECTS, ALLNONDIMENSIONALASPECTS, ANY, COMPLETESCENARIO, COMPLETESEGMENT, CONCEPT, DIMENSION, ENTITYIDENTIFIER, LOCATION, NONE, NONXDTSCENARIO, NONXDTSEGMENT, PERIOD, UNIT, VALUE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `PeriodAspectRule(XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode)` Instantiates a new period aspect rule.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `XBRLPeriod` | `getPeriod(XPathHelper xph)` Gets the period.
    `XBRLItem.PeriodType` | `getPeriodType(XBRLItem item)` Returns a constant identifying either XBRLItem.DURATION or XBRLItem.INSTANT

    - ### Methods inherited from class com.ihr.xbrl.om.formula.aspects.CommonAspectRule

      `getAspectsText`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### resourceName

          public static final javax.xml.namespace.QName resourceName

      The Constant resourceName.

    - #### forever

          public static final javax.xml.namespace.QName forever

      The Constant forever.

    - #### instant

          public static final javax.xml.namespace.QName instant

      The Constant instant.

    - #### duration

          public static final javax.xml.namespace.QName duration

      The Constant duration.

    - #### value

          public static final javax.xml.namespace.QName value

      The Constant value.

    - #### start

          public static final javax.xml.namespace.QName start

      The Constant start.

    - #### end

          public static final javax.xml.namespace.QName end

      The Constant end.

  - ### Constructor Detail

    - #### PeriodAspectRule

          public PeriodAspectRule(XBRLFormula formula,
                          net.sf.saxon.s9api.XdmNode aspectNode)
                           throws XFValidationException

      Instantiates a new period aspect rule.
      Parameters:
        `formula` - the formula
        `aspectNode` - the aspect node
      Throws:
        `XFValidationException` - the XF validation exception

  - ### Method Detail

    - #### getPeriodType

          public XBRLItem.PeriodType getPeriodType(XBRLItem item)

      Description copied from interface: `PeriodAspectInterface`
      Returns a constant identifying either XBRLItem.DURATION or XBRLItem.INSTANT
      Specified by:
        `getPeriodType` in interface `PeriodAspectInterface`
      Parameters:
        `item` - the item
      Returns:
        the period type

    - #### getPeriod

          public XBRLPeriod getPeriod(XPathHelper xph)
                               throws XFValidationException

      Description copied from interface: `PeriodAspectInterface`
      Gets the period.
      Specified by:
        `getPeriod` in interface `PeriodAspectInterface`
      Parameters:
        `xph` - the xph
      Returns:
        the period
      Throws:
        `XFValidationException` - the XF validation exception