Package com.esri.arcgisruntime.arcgisservices

Class ServiceTimeInfo

java.lang.Object

com.esri.arcgisruntime.arcgisservices.ServiceTimeInfo

public class ServiceTimeInfo
extends Object

Represents metadata about a service's support for querying features (see FeatureTable.queryFeaturesAsync(QueryParameters)) and requesting map images for ArcGISMapImageLayer based on time. It contains various time related information such as the map's time extent and the map's native time reference.

Since:

100.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceTimeInfo.TimeRelation	Indicates how the start and end time of the time slider extent are processed.

Method Summary

Modifier and Type	Method	Description
TimeValue	getDefaultInterval()	Gets the default time interval for the service.
int	getDefaultTimeInterval()	Deprecated. As of 100.3.0, replaced by getDefaultInterval().
TimeUnit	getDefaultTimeIntervalUnit()	Deprecated. As of 100.3.0, replaced by getDefaultInterval().
int	getDefaultTimeWindow()	Gets the default time window for the service to use for a time slider.
TimeExtent	getTimeExtent()	Gets the time extent of the service.
TimeReference	getTimeReference()	Gets the information about the time reference for the service.
ServiceTimeInfo.TimeRelation	getTimeRelation()	Gets the time relation for the service.
boolean	hasLiveData()	Indicates if the service has live data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefaultTimeInterval

@Deprecated
public int getDefaultTimeInterval()

Deprecated.

As of 100.3.0, replaced by getDefaultInterval().

Gets the default time interval for the service. This can be used as a time sliders step size. The time unit is specified by getDefaultTimeIntervalUnit().

Returns:

the time interval in the service's time units

Since:

100.0.0

getDefaultInterval

public TimeValue getDefaultInterval()

Gets the default time interval for the service. The time interval can be used as a time slider's step size.

Returns:

the default interval

Since:

100.3.0

getDefaultTimeIntervalUnit

@Deprecated
public TimeUnit getDefaultTimeIntervalUnit()

Deprecated.

As of 100.3.0, replaced by getDefaultInterval().

Gets the default time unit for the service.

Returns:

the time unit

Since:

100.0.0

getDefaultTimeWindow

public int getDefaultTimeWindow()

Gets the default time window for the service to use for a time slider. If this value is 0, then the time slider should create and use a TimeExtent for an instant in time (start time = end time), if it is greater than 0 this value should be used as the difference between the start time and end time. The time units are specified by getDefaultTimeIntervalUnit().

Returns:

the time window in the services time units

Since:

100.0.0

hasLiveData

public boolean hasLiveData()

Indicates if the service has live data. If true, export and identify operations will default the TimeExtent to startTime = (current server time - time interval), endTime = current server time.

Returns:

returns true if the service has live data, false otherwise.

Since:

100.0.0

getTimeReference

public TimeReference getTimeReference()

Gets the information about the time reference for the service.

Returns:

the time reference

Since:

100.0.0

getTimeRelation

public ServiceTimeInfo.TimeRelation getTimeRelation()

Gets the time relation for the service. This can be used for determining how a time slider's start and end time are processed.

Returns:

the time relation

Since:

100.0.0

getTimeExtent

public TimeExtent getTimeExtent()

Gets the time extent of the service.

Returns:

the time extent, or null if the service is not time aware

Since:

100.3.0