java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship

All Implemented Interfaces:

Serializable, OmasObject

Direct Known Subclasses:

Antonym, Categorization, CategoryAnchor, CategoryHierarchyLink, HasA, IsA, IsATypeOf, IsATypeOfDeprecated, Leadership, LibraryCategoryReference, LibraryTermReference, MediaReference, PreferredTerm, ProjectScope, RelatedTerm, ReplacementTerm, SemanticAssignment, Synonym, TermAnchor, Translation, TypedBy, UsedInContext, ValidValue
```
public abstract class Relationship
extends Object
implements Serializable, OmasObject
```
A relationship between 2 subject area OMAS Nodes. It is contains named attributes and has 2 relationship ends.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected RelationshipEnd`	`end1`
`protected RelationshipEnd`	`end2`
`protected String`	`name`
`protected RelationshipType`	`relationshipType`
`protected static long`	`serialVersionUID`

Constructor Summary

Constructors
Modifier Constructor Description

protected Relationship(String name, RelationshipEnd end1, RelationshipEnd end2)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`getAdditionalProperties()`	Get the extra attributes - ones that are in addition to the standard types.
`Long`	`getEffectiveFromTime()`	Return the date/time that this relationship should start to be used (null means it can be used from creationTime).
`Long`	`getEffectiveToTime()`	Return the date/time that this relationship should no longer be used.
`RelationshipEnd`	`getEnd1()`	Get relationship end 1.
`RelationshipEnd`	`getEnd2()`	Get relationship end 1.
`String`	`getGuid()`
`String`	`getName()`
`RelationshipType`	`getRelationshipType()`
`SystemAttributes`	`getSystemAttributes()`
`protected void`	`initialise()`
`boolean`	`isReadOnly()`	The relationship is readOnly
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)`
`void`	`setEffectiveFromTime(Long effectiveFromTime)`
`void`	`setEffectiveToTime(Long effectiveToTime)`
`void`	`setEnd1(RelationshipEnd end1)`
`void`	`setEnd2(RelationshipEnd end2)`
`void`	`setGuid(String guid)`
`void`	`setReadOnly(boolean readOnly)`	set whether the relationship is readOnly
`void`	`setRelationshipType(RelationshipType relationshipType)`
`void`	`setSystemAttributes(SystemAttributes systemAttributes)`
`String`	`toString()`
`StringBuilder`	`toString(StringBuilder sb)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID
```
protected static final long serialVersionUID
```
See Also:

Constant Field Values

relationshipType

protected RelationshipType relationshipType

name
```
protected String name
```

end1
```
protected RelationshipEnd end1
```

end2
```
protected RelationshipEnd end2
```

Constructor Detail

Relationship

protected Relationship(String name,
                       RelationshipEnd end1,
                       RelationshipEnd end2)

Method Detail
- initialise
```
protected void initialise()
```
- getRelationshipType
```
public RelationshipType getRelationshipType()
```
- setRelationshipType
```
public void setRelationshipType(RelationshipType relationshipType)
```
- getSystemAttributes
```
public SystemAttributes getSystemAttributes()
```
- setSystemAttributes
```
public void setSystemAttributes(SystemAttributes systemAttributes)
```
- getEffectiveFromTime
```
public Long getEffectiveFromTime()
```
  Return the date/time that this relationship should start to be used (null means it can be used from creationTime).
  
  Returns:
  
  Date the relationship becomes effective.
- setEffectiveFromTime
```
public void setEffectiveFromTime(Long effectiveFromTime)
```
- getEffectiveToTime
```
public Long getEffectiveToTime()
```
  Return the date/time that this relationship should no longer be used.
  
  Returns:
  
  Date the relationship stops being effective.
- setEffectiveToTime
```
public void setEffectiveToTime(Long effectiveToTime)
```
- getGuid
```
public String getGuid()
```
- setGuid
```
public void setGuid(String guid)
```
- getName
```
public String getName()
```
- getAdditionalProperties
```
public Map<String,String> getAdditionalProperties()
```
  Get the extra attributes - ones that are in addition to the standard types.
  
  Returns:
  
  extra attributes
- setAdditionalProperties
```
public void setAdditionalProperties(Map<String,String> additionalProperties)
```
- getEnd1
```
public RelationshipEnd getEnd1()
```
  Get relationship end 1. The child relationship sets the appropriate values for its relationship end 1
  
  Returns:
  
  RelationshipEnd relationship end 1
- setEnd1
```
public void setEnd1(RelationshipEnd end1)
```
- getEnd2
```
public RelationshipEnd getEnd2()
```
  Get relationship end 1. The child relationship sets the appropriate values for its relationship end 1
  
  Returns:
  
  RelationshipEnd relationship end 1
- setEnd2
```
public void setEnd2(RelationshipEnd end2)
```
- isReadOnly
```
public boolean isReadOnly()
```
  The relationship is readOnly
  
  Returns:
  
  whether read only
- setReadOnly
```
public void setReadOnly(boolean readOnly)
```
  set whether the relationship is readOnly
  
  Parameters:
  
  readOnly - readonly flag
- toString
```
public StringBuilder toString(StringBuilder sb)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class Relationship

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

relationshipType

name

end1

end2

Constructor Detail

Relationship

Method Detail

initialise

getRelationshipType

setRelationshipType

getSystemAttributes

setSystemAttributes

getEffectiveFromTime

setEffectiveFromTime

getEffectiveToTime

setEffectiveToTime

getGuid

setGuid

getName

getAdditionalProperties

setAdditionalProperties

getEnd1

setEnd1

getEnd2

setEnd2

isReadOnly

setReadOnly

toString

toString