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 Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void destroySession​(CmsUUID sessionId)
      Destroys the given session.
      CmsUgcContent getContent​(CmsUUID sessionId)
      Loads the form content for an existing session.
      java.lang.String getLink​(java.lang.String path)
      Gets the link corresponding to a given site path.
      java.util.Map<java.lang.String,​java.lang.String> saveContent​(CmsUUID sessionId, java.util.Map<java.lang.String,​java.lang.String> contentValues)
      Saves the given content values to the edited content.
      java.util.Map<java.lang.String,​java.lang.String> uploadFiles​(CmsUUID sessionId, java.util.Set<java.lang.String> fieldNames, java.lang.String formDataId)
      Uploads multiple files.
      java.util.Map<java.lang.String,​java.lang.String> validateContent​(CmsUUID sessionId, java.util.Map<java.lang.String,​java.lang.String> contentValues)
      Validates the new content values for a content loaded in the given session.

    • Method Detail

      • getLink

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

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

      • saveContent

        java.util.Map<java.lang.String,​java.lang.String> saveContent​(CmsUUID sessionId,
                                                                   java.util.Map<java.lang.String,​java.lang.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

        java.util.Map<java.lang.String,​java.lang.String> uploadFiles​(CmsUUID sessionId,
                                                                   java.util.Set<java.lang.String> fieldNames,
                                                                   java.lang.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

        java.util.Map<java.lang.String,​java.lang.String> validateContent​(CmsUUID sessionId,
                                                                       java.util.Map<java.lang.String,​java.lang.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