org.xwiki.gwt.wysiwyg.client.plugin.macro

Interface MacroService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

@Role
@RemoteServiceRelativePath(value="MacroService.gwtrpc")
public interface MacroService
extends com.google.gwt.user.client.rpc.RemoteService

The service interface used on the server.

Version:

$Id: 2f479f07c467331b51fbdf26851b9e4a8108dc83 $

Method Summary

Methods

Modifier and Type	Method and Description
MacroDescriptor	getMacroDescriptor(String macroId, String syntaxId)
MacroDescriptor	getMacroDescriptor(String macroId, String syntaxId, String wikiId)
List<MacroDescriptor>	getMacroDescriptors(String syntaxId)
List<MacroDescriptor>	getMacroDescriptors(String syntaxId, String wikiId)

Method Detail

getMacroDescriptor

MacroDescriptor getMacroDescriptor(String macroId,
                                 String syntaxId,
                                 String wikiId)

Parameters:

macroId - a macro identifier

syntaxId - a syntax identifier

wikiId - a wiki identifier

Returns:

an object describing the specified macro visible from the specified wiki

Since:

6.4M1

getMacroDescriptor

MacroDescriptor getMacroDescriptor(String macroId,
                                 String syntaxId)

Parameters:

macroId - a macro identifier

syntaxId - a syntax identifier

Returns:

an object describing the specified macro

getMacroDescriptors

List<MacroDescriptor> getMacroDescriptors(String syntaxId,
                                        String wikiId)

Parameters:

syntaxId - a syntax identifier

wikiId - a wiki identifier

Returns:

the list of all the macro descriptors for the specified syntax visible from the specified wiki

Since:

6.4M1

getMacroDescriptors

List<MacroDescriptor> getMacroDescriptors(String syntaxId)

Parameters:

syntaxId - a syntax identifier

Returns:

the list of all the macro descriptors for the specified syntax