com.semarchy.mdm.runtime.model.logical
Interface IReference

All Superinterfaces:
IUniquelyNamed, Serializable

public interface IReference
extends IUniquelyNamed, Serializable

Defines a reference many-to-one relationship between two entities as specified by the Entity-Relationship Modeling standards

The referencing entity is called the "From" entity

The referenced entity is called the "To" entity

Author:
skamel

Field Summary
static String REFERENCE_PREFIX
           
 
Fields inherited from interface com.semarchy.mdm.runtime.model.logical.IUniquelyNamed
SEP
 
Method Summary
 IForeignAttribute getForeignAttribute()
           
 IEntity getFromEntity()
           
 String getFromRoleName()
           
 IModel getModel()
          Deprecated.  
 String getName()
           
 String getPhysicalName()
           
 IEntity getToEntity()
           
 String getToRoleName()
           
 ValidationScope getValidationScope()
           
 boolean isFromNavigable()
          Indicates whether this participant association end is navigable from the one side to the many side.
 boolean isMandatory()
           
 boolean isToNavigable()
          Indicates whether this participant association end is navigable from the many side to the one side.
 
Methods inherited from interface com.semarchy.mdm.runtime.model.logical.IUniquelyNamed
getPrefixedUniqueName, getUniqueName
 

Field Detail

REFERENCE_PREFIX

static final String REFERENCE_PREFIX
See Also:
Constant Field Values
Method Detail

getModel

IModel getModel()
Deprecated. 

Returns:

getName

String getName()
Returns:
the name of this reference

getFromEntity

IEntity getFromEntity()
Returns:
the referencing entity. Cannot be null

getFromRoleName

String getFromRoleName()
Returns:
the name of the role when using the referencing entity in the referenced entity's context

getToEntity

IEntity getToEntity()
Returns:
the referenced entity. Cannot be null

getToRoleName

String getToRoleName()
Returns:
the name of the role when using the referenced entity in the referencing entity's context

isMandatory

boolean isMandatory()
Returns:
whether the cardinality of this reference is *->1-1 rather than *->(0..1)

getForeignAttribute

IForeignAttribute getForeignAttribute()
Returns:
the foreign attribute managed by this reference

getValidationScope

ValidationScope getValidationScope()

getPhysicalName

String getPhysicalName()
Returns:
the unique physical name of this reference within the model. may be used for dynamically creating indexes.

isToNavigable

boolean isToNavigable()

Indicates whether this participant association end is navigable from the many side to the one side. By default, it is.

Returns:
value of this property

isFromNavigable

boolean isFromNavigable()

Indicates whether this participant association end is navigable from the one side to the many side. By default, it is.

Returns:
value of this property


Copyright © 2015. All Rights Reserved.