com.atlassian.gadgets.publisher.spi
Interface PluginGadgetSpecProviderPermission

All Known Implementing Classes:

AggregatePluginGadgetSpecProviderPermissionImpl, AllowAdminOnlyPluginGadgetSpecProviderPermissionImpl

public interface PluginGadgetSpecProviderPermission

Used to check if a gadget spec that has been loaded from a plugin should appear in the gadget browser. This may be implemented in a number of ways:

• checking a role parameter on the PluginGadgetSpec that is defined in the ModuleDescriptor
• a showInDirectory parameter from the ModuleDescriptor
• a way for administrators to only allow certain groups of users to add select groups of gadgets to their dashboard

Since:

2.0

Method Summary

Vote	voteOn(PluginGadgetSpec gadgetSpec) Returns the implementation's Vote on whether the specified gadget spec should be appear in the gadget browser.

Method Detail

voteOn

Vote voteOn(PluginGadgetSpec gadgetSpec)

Returns the implementation's Vote on whether the specified gadget spec should be appear in the gadget browser.

If DENY is returned, the gadget should not appear, no matter what any other implementations vote may be.

If ALLOW is returned, the gadget should appear in the gadget browser unless another implementation explicitly denies its appearance.

PASS will be returned if the implementation has no opinion on whether the gadget should show up in the gadget browser.

Parameters:

gadgetSpec - the gadget spec found in a plugin that will be evaluated

Returns:

this implementation's Vote on whether to the gadget should appear in the gadget browser