Package org.odpi.openmetadata.repositoryservices.rest.properties

Class InstanceHistoricalFindRequest

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.TypeLimitedFindRequest

org.odpi.openmetadata.repositoryservices.rest.properties.SubtypeLimitedFindRequest

org.odpi.openmetadata.repositoryservices.rest.properties.InstanceFindRequest

org.odpi.openmetadata.repositoryservices.rest.properties.InstanceHistoricalFindRequest

All Implemented Interfaces:

Serializable

public class InstanceHistoricalFindRequest
extends InstanceFindRequest

InstanceHistoricalFindRequest 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
InstanceHistoricalFindRequest()	Default constructor
InstanceHistoricalFindRequest(InstanceHistoricalFindRequest template)	Copy/clone constructor

Method Summary

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.InstanceFindRequest

getMatchProperties, setMatchProperties

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.SubtypeLimitedFindRequest

getSubtypeGUIDs, setSubtypeGUIDs

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedFindRequest

getTypeGUID, setTypeGUID

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 Details

InstanceHistoricalFindRequest

public InstanceHistoricalFindRequest()

Default constructor

InstanceHistoricalFindRequest

public InstanceHistoricalFindRequest(InstanceHistoricalFindRequest template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

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 InstanceFindRequest

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 InstanceFindRequest

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 InstanceFindRequest

Returns:

int hash code