RelatedEntitiesHistoricalFindRequest (Repository Services General APIs 3.5 API)

java.lang.Object
- org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest
- - org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest
  - - org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedFindRequest
    - - org.odpi.openmetadata.repositoryservices.rest.properties.RelatedEntitiesFindRequest
      - org.odpi.openmetadata.repositoryservices.rest.properties.RelatedEntitiesHistoricalFindRequest

All Implemented Interfaces:

Serializable
```
public class RelatedEntitiesHistoricalFindRequest
extends RelatedEntitiesFindRequest
```
RelatedEntitiesHistoricalFindRequest provides an extension to the search parameters to include the point in time that the request should be based on. This extension is used since historical queries are optional support.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`RelatedEntitiesHistoricalFindRequest()`	Default constructor
`RelatedEntitiesHistoricalFindRequest(RelatedEntitiesHistoricalFindRequest 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.
`Date`	`getAsOfTime()`	Return the point in time for the search.
`int`	`hashCode()`	Create a hash code for this element type.
`void`	`setAsOfTime(Date asOfTime)`	Set up the point in time for the search.
`String`	`toString()`	Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.RelatedEntitiesFindRequest
getEntityTypeGUIDs, getLimitResultsByClassification, setEntityTypeGUIDs, setLimitResultsByClassification

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedFindRequest
getOffset, getPageSize, getSequencingOrder, getSequencingProperty, setOffset, setPageSize, setSequencingOrder, setSequencingProperty

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest
getLimitResultsByStatus, setLimitResultsByStatus

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

- Constructor Detail
  - RelatedEntitiesHistoricalFindRequest
```
public RelatedEntitiesHistoricalFindRequest()
```
    Default constructor
  - RelatedEntitiesHistoricalFindRequest
```
public RelatedEntitiesHistoricalFindRequest(RelatedEntitiesHistoricalFindRequest template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getAsOfTime
```
public Date getAsOfTime()
```
    Return the point in time for the search.
    
    Returns:
    
    date object
  - setAsOfTime
```
public void setAsOfTime(Date asOfTime)
```
    Set up the point in time for the search.
    
    Parameters:
    
    asOfTime - date object
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class RelatedEntitiesFindRequest
    
    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 RelatedEntitiesFindRequest
    
    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 RelatedEntitiesFindRequest
    
    Returns:
    
    int hash code