oracle.odi.domain.adapter.relational

Interface IKey

All Superinterfaces:

IModelObject, IModelObjectBase, IModelObjectWithLocation

All Known Implementing Classes:

OdiKey

public interface IKey
extends IModelObjectWithLocation

An interface which represents a key for a data storage object in an external model.

This interface will be implemented by objects that model a relational key.

Method Summary

Modifier and Type	Method and Description
java.util.List	getColumns() Obtains the columns that participate in this key.
java.lang.String	getName() Obtains the name of this key.
boolean	isAK() If the key is alternate unique key
boolean	isFlowCheckEnabled()
boolean	isIndex() If the key is index
boolean	isPK() If the key is primary key
boolean	isStaticCheckEnabled()

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Method Detail

getColumns

java.util.List getColumns()

Obtains the columns that participate in this key.

Returns:

a list of column. The returned list is typically unmodifiable.

Throws:

AdapterException

getName

java.lang.String getName()

Obtains the name of this key.

Specified by:

getName in interface IModelObject

Returns:

key's name

isAK

boolean isAK()

If the key is alternate unique key

Returns:

true if this key is alternate key, false otherwise

isPK

boolean isPK()

If the key is primary key

Returns:

true if this key is primary key, false otherwise

isIndex

boolean isIndex()

If the key is index

Returns:

true if this key is index, false otherwise

isFlowCheckEnabled

boolean isFlowCheckEnabled()

isStaticCheckEnabled

boolean isStaticCheckEnabled()