com.atlassian.jira.web.action.util.sharing
Interface SharesListHelper

All Known Implementing Classes:
PortalPageDisplayBean, SearchRequestDisplayBean

public interface SharesListHelper

An interface to ensure that object that use the 'share-list.jsp' to render share permissions implement the necessary methods.

Since:
v3.13

Method Summary
 Long getId()
          Return the ID of the entity that owns the shares.
 Collection getSharePermissions()
          Returns the share permissions associated with the entity.
 boolean isPrivate()
          Tells the caller whether or not the entity is has any shares or not.
 

Method Detail

getId

Long getId()
Return the ID of the entity that owns the shares. Needs to be unique on a page.

Returns:
the ID of the entity that owns the shared. Needs to be unique on a page.

isPrivate

boolean isPrivate()
Tells the caller whether or not the entity is has any shares or not.

Returns:
true if the entity is shared privately or false otherwise.

getSharePermissions

Collection getSharePermissions()
Returns the share permissions associated with the entity.

Returns:
a collection of shares associated with the entity.


Copyright © 2002-2013 Atlassian. All Rights Reserved.