RelationshipDescription (GraphAware Common 4.2.0.58 API)

All Superinterfaces:

MutuallyExclusive<RelationshipDescription>, PartiallyComparable<RelationshipDescription>

All Known Subinterfaces:

DetachedRelationshipDescription

All Known Implementing Classes:

BaseRelationshipDescription, DetachedRelationshipDescriptionImpl, LazyRelationshipDescription
```
public interface RelationshipDescription
extends PartiallyComparable<RelationshipDescription>, MutuallyExclusive<RelationshipDescription>
```
An immutable description of a relationship from a node's point of view. It is PartiallyComparable and can judge, whether it is MutuallyExclusive with another one.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Direction`	`getDirection()`	Get the relationship direction.
`PropertiesDescription`	`getPropertiesDescription()`	Get the relationship's properties description.
`String`	`getType()`	Get the relationship type.

Methods inherited from interface com.graphaware.common.description.MutuallyExclusive
isMutuallyExclusive

Methods inherited from interface com.graphaware.common.description.PartiallyComparable
isMoreGeneralThan, isMoreSpecificThan

- Method Detail
  - getType
```
String getType()
```
    Get the relationship type.
    
    Returns:
    
    type.
  - getDirection
```
Direction getDirection()
```
    Get the relationship direction.
    
    Returns:
    
    direction. Note that this can be Direction.BOTH.
  - getPropertiesDescription
```
PropertiesDescription getPropertiesDescription()
```
    Get the relationship's properties description.
    
    Returns:
    
    properties description.