net.sf.farrago.cwm.relational
Interface CwmForeignKey

All Superinterfaces:

CwmElement, CwmKeyRelationship, CwmModelElement, RefBaseObject, RefFeatured, RefObject

All Known Implementing Classes:

CwmForeignKey$Hib

public interface CwmForeignKey
extends CwmKeyRelationship

ForeignKey object instance interface. A Foreign Key associates columns from one table with columns of another table.

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

DeferrabilityType	getDeferrability() Returns the value of attribute deferrability.
ReferentialRuleType	getDeleteRule() Returns the value of attribute deleteRule.
ReferentialRuleType	getUpdateRule() Returns the value of attribute updateRule.
void	setDeferrability(DeferrabilityType newValue) Sets the value of deferrability attribute.
void	setDeleteRule(ReferentialRuleType newValue) Sets the value of deleteRule attribute.
void	setUpdateRule(ReferentialRuleType newValue) Sets the value of updateRule attribute.

Methods inherited from interface net.sf.farrago.cwm.keysindexes.CwmKeyRelationship

getFeature, getUniqueKey, setUniqueKey

Methods inherited from interface net.sf.farrago.cwm.core.CwmModelElement

getClientDependency, getConstraint, getImporter, getName, getNamespace, getVisibility, setName, setNamespace, setVisibility

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

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

Method Detail

getDeleteRule

ReferentialRuleType getDeleteRule()

Returns the value of attribute deleteRule. An enumerated type. Indicates the disposition of the data records containing the foreign key value when the record of the matching primary key is deleted.

Returns:

Value of attribute deleteRule.

setDeleteRule

void setDeleteRule(ReferentialRuleType newValue)

Sets the value of deleteRule attribute. See getDeleteRule() for description on the attribute.

Parameters:

newValue - New value to be set.

getUpdateRule

ReferentialRuleType getUpdateRule()

Returns the value of attribute updateRule. Same as deleteRule for updates of the primary key data record

Returns:

Value of attribute updateRule.

setUpdateRule

void setUpdateRule(ReferentialRuleType newValue)

Sets the value of updateRule attribute. See getUpdateRule() for description on the attribute.

Parameters:

newValue - New value to be set.

getDeferrability

DeferrabilityType getDeferrability()

Returns the value of attribute deferrability. Indicates if the validity of the ForeignKey is to be tested at each statement or at the end of a transaction.

Returns:

Value of attribute deferrability.

setDeferrability

void setDeferrability(DeferrabilityType newValue)

Sets the value of deferrability attribute. See getDeferrability() for description on the attribute.

Parameters:

newValue - New value to be set.