Package org.opencms.ugc.client.export

Class CmsXmlContentUgcApi

java.lang.Object

org.opencms.ugc.client.export.CmsXmlContentUgcApi

All Implemented Interfaces:

org.timepedia.exporter.client.Exportable

public class CmsXmlContentUgcApi
extends Object
implements org.timepedia.exporter.client.Exportable

Root access point for the Javascript form editing API exported with gwt-exporter. Can be used to acquire new form editing sessions.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.opencms.ugc.shared.rpc.I_CmsUgcEditServiceAsync	SERVICE	Service instance.
static final String	SERVICE_URL	The service URL.

Constructor Summary

Constructors

Constructor	Description
CmsXmlContentUgcApi()	Default constructor for gwt-exporter.

Method Summary

Modifier and Type	Method	Description
CmsRequestCounter	getRequestCounter()	Gets the request counter.
CmsRpcCallHelper	getRpcHelper()	Creates an RPC helper object.
void	handleError(Throwable e, I_CmsErrorCallback callback)	Passes an exception to the given error handling callback and optionally outputs some debug info.
void	initFormForSession(String sessionId, com.google.gwt.dom.client.Element formElement, I_CmsClientCmsUgcSessionCallback onSuccess, I_CmsErrorCallback onError)	Loads a pre-created session.
void	setErrorCallback(I_CmsStringArrayCallback callback)	Sets the error callback for all uncaught exceptions.
void	setWaitIndicatorCallback(I_CmsBooleanCallback callback)	Sets the wait indicator callback.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SERVICE

public static final org.opencms.ugc.shared.rpc.I_CmsUgcEditServiceAsync SERVICE

Service instance.

SERVICE_URL

public static final String SERVICE_URL

The service URL.

Constructor Details

CmsXmlContentUgcApi

public CmsXmlContentUgcApi()

Default constructor for gwt-exporter.

Method Details

getRequestCounter

public CmsRequestCounter getRequestCounter()

Gets the request counter.

Returns:

the request counter

getRpcHelper

public CmsRpcCallHelper getRpcHelper()

Creates an RPC helper object.

Returns:

the RPC helper

handleError

public void handleError(Throwable e,
 I_CmsErrorCallback callback)

Passes an exception to the given error handling callback and optionally outputs some debug info.

Parameters:

e - the exception

callback - the error handling callback

initFormForSession

public void initFormForSession(String sessionId,
 com.google.gwt.dom.client.Element formElement,
 I_CmsClientCmsUgcSessionCallback onSuccess,
 I_CmsErrorCallback onError)

Loads a pre-created session.

Parameters:

sessionId - the session id

formElement - the form element

onSuccess - the callback to call in case of success

onError - the callback to call in case of an error

setErrorCallback

public void setErrorCallback(I_CmsStringArrayCallback callback)

Sets the error callback for all uncaught exceptions.

Parameters:

callback - the error callback

setWaitIndicatorCallback

public void setWaitIndicatorCallback(I_CmsBooleanCallback callback)

Sets the wait indicator callback.

Parameters:

callback - a callback used to switch the wait indicator off or on.