net.sf.farrago.cwm.keysindexes
Interface UniqueKeyRelationship

All Superinterfaces:

RefAssociation, RefBaseObject

All Known Implementing Classes:

UniqueKeyRelationship$Hib

public interface UniqueKeyRelationship
extends RefAssociation

UniqueKeyRelationship association proxy interface. The UniqueKeyRelationship association links a KeyRelationship with the UniqueKey with which it is paired. For example, in relational model terms, this association links a foreign key -- the KeyRelationship instance -- with the primary key -- the UniqueKey instance -- with which it is paired.

Note: This type should not be subclassed, implemented or directly instantiated by clients. It is generated from a MOF metamodel and implemented by Enki or MDR.

Method Summary

boolean	add(CwmKeyRelationship keyRelationship, CwmUniqueKey uniqueKey) Creates a link between the pair of instance objects in the associations link set.
boolean	exists(CwmKeyRelationship keyRelationship, CwmUniqueKey uniqueKey) Queries whether a link currently exists between a given pair of instance objects in the associations link set.
Collection<CwmKeyRelationship>	getKeyRelationship(CwmUniqueKey uniqueKey) Queries the instance objects that are related to a particular instance object by a link in the current associations link set.
CwmUniqueKey	getUniqueKey(CwmKeyRelationship keyRelationship) Queries the instance object that is related to a particular instance object by a link in the current associations link set.
boolean	remove(CwmKeyRelationship keyRelationship, CwmUniqueKey uniqueKey) Removes a link between a pair of instance objects in the current associations link set.

Methods inherited from interface javax.jmi.reflect.RefAssociation

refAddLink, refAllLinks, refLinkExists, refQuery, refQuery, refRemoveLink

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

exists

boolean exists(CwmKeyRelationship keyRelationship,
               CwmUniqueKey uniqueKey)

Queries whether a link currently exists between a given pair of instance objects in the associations link set.

Parameters:

keyRelationship - Value of the first association end.

uniqueKey - Value of the second association end.

Returns:

Returns true if the queried link exists.

getKeyRelationship

Collection<CwmKeyRelationship> getKeyRelationship(CwmUniqueKey uniqueKey)

Queries the instance objects that are related to a particular instance object by a link in the current associations link set.

Parameters:

uniqueKey - Required value of the second association end.

Returns:

Collection of related objects.

getUniqueKey

CwmUniqueKey getUniqueKey(CwmKeyRelationship keyRelationship)

Queries the instance object that is related to a particular instance object by a link in the current associations link set.

Parameters:

keyRelationship - Required value of the first association end.

Returns:

Related object or null if none exists.

add

boolean add(CwmKeyRelationship keyRelationship,
            CwmUniqueKey uniqueKey)

Creates a link between the pair of instance objects in the associations link set.

Parameters:

keyRelationship - Value of the first association end.

uniqueKey - Value of the second association end.

remove

boolean remove(CwmKeyRelationship keyRelationship,
               CwmUniqueKey uniqueKey)

Removes a link between a pair of instance objects in the current associations link set.

Parameters:

keyRelationship - Value of the first association end.

uniqueKey - Value of the second association end.