public interface

AdminTaskConfig

com.atlassian.confluence.admin.tasks.AdminTaskConfig
Known Indirect Subclasses

Class Overview

Encapsulates the non-serializable system components of an AdminTask.

Summary

Constants
String TASK_PREFIX The prefix that all admin task keys will begin with.
Public Methods
abstract AdminConfigurationCriteria getAdminConfigurationCriteria()
A system-verifiable success condition for this admin task.
abstract List<String> getAllConfigurationUris()
A collection of all links to admin configuration pages stored in this admin task config.
abstract String getFirstConfigurationUri()
The first admin configuration page link stored in this task config.
abstract String getKey()
The key for the admin task.

Constants

public static final String TASK_PREFIX

The prefix that all admin task keys will begin with.

Constant Value: "admintask"

Public Methods

public abstract AdminConfigurationCriteria getAdminConfigurationCriteria ()

A system-verifiable success condition for this admin task.

Returns

public abstract List<String> getAllConfigurationUris ()

A collection of all links to admin configuration pages stored in this admin task config.

Returns
  • A list of all admin configuration page links for this task config, sorted in the order they were added.

public abstract String getFirstConfigurationUri ()

The first admin configuration page link stored in this task config.

Returns
  • a string for the first link of this task config, or null if getAllConfigurationUris().isEmpty() is true.

public abstract String getKey ()

The key for the admin task. Used as a handle to store and retrieve both the metadata for an admin task and i18n strings for the task.

Returns
  • The string key for this admin task.