org.opencms.ugc.shared.rpc

Interface I_CmsUgcEditServiceAsync

public interface I_CmsUgcEditServiceAsync

The asynchronous form edit service interface.

Method Summary

Modifier and Type	Method and Description
void	destroySession(CmsUUID sessionId, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Destroys a session.
com.google.gwt.http.client.RequestBuilder	getContent(CmsUUID sessionId, com.google.gwt.user.client.rpc.AsyncCallback<CmsUgcContent> callback) Returns the form content for an existing session.
com.google.gwt.http.client.RequestBuilder	getLink(java.lang.String path, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> resultCallback) Gets the link corresponding to a given site path.
com.google.gwt.http.client.RequestBuilder	saveContent(CmsUUID sessionId, java.util.Map<java.lang.String,java.lang.String> contentValues, com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,java.lang.String>> callback) Saves the given content values to the edited content.
com.google.gwt.http.client.RequestBuilder	uploadFiles(CmsUUID sessionId, java.util.Set<java.lang.String> fieldNames, java.lang.String formDataId, com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,java.lang.String>> filenameCallback) Uploads submitted file form fields to the VFS.
com.google.gwt.http.client.RequestBuilder	validateContent(CmsUUID sessionId, java.util.Map<java.lang.String,java.lang.String> values, com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,java.lang.String>> resultCallback) Validates the new content values for a content loaded in the given session.

Method Detail

destroySession

@SynchronizedRpcRequest
void destroySession(CmsUUID sessionId,
                                            com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Destroys a session.

Parameters:

sessionId - the id of the session to destroy

callback - if something goes wrong

getContent

com.google.gwt.http.client.RequestBuilder getContent(CmsUUID sessionId,
                                                     com.google.gwt.user.client.rpc.AsyncCallback<CmsUgcContent> callback)

Returns the form content for an existing session.

Parameters:

sessionId - the id of the existing session

callback - the callback for the result

Returns:

the request builder for this RPC call

getLink

com.google.gwt.http.client.RequestBuilder getLink(java.lang.String path,
                                                  com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> resultCallback)

Gets the link corresponding to a given site path.

Parameters:

path - the site path

resultCallback - the callback for the result

Returns:

the request builder for the RPC call

saveContent

com.google.gwt.http.client.RequestBuilder saveContent(CmsUUID sessionId,
                                                      java.util.Map<java.lang.String,java.lang.String> contentValues,
                                                      com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,java.lang.String>> callback)

Saves the given content values to the edited content.

Parameters:

sessionId - the session id

contentValues - the content values

callback - the callback

Returns:

the request builder for this RPC call

uploadFiles

com.google.gwt.http.client.RequestBuilder uploadFiles(CmsUUID sessionId,
                                                      java.util.Set<java.lang.String> fieldNames,
                                                      java.lang.String formDataId,
                                                      com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,java.lang.String>> filenameCallback)

Uploads submitted file form fields to the VFS.

Parameters:

sessionId - the session id

fieldNames - the set of names of the form fields containing the uploads

formDataId - the form data id

filenameCallback - the callback to call with the resulting map from field names to file paths

Returns:

the request builder for this service method

validateContent

com.google.gwt.http.client.RequestBuilder validateContent(CmsUUID sessionId,
                                                          java.util.Map<java.lang.String,java.lang.String> values,
                                                          com.google.gwt.user.client.rpc.AsyncCallback<java.util.Map<java.lang.String,java.lang.String>> resultCallback)

Validates the new content values for a content loaded in the given session.

Parameters:

sessionId - the id of the session containing the content

values - the values to validate

resultCallback - the callback to call with the result

Returns:

the request builder for the RPC call