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 java.lang.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 org.opencms.ugc.shared.rpc.I_CmsUgcEditServiceAsync
SERVICE
Service instance.static java.lang.String
SERVICE_URL
The service URL.
-
Constructor Summary
Constructors Constructor Description CmsXmlContentUgcApi()
Default constructor for gwt-exporter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsRequestCounter
getRequestCounter()
Gets the request counter.CmsRpcCallHelper
getRpcHelper()
Creates an RPC helper object.void
handleError(java.lang.Throwable e, I_CmsErrorCallback callback)
Passes an exception to the given error handling callback and optionally outputs some debug info.void
initFormForSession(java.lang.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.
-
-
-
Field Detail
-
SERVICE
public static final org.opencms.ugc.shared.rpc.I_CmsUgcEditServiceAsync SERVICE
Service instance.
-
SERVICE_URL
public static final java.lang.String SERVICE_URL
The service URL.
-
-
Constructor Detail
-
CmsXmlContentUgcApi
public CmsXmlContentUgcApi()
Default constructor for gwt-exporter.
-
-
Method Detail
-
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(java.lang.Throwable e, I_CmsErrorCallback callback)
Passes an exception to the given error handling callback and optionally outputs some debug info.- Parameters:
e
- the exceptioncallback
- the error handling callback
-
initFormForSession
public void initFormForSession(java.lang.String sessionId, com.google.gwt.dom.client.Element formElement, I_CmsClientCmsUgcSessionCallback onSuccess, I_CmsErrorCallback onError)
Loads a pre-created session.- Parameters:
sessionId
- the session idformElement
- the form elementonSuccess
- the callback to call in case of successonError
- 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.
-
-