au.gov.tas.dpiwe.mr.relationship
Interface MrRelationshipCollection

All Known Implementing Classes:

RelationshipCollection, RelationshipList, RelationshipMap, RelationshipSet, RelationshipSortedSet

public interface MrRelationshipCollection

This is an extension to the Collection and Map interfaces for representing relationship collections in beans.

Since:

Mr Architecture 2.0

Version:

1.0.0.2

Author:

Kade Hansson

Method Summary

void	clear() Changes all related beans to unrelated beans.
Object	clone() Makes a deep copy of this relationship collection and all its associated metainformation.
Set	getRelatedKeys(Container container) Gets the keys of the beans in this collection.
Set	getUnrelatedBeans(Container container) Gets the unrelated beans which have been recently removed from this collection.
Set	resetRelatedKeys(Container container) Synchronizes the related keys with the current beans in this collection.
Set	resetUnrelatedBeans(Container container) Removes all references to unrelated beans.

Method Detail

getRelatedKeys

Set getRelatedKeys(Container container)

Gets the keys of the beans in this collection.

Parameters:

container - a container which knows the primary key getter method of the beans.

Returns:

the keys of the beans in this collection.

resetRelatedKeys

Set resetRelatedKeys(Container container)

Synchronizes the related keys with the current beans in this collection.

Parameters:

container - a container which knows the primary key getter method of the beans.

Returns:

the newly populated collection of related keys.

getUnrelatedBeans

Set getUnrelatedBeans(Container container)

Gets the unrelated beans which have been recently removed from this collection.

Returns:

the set of recently unrelated beans.

resetUnrelatedBeans

Set resetUnrelatedBeans(Container container)

Removes all references to unrelated beans.

Returns:

the new empty set of unrelated beans.

clear

void clear()

Changes all related beans to unrelated beans.

clone

Object clone()
             throws CloneNotSupportedException

Makes a deep copy of this relationship collection and all its associated metainformation.

Returns:

the clone of this relationship collection.

Throws:

CloneNotSupportedException