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

Interface MacroServiceAsync

All Known Implementing Classes:

MacroServiceAsyncCacheProxy

public interface MacroServiceAsync

Service interface used on the client by the macro plug-in. It should have all the methods from MacroService with an additional AsyncCallback parameter. This is specific to GWT's architecture.

Version:

$Id: 6940e226a28495311480f8562910ee97367cd291 $

Method Summary

Methods

Modifier and Type	Method and Description
void	getMacroDescriptor(String macroId, String syntaxId, com.google.gwt.user.client.rpc.AsyncCallback<MacroDescriptor> async) Makes a request to the server to get the descriptor for the specified macro.
void	getMacroDescriptor(String macroId, String syntaxId, String wikiId, com.google.gwt.user.client.rpc.AsyncCallback<MacroDescriptor> async) Makes a request to the server to get the descriptor for the specified macro.
void	getMacroDescriptors(String syntaxId, com.google.gwt.user.client.rpc.AsyncCallback<List<MacroDescriptor>> async) Makes a request to the server to get all the macro descriptors for the specified syntax.
void	getMacroDescriptors(String syntaxId, String wikiId, com.google.gwt.user.client.rpc.AsyncCallback<List<MacroDescriptor>> async) Makes a request to the server to get all the macro descriptors for the specified syntax.

Method Detail

getMacroDescriptor

void getMacroDescriptor(String macroId,
                      String syntaxId,
                      String wikiId,
                      com.google.gwt.user.client.rpc.AsyncCallback<MacroDescriptor> async)

Makes a request to the server to get the descriptor for the specified macro.

Parameters:

macroId - a macro identifier

syntaxId - a syntax identifier

wikiId - a wiki identifier

async - the call-back to be used for notifying the caller after receiving the response from the server

Since:

6.4M1

getMacroDescriptor

void getMacroDescriptor(String macroId,
                      String syntaxId,
                      com.google.gwt.user.client.rpc.AsyncCallback<MacroDescriptor> async)

Makes a request to the server to get the descriptor for the specified macro.

Parameters:

macroId - a macro identifier

syntaxId - a syntax identifier

async - the call-back to be used for notifying the caller after receiving the response from the server

getMacroDescriptors

void getMacroDescriptors(String syntaxId,
                       String wikiId,
                       com.google.gwt.user.client.rpc.AsyncCallback<List<MacroDescriptor>> async)

Makes a request to the server to get all the macro descriptors for the specified syntax.

Parameters:

syntaxId - a syntax identifier

wikiId - a wiki identifier

async - the call-back to be used for notifying the caller after receiving the response from the server

Since:

6.4M1

getMacroDescriptors

void getMacroDescriptors(String syntaxId,
                       com.google.gwt.user.client.rpc.AsyncCallback<List<MacroDescriptor>> async)

Makes a request to the server to get all the macro descriptors for the specified syntax.

Parameters:

syntaxId - a syntax identifier

async - the call-back to be used for notifying the caller after receiving the response from the server