com.atlassian.confluence.admin.tasks
Interface AdminTaskConfig

All Known Implementing Classes:
DefaultAdminTaskConfig

public interface AdminTaskConfig

Encapsulates the non-serializable system components of an AdminTask.

Since:
4.0

Field Summary
static String TASK_PREFIX
          The prefix that all admin task keys will begin with.
 
Method Summary
 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 getFirstConfigurationUri()
          The first admin configuration page link stored in this task config.
 String getKey()
          The key for the admin task.
 

Field Detail

TASK_PREFIX

static final String TASK_PREFIX
The prefix that all admin task keys will begin with.

See Also:
Constant Field Values
Method Detail

getKey

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.

getAdminConfigurationCriteria

AdminConfigurationCriteria getAdminConfigurationCriteria()
A system-verifiable success condition for this admin task.

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

getFirstConfigurationUri

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.

getAllConfigurationUris

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.


Copyright © 2003-2011 Atlassian. All Rights Reserved.