Package org.opencms.ugc.shared.rpc

Interface I_CmsUgcEditService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
CmsUgcEditService
public interface I_CmsUgcEditService extends com.google.gwt.user.client.rpc.RemoteService
The form edit service interface.

  • Method Details

    • destroySession

      void destroySession(CmsUUID sessionId) throws CmsRpcException
      Destroys the given session.

      Parameters:
      sessionId - the id of the session to destroy
      Throws:
      CmsRpcException - if something goes wrong

    • getContent

      CmsUgcContent getContent(CmsUUID sessionId) throws CmsRpcException
      Loads the form content for an existing session.

      Parameters:
      sessionId - the id of the existing session
      Returns:
      the form content information
      Throws:
      CmsRpcException - if something goes wrong

    • getLink

      String getLink(String path)
      Gets the link corresponding to a given site path.

      Parameters:
      path - the site path
      Returns:
      the link for the path

    • saveContent

      Map<String,String> saveContent(CmsUUID sessionId, Map<String,String> contentValues) throws CmsRpcException
      Saves the given content values to the edited content.

      Parameters:
      sessionId - the session id
      contentValues - the content values
      Returns:
      the validation errors, if there are any
      Throws:
      CmsRpcException - if something goes wrong

    • uploadFiles

      Map<String,String> uploadFiles(CmsUUID sessionId, Set<String> fieldNames, String formDataId) throws CmsRpcException
      Uploads multiple files.

      Parameters:
      sessionId - the session id
      fieldNames - the set of field names of the form fields containing the uploaded files
      formDataId - the form data id of the form submit in which the form fields were posted
      Returns:
      the map from field names to the VFS paths of uploaded files
      Throws:
      CmsRpcException - if something goes wrong

    • validateContent

      Map<String,String> validateContent(CmsUUID sessionId, Map<String,String> contentValues) throws CmsUgcException
      Validates the new content values for a content loaded in the given session.

      Parameters:
      sessionId - the id of the session containing the content
      contentValues - the values to validate
      Returns:
      the map of validation results
      Throws:
      CmsUgcException - if something goes wrong