com.sap.tc.mobile.cfs.meta.api
Interface RelationDescriptor

All Superinterfaces:

AbstractDescriptor, StorageTypeDescriptor

public interface RelationDescriptor
extends StorageTypeDescriptor

Relation descriptor. Relation describes a relation between two model classes. These classes don't have to be in the same model.

Author:

d039184

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.tc.mobile.cfs.meta.api.AbstractDescriptor

AbstractDescriptor.Visitor

Method Summary

java.lang.String	getAliasName() Get relation name.
AttributeDescriptor	getSourceBackingAttribute() Get attribute backing this relation in left/source role (for non-virtual relations), to navigate to the target.
Cardinality	getSourceCardinality() Get left side cardinality.
ClassDescriptor	getSourceRoleClass() Get role class of the left side of the relation.
java.lang.String	getSourceRoleName() Get role name of the left side of the relation.
AttributeDescriptor	getTargetBackingAttribute() Get attribute backing this relation in right/target role (for non-virtual relations), to navigate back to the source.
Cardinality	getTargetCardinality() Get right side cardinality.
ClassDescriptor	getTargetRoleClass() Get role class of the right side of the relation.
java.lang.String	getTargetRoleName() Get role name of the right side of the relation.
java.lang.String	getTechnicalName() Get technical name of the relation.
boolean	isAggregation() Get aggregation flag.
boolean	isBidirectional() Get bidirectionality flag.
boolean	isVirtual() Get virtual relation flag.

Methods inherited from interface com.sap.tc.mobile.cfs.meta.api.StorageTypeDescriptor

getStorageType

Methods inherited from interface com.sap.tc.mobile.cfs.meta.api.AbstractDescriptor

addUserDescriptor, clearAllUserDescriptors, getUserDescriptor, removeUserDescriptor, visit

Method Detail

getTechnicalName

java.lang.String getTechnicalName()

Get technical name of the relation.

Returns:

technical name of the relation.

getAliasName

java.lang.String getAliasName()

Get relation name.

Returns:

relation name.

getSourceRoleName

java.lang.String getSourceRoleName()

Get role name of the left side of the relation.

Returns:

role name of the left side of the relation.

getSourceRoleClass

ClassDescriptor getSourceRoleClass()

Get role class of the left side of the relation.

Returns:

role class of the left side of the relation.

getSourceCardinality

Cardinality getSourceCardinality()

Get left side cardinality.

Returns:

left side cardinality.

getTargetRoleName

java.lang.String getTargetRoleName()

Get role name of the right side of the relation.

Returns:

role name of the right side of the relation.

getTargetRoleClass

ClassDescriptor getTargetRoleClass()

Get role class of the right side of the relation.

Returns:

role class of the right side of the relation.

getTargetCardinality

Cardinality getTargetCardinality()

Get right side cardinality.

Returns:

right side cardinality.

isBidirectional

boolean isBidirectional()

Get bidirectionality flag.

Returns:

true, if the relation is bidirectional (navigable both ways), false if the relation is source to target only.

isAggregation

boolean isAggregation()

Get aggregation flag.

Returns:

true, iff source aggregates instance(s) of target.

getSourceBackingAttribute

AttributeDescriptor getSourceBackingAttribute()

Get attribute backing this relation in left/source role (for non-virtual relations), to navigate to the target.

• For aggregations with *:0..n and *:1..n, this attribute is unused. Instead, target backing attribute is used to build the relation.
• For aggregations with *:0..1 and *:1, this is the attribute that references aggregated object.
• For associations with 0..1:*, 1:* or 0..n:* on source side and *:1 or *:0..1 on target side this is the attribute in source pointing to the target.
• It is currently not possible to back associations with *:0..n or *:1..n on target side with an attribute.

Returns:

backing attribute in source class.

getTargetBackingAttribute

AttributeDescriptor getTargetBackingAttribute()

Get attribute backing this relation in right/target role (for non-virtual relations), to navigate back to the source.

• For aggregations with *:0..1, *:1, *:0..n and *:1..n, this attribute is pointing back to the source (parent).
• For associations with 0..1:* or 1:* on source side, this attribute is either empty (not navigable relation) or used to point back to source class (navigable relation).
• It is currently not possible to back associations with *:0..n or *:1..n on target side with an attribute.

Returns:

isVirtual

boolean isVirtual()

Get virtual relation flag.

Returns:

true, iff this is a virtual relation (not backed up by attributes in the data store, but by a query).