com.ihr.xbrl.om.table.definition

Interface PeriodAspectInterface

All Superinterfaces:

Aspect<XBRLPeriod>

All Known Implementing Classes:

PeriodAspectRule

public interface PeriodAspectInterface
extends Aspect<XBRLPeriod>

This is the interface for all Period Aspect Resolver classes. During static checking of the formula, an instance of a class implementing this interface must be associated with the formula period aspect resolver.

Author:

Ignacio

Method Summary

Methods

Modifier and Type	Method and Description
XBRLPeriod	getPeriod(XBRLStructuralTable xbrlTable) Gets the period.
XBRLItem.PeriodType	getPeriodType(XBRLItem item) Returns a constant identifying either XBRLItem.DURATION or XBRLItem.INSTANT
void	resetNode() Reset node.

Methods inherited from interface com.ihr.xbrl.om.table.structural.Aspect

getAspectClashIdentity, getAspectType, getMember

Method Detail

getPeriodType

XBRLItem.PeriodType getPeriodType(XBRLItem item)

Returns a constant identifying either XBRLItem.DURATION or XBRLItem.INSTANT

Parameters:

item - the item

Returns:

the period type

getPeriod

XBRLPeriod getPeriod(XBRLStructuralTable xbrlTable)
                     throws XFValidationException

Gets the period.

Parameters:

xbrlTable - the xbrl table

Returns:

the period

Throws:

XFValidationException - the XF validation exception

resetNode

void resetNode()

Reset node.