com.atlassian.gadgets.opensocial.spi
Interface GadgetSpecUrlRenderPermission

All Known Implementing Classes:
GadgetSpecUrlRenderPermissionImpl

public interface GadgetSpecUrlRenderPermission

Used to check if a gadget spec URI is allowed to render on a dashboard. This may be implemented in a number of ways:

Syntactically invalid URIs must never be allowed to render.

Since:
2.0

Method Summary
 Vote voteOn(String gadgetSpecUri)
          Returns the implementation's Vote on whether the specified gadget spec should be allowed to render.
 

Method Detail

voteOn

Vote voteOn(String gadgetSpecUri)

Returns the implementation's Vote on whether the specified gadget spec should be allowed to render.

If DENY is returned, the gadget URI is explicitly forbidden to render, no matter what any other implementations vote may be.

If ALLOW is returned, the gadget URI is explicitly allowed to render unless another implementation explicitly denies the rendering permission.

PASS will be returned if the implementation has no opinion on whether the URI may render.

Parameters:
gadgetSpecUri - the gadget spec URI to evaluate
Returns:
this implementation's Vote on whether to render the gadget


Copyright © 2014 Atlassian. All Rights Reserved.