DetachedRelationshipDescription (GraphAware Common 4.2.0.58 API)

All Superinterfaces:

MutuallyExclusive<RelationshipDescription>, PartiallyComparable<RelationshipDescription>, RelationshipDescription

All Known Implementing Classes:

DetachedRelationshipDescriptionImpl
```
public interface DetachedRelationshipDescription
extends RelationshipDescription
```
A RelationshipDescription that must be detached from the database, i.e. store its own data internally rather than referring to an underlying Relationship. It is immutable; once instantiated, new instances with different PropertiesDescriptions can be constructed using the with(String, Predicate) method.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`DetachedRelationshipDescription`	`with(String propertyKey, Predicate predicate)`	Construct a new description from this description by adding/replacing a properties predicate with a new one.

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

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

Methods inherited from interface com.graphaware.common.description.relationship.RelationshipDescription
getDirection, getPropertiesDescription, getType

- Method Detail
  - with
```
DetachedRelationshipDescription with(String propertyKey,
                                     Predicate predicate)
```
    Construct a new description from this description by adding/replacing a properties predicate with a new one.
    
    Parameters:
    
    propertyKey - key of the property the predicate is for.
    
    predicate - the predicate.
    
    Returns:
    
    a new instance of relationship description.