com.atlassian.confluence.admin.criteria
Class IgnorableAdminTaskCriteria

java.lang.Object
  extended by com.atlassian.confluence.admin.criteria.IgnorableAdminTaskCriteria
All Implemented Interfaces:
AdminConfigurationCriteria
Direct Known Subclasses:
BackupsAreManualCriteria

public class IgnorableAdminTaskCriteria
extends Object
implements AdminConfigurationCriteria

Criteria for Admin Tasks which can be dismissed.

Tasks can inherit from this criteria and implement the isMet() criteria, otherwise tasks using this critera will remain dismissed and not completed.


Constructor Summary
IgnorableAdminTaskCriteria(String key, SettingsManager settingsManager)
          Constructor
IgnorableAdminTaskCriteria(String key, SettingsManager settingsManager, AdminConfigurationCriteria alternativeCriteria)
          Constructor with an alternative criteria.
 
Method Summary
 boolean getIgnored()
           
 String getValue()
           
 boolean hasLiveValue()
           
 boolean hasValue()
           
 boolean isMet()
          Whether the acceptance criteria is met or not for this admin configuration.
 void setIgnored(boolean ignore)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IgnorableAdminTaskCriteria

public IgnorableAdminTaskCriteria(String key,
                                  SettingsManager settingsManager)
Constructor

Parameters:
key - the key of the admin task
settingsManager - the settings manager

IgnorableAdminTaskCriteria

public IgnorableAdminTaskCriteria(String key,
                                  SettingsManager settingsManager,
                                  AdminConfigurationCriteria alternativeCriteria)
Constructor with an alternative criteria. The task is ignored if either of the criteria is fulfilled.

Parameters:
key - the key of the admin task
settingsManager - the settings manager
alternativeCriteria - alternative criteria.
Method Detail

getIgnored

public boolean getIgnored()
Specified by:
getIgnored in interface AdminConfigurationCriteria
Returns:
true if the acceptance criteria for this configuration has been ignored by an end-user, false otherwise.

setIgnored

public void setIgnored(boolean ignore)
Specified by:
setIgnored in interface AdminConfigurationCriteria
Parameters:
ignore - whether this acceptance criteria should be ignored or not.

isMet

public boolean isMet()
Description copied from interface: AdminConfigurationCriteria
Whether the acceptance criteria is met or not for this admin configuration.

Specified by:
isMet in interface AdminConfigurationCriteria
Returns:
true if the acceptance criteria is met, false otherwise.

hasValue

public boolean hasValue()
Specified by:
hasValue in interface AdminConfigurationCriteria
Returns:
true if the task has a value which can be configured.

getValue

public String getValue()
Specified by:
getValue in interface AdminConfigurationCriteria
Returns:
A human-friendly representation of the current value of the admin configuration.

hasLiveValue

public boolean hasLiveValue()
Specified by:
hasLiveValue in interface AdminConfigurationCriteria
Returns:
Whether the value for this configuration criteria should always be queried as opposed to cached. Useful for getting live data instead of an 'accepted value' when an associated task is completed.


Copyright © 2003–2015 Atlassian. All rights reserved.