org.odpi.openmetadata.repositoryservices.rest.properties

Class HistoryRangeRequest

java.lang.Object

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest

org.odpi.openmetadata.repositoryservices.rest.properties.HistoryRangeRequest

All Implemented Interfaces:

Serializable

public class HistoryRangeRequest
extends OMRSAPIRequest

HistoryRequest carries the date/time for a historical query.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HistoryRangeRequest() Default constructor
HistoryRangeRequest(HistoryRangeRequest template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
Date	getFromTime() Return the earliest point of history to retrieve (inclusive).
int	getOffset() Return the starting element number for this set of results.
int	getPageSize() Return the maximum number of elements that can be returned on this request.
HistorySequencingOrder	getSequencingOrder() Return the sequencing order for the results.
Date	getToTime() Return the latest point of history up to which to return (exclusive).
int	hashCode() Create a hash code for this element type.
void	setFromTime(Date fromTime) Set up the earliest point of history to retrieve (inclusive).
void	setOffset(int offset) Set up the starting element number for this set of results.
void	setPageSize(int pageSize) Set up the maximum number of elements that can be returned on this request.
void	setSequencingOrder(HistorySequencingOrder sequencingOrder) Set up the sequencing order for the results.
void	setToTime(Date toTime) Set up the latest point of history up to which to return (exclusive).
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HistoryRangeRequest

public HistoryRangeRequest()

Default constructor

HistoryRangeRequest

public HistoryRangeRequest(HistoryRangeRequest template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getFromTime

public Date getFromTime()

Return the earliest point of history to retrieve (inclusive).

Returns:

date/time

setFromTime

public void setFromTime(Date fromTime)

Set up the earliest point of history to retrieve (inclusive).

Parameters:

fromTime - date/time

getToTime

public Date getToTime()

Return the latest point of history up to which to return (exclusive).

Returns:

date/time

setToTime

public void setToTime(Date toTime)

Set up the latest point of history up to which to return (exclusive).

Parameters:

toTime - date/time

getOffset

public int getOffset()

Return the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

Returns:

offset number

setOffset

public void setOffset(int offset)

Set up the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

Parameters:

offset - offset number

getPageSize

public int getPageSize()

Return the maximum number of elements that can be returned on this request.

Returns:

page size

setPageSize

public void setPageSize(int pageSize)

Set up the maximum number of elements that can be returned on this request.

Parameters:

pageSize - integer number

getSequencingOrder

public HistorySequencingOrder getSequencingOrder()

Return the sequencing order for the results.

Returns:

sequencing order enum

setSequencingOrder

public void setSequencingOrder(HistorySequencingOrder sequencingOrder)

Set up the sequencing order for the results.

Parameters:

sequencingOrder - sequencing order enum

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

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 Object

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 Object

Returns:

int hash code