PlatformService.PlatformTaskStatus

All Known Subinterfaces:: PlatformService.PlatformTask<T>

Enclosing interface:: PlatformService

public static interface PlatformService.PlatformTaskStatus

Status information about a task.

Method Summary

Modifier and Type

Method

Description

String

getMessage(Locale locale)

Get a message describing what the task is currently doing.

double

getPercentComplete()

Get the amount of work that has been completed, as a fractional percentage between 0 and 1.

String

getTaskId()

Get a unique task ID for this task.

String

getTitle(Locale locale)

Get a title of this task.

boolean

isComplete()

Get a flag that indicates if the task is complete.

boolean

isRestartRequired()

Get a flag that indicates if a system restart is required after the task completes.

Method Details
- getTaskId
  
  String getTaskId()
  
  Get a unique task ID for this task.
  
  Returns:
  
  the unique ID
- getTitle
  
  String getTitle(Locale locale)
  
  Get a title of this task.
  
  Parameters:
  
  locale - the desired locale of the title
  
  Returns:
  
  the title
- getMessage
  
  String getMessage(Locale locale)
  
  Get a message describing what the task is currently doing.
  
  Parameters:
  
  locale - the desired locale of the message
  
  Returns:
  
  the message
- getPercentComplete
  
  double getPercentComplete()
  
  Get the amount of work that has been completed, as a fractional percentage between 0 and 1.
  
  Returns:
  
  the amount of work completed, or anything < 0 if not known
- isComplete
  
  boolean isComplete()
  
  Get a flag that indicates if the task is complete.
  
  Returns:
  
  the complete flag
- isRestartRequired
  
  boolean isRestartRequired()
  
  Get a flag that indicates if a system restart is required after the task completes.
  
  Returns:
  
  a restart required flag