RelationshipResponse (Repository Services General APIs 3.3 API)

java.lang.Object
- org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse
- - org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse

All Implemented Interfaces:

Serializable
```
public class RelationshipResponse
extends OMRSAPIResponse
```
RelationshipResponse describes the response to an OMRS REST API request that returns a relationship object.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse
  actionDescription, exceptionCausedBy, exceptionClassName, exceptionErrorMessage, exceptionErrorMessageId, exceptionErrorMessageParameters, exceptionProperties, exceptionSystemAction, exceptionUserAction, relatedHTTPCode

Constructor Summary

Constructors
Constructor Description

RelationshipResponse()
Default constructor

RelationshipResponse(RelationshipResponse template)
Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object objectToCompare)`	Compare the values of the supplied object with those stored in the current object.
`Relationship`	`getRelationship()`	Return the resulting relationship.
`int`	`hashCode()`	Create a hash code for this element type.
`void`	`setRelationship(Relationship relationship)`	Set up the returned relationship.
`String`	`toString()`	Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse
getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

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

- Constructor Detail
  - RelationshipResponse
```
public RelationshipResponse()
```
    Default constructor
  - RelationshipResponse
```
public RelationshipResponse(RelationshipResponse template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getRelationship
```
public Relationship getRelationship()
```
    Return the resulting relationship.
    
    Returns:
    
    relationship object
  - setRelationship
```
public void setRelationship(Relationship relationship)
```
    Set up the returned relationship.
    
    Parameters:
    
    relationship - relationship object
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class OMRSAPIResponse
    
    Returns:
    
    print out of variables in a JSON-style
  - equals
```
public boolean equals(Object objectToCompare)
```
    Compare the values of the supplied object with those stored in the current object.
    
    Overrides:
    
    equals in class OMRSAPIResponse
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Create a hash code for this element type.
    
    Overrides:
    
    hashCode in class OMRSAPIResponse
    
    Returns:
    
    int hash code