Package com.atlassian.gadgets.directory
Interface Directory
public interface Directory
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceEntry in the directory which is local P2 module.static interfaceA single entry in the directory.static enumThis scope is used to determine entries that get retrieved whengetEntries(com.atlassian.gadgets.GadgetRequestContext, com.atlassian.gadgets.directory.Directory.EntryScope)is called.static interfaceEntry in the directory which is based on Open Social specification. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionbooleangetEntries(GadgetRequestContext gadgetRequestContext) Returns all the entries available, localized by thelocale.getEntries(GadgetRequestContext gadgetRequestContext, Directory.EntryScope entryScope) Returns all entries with the given scope.
-
Field Details
-
DIRECTORY_FEATURE_NAME
- See Also:
-
DIRECTORY_FEATURE_CATEGORIES_NAME
- See Also:
-
-
Method Details
-
getEntries
Returns all the entries available, localized by thelocale. This is equivalent to callinggetEntries(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 requestentryScope- the entry scope: local, external, or all.- Returns:
- All entries with the given scope.
-
contains
- 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
-