Package com.esri.arcgisruntime.tasks.offlinemap

Class GenerateOfflineMapJob

java.lang.Object

com.esri.arcgisruntime.concurrent.Job

com.esri.arcgisruntime.tasks.offlinemap.GenerateOfflineMapJob

All Implemented Interfaces:

JsonSerializable, RemoteResource

public final class GenerateOfflineMapJob
extends Job

A Job that generates an offline map from an online map.

A GenerateGeodatabaseJob instance is returned by OfflineMapTask.generateOfflineMap(GenerateOfflineMapParameters, String). The Job is returned in a Status.NOT_STARTED state and Job.start() must be called to start the associated operation.

See the Job class for full information on how to work with jobs.

Since:

100.1.0

See Also:

Job

Nested Class Summary

Nested classes/interfaces inherited from class com.esri.arcgisruntime.concurrent.Job

Job.Message, Job.MessageSeverity, Job.MessageSource, Job.Status

Field Summary

Fields inherited from class com.esri.arcgisruntime.concurrent.Job

mCredential, mRequestConfiguration

Method Summary

Modifier and Type	Method	Description
String	getDownloadDirectoryPath()	Gets the download directory path used by this job.
ArcGISMap	getOnlineMap()	Gets the online map used by this job.
GenerateOfflineMapParameterOverrides	getParameterOverrides()	Gets the parameter overrides used by this job.
GenerateOfflineMapParameters	getParameters()	Gets the parameters used by this job.
GenerateOfflineMapResult	getResult()	Returns a GenerateOfflineMapResult once the job has completed.

Methods inherited from class com.esri.arcgisruntime.concurrent.Job

addJobChangedListener, addJobDoneListener, addJobMessageAddedListener, addProgressChangedListener, addStatusChangedListener, cancel, cancelAsync, fromJson, getCredential, getError, getMessages, getProgress, getRequestConfiguration, getServerJobId, getStatus, getUnknownJson, getUnsupportedJson, getUri, pause, removeJobChangedListener, removeJobDoneListener, removeJobMessageAddedListener, removeProgressChangedListener, removeStatusChangedListener, setCredential, setRequestConfiguration, setUri, start, toJson

Methods inherited from class java.lang.Object

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

Method Detail

getDownloadDirectoryPath

public String getDownloadDirectoryPath()

Gets the download directory path used by this job. This is the folder in which the resultant mobile map package is stored.

As the job also returns a mobile map package, the same path can be used to instantiate the MobileMapPackage.

Returns:

the download directory path used by this job

Since:

100.1.0

getOnlineMap

public ArcGISMap getOnlineMap()

Gets the online map used by this job.

Returns:

the online map used by this job

Since:

100.1.0

getParameters

public GenerateOfflineMapParameters getParameters()

Gets the parameters used by this job.

Returns:

the parameters used by this job

Since:

100.1.0

getParameterOverrides

public GenerateOfflineMapParameterOverrides getParameterOverrides()

Gets the parameter overrides used by this job.

Returns:

the parameter overrides, or null if none

Since:

100.4.0

getResult

public GenerateOfflineMapResult getResult()

Returns a GenerateOfflineMapResult once the job has completed. The methods of GenerateOfflineMapResult indicate if there were errors related to any layers or tables within the map.

Specified by:

getResult in class Job

Returns:

a GenerateOfflineMapResult containing the result, or null if the job is not done yet or was cancelled

Since:

100.1.0

See Also:

GenerateOfflineMapResult.hasErrors(), GenerateOfflineMapResult.getLayerErrors(), GenerateOfflineMapResult.getTableErrors()