*** This interface provides Binary Compatibility only, not Source Compatibility ***

Package com.sas.services.information.metadata

Interface ForeignKeyInterface

All Superinterfaces:

MetadataInterface, PublicObjectInterface, Remote

@SASScope("ALL")
@BinaryCompatibilityOnly
public interface ForeignKeyInterface
extends MetadataInterface

Represents foreign key associated with the relational table

Field Summary

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

METADATA_STATE_DELETED, METADATA_STATE_DESTROYED, METADATA_STATE_NEW, METADATA_STATE_NORMAL, PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

Modifier and Type	Method	Description
void	addAssociation(KeyAssociationInterface associatoin)	Add a key association to the foreign key
List<KeyAssociationInterface>	getAssociations()	Get the column associations bind with this foreign key
DataTableInterface	getOwningTable()	Get a owning table of the foreign key
RelationalKeyInterface	getPartnerUniqueKey()	Get a partner unique key of the foreign key.
void	removeAssociation(KeyAssociationInterface association)	Remove a key association from the foreign key

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getCreatedBy, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGroups, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifiedBy, getModifyDate, getNoteTextStore, getNoteTextStores, getNoteTextStoresByRole, getObjectProperties, getParent, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getType, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isObjectAlive, isReadCompatible, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeNoteTextStore, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeResponsiblePartyByIdentity, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setName, setNoteTextStores, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface

addProcessorInterface, getContainer, getIdentifier, getName, getObjectURI, getPathUrl, getProcessorInterface, getTypeDescriptor

Method Details

getAssociations

List<KeyAssociationInterface> getAssociations()
                                       throws ServiceException,
RemoteException

Get the column associations bind with this foreign key

Returns:

Throws:

ServiceException - - If a repository error occurs.

RemoteException - - In the event of remote object failure.

addAssociation

void addAssociation(KeyAssociationInterface associatoin)
             throws ServiceException,
RemoteException

Add a key association to the foreign key

Parameters:

associatoin -

Throws:

ServiceException - - 1] If key association exist in the foreign key 2] If a repository error occurs.

RemoteException - - In the event of remote object failure.

removeAssociation

void removeAssociation(KeyAssociationInterface association)
                throws ServiceException,
RemoteException

Remove a key association from the foreign key

Parameters:

association -

Throws:

ServiceException - - 1] If key association to remove is the only key association in the foreign key 2] If a repository error occurs.

RemoteException - - In the event of remote object failure.

getOwningTable

DataTableInterface getOwningTable()
                           throws ServiceException,
RemoteException

Get a owning table of the foreign key

Returns:

Throws:

ServiceException - - If a repository error occurs.

RemoteException - - In the event of remote object failure.

getPartnerUniqueKey

RelationalKeyInterface getPartnerUniqueKey()
                                    throws ServiceException,
RemoteException

Get a partner unique key of the foreign key.

Returns:

Throws:

ServiceException - - If a repository error occurs.

RemoteException - - In the event of remote object failure.