com.atlassian.gadgets.directory
Interface Directory.Entry

Enclosing interface:

Directory

public static interface Directory.Entry

A single entry in the directory.

Method Summary

String	getAuthorEmail() Returns the email address of the author of the gadget for this directory entry.
String	getAuthorName() Returns the name of the author of the gadget for this directory entry.
Set<Category>	getCategories() Returns the directory categories of this entry.
String	getDescription() Returns a textual description of the gadget for this directory entry.
URI	getGadgetSpecUri() Returns the URI of the gadget spec file for this directory entry.
URI	getSelf() Returns the unique URI of the directory entry.
URI	getThumbnailUri() Returns the URI of an image to display as a thumbnail or icon in the directory for this entry.
String	getTitle() Returns the title of the directory entry.
URI	getTitleUri() Returns a URI of the gadget author's choosing that is displayed as a link in the directory, with the title as the link text.
boolean	isDeletable() Can this Gadget Spec File be removed from the directory?

Method Detail

getSelf

@Nullable
URI getSelf()

Returns the unique URI of the directory entry.

Returns:

the URI that represents this directory entry, or null if the entry is not directly addressable.

isDeletable

boolean isDeletable()

Can this Gadget Spec File be removed from the directory?

Returns:

whether or not the Gadget Spec File be removed from the directory.

getGadgetSpecUri

URI getGadgetSpecUri()

Returns the URI of the gadget spec file for this directory entry.

Returns:

the URI of the gadget spec file for this entry. Must not be null.

getTitle

String getTitle()

Returns the title of the directory entry. This should be human-readable and localized. It will not have any dynamic substitution or other post-processing performed on it.

Returns:

the human-readable title of this entry. Must not be null, but may be an empty string.

getTitleUri

@Nullable
URI getTitleUri()

Returns a URI of the gadget author's choosing that is displayed as a link in the directory, with the title as the link text. In most cases this should be the gadget's web site. This method may return null to suppress the link.

Returns:

a URI to link to from the title in the directory entry. May be null.

getThumbnailUri

@Nullable
URI getThumbnailUri()

Returns the URI of an image to display as a thumbnail or icon in the directory for this entry. This method may return null if no thumbnail or icon is available.

Returns:

the URI of an image to display in the directory. May be null.

getAuthorName

String getAuthorName()

Returns the name of the author of the gadget for this directory entry.

Returns:

the name of the gadget author for this entry. Must not be null, but may be an empty string.

getAuthorEmail

String getAuthorEmail()

Returns the email address of the author of the gadget for this directory entry. This must be a well-formed and valid address, or an empty string if no email address should be displayed.

Returns:

the valid email address of the gadget author for this entry. Must not be null, but may be an empty string.

getDescription

String getDescription()

Returns a textual description of the gadget for this directory entry.

Returns:

a description of this entry. Must not be null, but may be an empty string.

getCategories

Set<Category> getCategories()

Returns the directory categories of this entry. If the gadget does not specify any valid category, this should return a set containing only Category.OTHER.

Returns:

a set of the directory categories of this entry or a set containing Category.OTHER. Must not be null.