com.atlassian.gadgets.directory

Interface Directory

public interface Directory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Directory.DashboardDirectoryEntry Entry in the directory which is local P2 module.
static interface	Directory.Entry<T> A single entry in the directory.
static class	Directory.EntryScope This scope is used to determine entries that get retrieved when getEntries(com.atlassian.gadgets.GadgetRequestContext, com.atlassian.gadgets.directory.Directory.EntryScope) is called.
static interface	Directory.OpenSocialDirectoryEntry Entry in the directory which is based on Open Social specification.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTORY_FEATURE_CATEGORIES_NAME
static String	DIRECTORY_FEATURE_NAME

Method Summary

Modifier and Type	Method and Description
boolean	contains(URI gadgetSpecUri)
Iterable<Directory.Entry<?>>	getEntries(GadgetRequestContext gadgetRequestContext) Returns all the entries available, localized by the locale.
Iterable<Directory.Entry<?>>	getEntries(GadgetRequestContext gadgetRequestContext, Directory.EntryScope entryScope) Returns all entries with the given scope.

Field Detail

DIRECTORY_FEATURE_NAME

static final String DIRECTORY_FEATURE_NAME

See Also:

Constant Field Values

DIRECTORY_FEATURE_CATEGORIES_NAME

static final String DIRECTORY_FEATURE_CATEGORIES_NAME

See Also:

Constant Field Values

Method Detail

getEntries

Iterable<Directory.Entry<?>> getEntries(GadgetRequestContext gadgetRequestContext)

Returns all the entries available, localized by the locale. This is equivalent to calling getEntries(com.atlassian.gadgets.GadgetRequestContext, com.atlassian.gadgets.directory.Directory.EntryScope) with EntryScope.ALL.

Parameters:

gadgetRequestContext - the context of this request

Returns:

all the entries available

getEntries

Iterable<Directory.Entry<?>> getEntries(GadgetRequestContext gadgetRequestContext,
                                        Directory.EntryScope entryScope)

Returns all entries with the given scope.

Parameters:

gadgetRequestContext - the context of this request

entryScope - the entry scope: local, external, or all.

Returns:

All entries with the given scope.

contains

boolean contains(URI gadgetSpecUri)

Parameters:

gadgetSpecUri - uri of the gadget spec to check if it's in the directory

Returns:

true if the gadget spec at the location specificied by the uri is in the directory, false otherwise