org.xbrlapi.networks

Interface EquivalentRelationships

All Known Implementing Classes:

EquivalentRelationshipsImpl

public interface EquivalentRelationships

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRelationship(Relationship relationship)
Relationship	getActiveRelationship()
int	size()

Method Detail

size

int size()

Returns:

the number of equivalent relationships in the set.

addRelationship

void addRelationship(Relationship relationship)
                     throws XBRLException

Parameters:

relationship - The relationship to add.

Throws:

XBRLException - if the relationship is not equivalent to the relationship with the highest priority in the collection.

getActiveRelationship

Relationship getActiveRelationship()
                                   throws XBRLException

Returns:

the active relationship in the collection of equivalent relationships. This is any one of the relationships that has the maximum priority out of the set of relationships in the collection. If there are no relationships in the collection, return null.

Throws:

XBRLException