com.atlassian.confluence.macro.browser
Interface MacroBrowserManager

All Known Implementing Classes:

DefaultMacroBrowserManager

public interface MacroBrowserManager

Method Summary

java.util.Set<MacroCategory>	getMacroCategories() Retrieves a set of macro categories for display in the Macro Browser.
MacroFormDetails	getMacroFormDetails(java.lang.String macroKey) Retrieves form details for a single macro for use in the Macro Browser.
java.util.Set<MacroMetadata>	getMacroMetadata() Retrieves a set of macro metadata for display in the Macro Browser.

Method Detail

getMacroCategories

java.util.Set<MacroCategory> getMacroCategories()

Retrieves a set of macro categories for display in the Macro Browser.

getMacroMetadata

java.util.Set<MacroMetadata> getMacroMetadata()

Retrieves a set of macro metadata for display in the Macro Browser. Aliases of macros should be not included in this set.

getMacroFormDetails

MacroFormDetails getMacroFormDetails(java.lang.String macroKey)

Retrieves form details for a single macro for use in the Macro Browser.

Parameters:

macroKey - the macro name to retrieve form details for

Returns:

The MacroFormDetails for the given macro. Null is returned if the macro is unknown.