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.
 java.util.Set<MacroMetadata> getMacroMetadata()
          Retrieves a set of macro metadata for display in the Macro Browser.
 java.util.Set<MacroMetadata> getMacroMetadata(java.util.Collection<java.lang.String> whitelist)
          Retrieves a set of macros that matches the whitelisted macro names.
 java.util.Set<MacroSummary> getMacroSummaries()
          Retrieve just the key, title, description and icon of all the macros
 

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.


getMacroMetadata

java.util.Set<MacroMetadata> getMacroMetadata(java.util.Collection<java.lang.String> whitelist)
Retrieves a set of macros that matches the whitelisted macro names.

Parameters:
whitelist -
Returns:

getMacroSummaries

java.util.Set<MacroSummary> getMacroSummaries()
Retrieve just the key, title, description and icon of all the macros



Copyright © 2003-2014 Atlassian. All Rights Reserved.