Package org.opencms.acacia.shared.rpc

Interface I_CmsContentService

  • All Superinterfaces:
    com.google.gwt.user.client.rpc.RemoteService
    All Known Subinterfaces:
    I_CmsContentService
    All Known Implementing Classes:
    CmsContentService
    public interface I_CmsContentService
extends com.google.gwt.user.client.rpc.RemoteService
    The content service used to load and persist entity and type information.

    Implement this on the server side.

    • Method Detail

      • loadContentDefinition

        CmsContentDefinition loadContentDefinition​(java.lang.String entityId)
                                    throws java.lang.Exception
        Loads the content definition for a given entity.

        Parameters:
        entityId - the entity id/URI
        Returns:
        the content type definition
        Throws:
        java.lang.Exception - if something goes wrong processing the request

      • saveEntities

        CmsValidationResult saveEntities​(java.util.List<CmsEntity> entities)
                          throws java.lang.Exception
        Saves the given entities and returns a validation result in case of invalid entities.

        Invalid entities will not be saved.

        Parameters:
        entities - the entities to save
        Returns:
        the validation result in case of invalid entities
        Throws:
        java.lang.Exception - if something goes wrong processing the request

      • saveEntity

        CmsValidationResult saveEntity​(CmsEntity entity)
                        throws java.lang.Exception
        Saves the given entity and returns a validation result in case of invalid entities.

        Invalid entities will not be saved.

        Parameters:
        entity - the entity to save
        Returns:
        the validation result in case of invalid entities
        Throws:
        java.lang.Exception - if something goes wrong processing the request

      • updateEntityHtml

        CmsEntityHtml updateEntityHtml​(CmsEntity entity,
                               java.lang.String contextUri,
                               java.lang.String htmlContextInfo)
                        throws java.lang.Exception
        Retrieves the updated entity HTML representation.

        The entity data will be validated but not persisted on the server.

        Parameters:
        entity - the entity
        contextUri - the context URI
        htmlContextInfo - information about the HTML context
        Returns:
        the HTML representation including the validation result
        Throws:
        java.lang.Exception - if something goes wrong processing the request

      • validateEntity

        CmsValidationResult validateEntity​(CmsEntity changedEntity)
                            throws java.lang.Exception
        Validates the given entity and returns maps of error and warning messages in case of invalid attributes.

        Parameters:
        changedEntity - the entity to validate
        Returns:
        the validation result
        Throws:
        java.lang.Exception - if something goes wrong processing the request