Package com.atlassian.confluence.admin.tasks

Class DefaultAdminTaskConfig

java.lang.Object

com.atlassian.confluence.admin.tasks.DefaultAdminTaskConfig

All Implemented Interfaces:

AdminTaskConfig

public class DefaultAdminTaskConfig
extends Object
implements AdminTaskConfig

Field Summary

Fields inherited from interface com.atlassian.confluence.admin.tasks.AdminTaskConfig

TASK_PREFIX

Constructor Summary

Constructors

Constructor	Description
DefaultAdminTaskConfig(String key)
DefaultAdminTaskConfig(String key, AdminConfigurationCriteria adminConfigurationCriteria)
DefaultAdminTaskConfig(String key, AdminConfigurationCriteria adminConfigurationCriteria, String configurationUri)
DefaultAdminTaskConfig(String key, AdminConfigurationCriteria adminConfigurationCriteria, List<String> configurationUris)

Method Summary

Modifier and Type	Method	Description
String	getActionTextKey()
AdminConfigurationCriteria	getAdminConfigurationCriteria()	A system-verifiable success condition for this admin task.
List<String>	getAllConfigurationUris()	A collection of all links to admin configuration pages stored in this admin task config.
String	getConfigurationCurrentValueKey()
String	getDescriptionKey()
String	getFirstConfigurationUri()	The first admin configuration page link stored in this task config.
String	getKey()	The key for the admin task.
String	getTitleKey()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAdminTaskConfig

public DefaultAdminTaskConfig(String key)

DefaultAdminTaskConfig

public DefaultAdminTaskConfig(String key,
                              AdminConfigurationCriteria adminConfigurationCriteria)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

DefaultAdminTaskConfig

public DefaultAdminTaskConfig(String key,
                              AdminConfigurationCriteria adminConfigurationCriteria,
                              String configurationUri)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

DefaultAdminTaskConfig

public DefaultAdminTaskConfig(String key,
                              AdminConfigurationCriteria adminConfigurationCriteria,
                              List<String> configurationUris)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Detail

getKey

public String getKey()

Description copied from interface: AdminTaskConfig

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.

Specified by:

getKey in interface AdminTaskConfig

Returns:

The string key for this admin task.

getTitleKey

public String getTitleKey()

Specified by:

getTitleKey in interface AdminTaskConfig

getDescriptionKey

public String getDescriptionKey()

Specified by:

getDescriptionKey in interface AdminTaskConfig

getActionTextKey

public String getActionTextKey()

Specified by:

getActionTextKey in interface AdminTaskConfig

getConfigurationCurrentValueKey

public String getConfigurationCurrentValueKey()

Specified by:

getConfigurationCurrentValueKey in interface AdminTaskConfig

getAdminConfigurationCriteria

public AdminConfigurationCriteria getAdminConfigurationCriteria()

Description copied from interface: AdminTaskConfig

A system-verifiable success condition for this admin task.

Specified by:

getAdminConfigurationCriteria in interface AdminTaskConfig

Returns:

an AdminConfigurationCriteria that encapsulates the success criteria for this admin task.

getFirstConfigurationUri

public String getFirstConfigurationUri()

Description copied from interface: AdminTaskConfig

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

Specified by:

getFirstConfigurationUri in interface AdminTaskConfig

Returns:

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

getAllConfigurationUris

public List<String> getAllConfigurationUris()

Description copied from interface: AdminTaskConfig

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

Specified by:

getAllConfigurationUris in interface AdminTaskConfig

Returns:

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