org.opencms.ade.contenteditor.shared.rpc
Interface I_CmsContentService

All Superinterfaces:

com.alkacon.acacia.shared.rpc.I_ContentService, com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

CmsContentService

public interface I_CmsContentService
extends com.alkacon.acacia.shared.rpc.I_ContentService

The content editor service interface.

Field Summary

static java.lang.String	DICT_CONTENT_DEFINITION The content definition dictionary name.
static java.lang.String	PARAM_BACKLINK The back-link parameter.

Method Summary

CmsContentDefinition	loadDefinition(java.lang.String entityId) Loads the content definition for a given entity.
CmsContentDefinition	loadDefinition(java.lang.String entityId, java.lang.String newLink, CmsUUID modelFileId, java.lang.String editContext) Loads the content definition for a given entity.
CmsContentDefinition	loadNewDefinition(java.lang.String entityId) Loads new entity definition.
CmsContentDefinition	prefetch() Returns the content definition of the resource requested through parameter 'resource'.
com.alkacon.acacia.shared.ValidationResult	saveAndDeleteEntities(java.util.List<com.alkacon.acacia.shared.Entity> changedEntities, java.util.List<java.lang.String> deletedEntities, boolean clearOnSuccess) Saves and deletes the given entities.

Methods inherited from interface com.alkacon.acacia.shared.rpc.I_ContentService

loadContentDefinition, saveEntities, saveEntity, validateEntities

Field Detail

DICT_CONTENT_DEFINITION

static final java.lang.String DICT_CONTENT_DEFINITION

The content definition dictionary name.

See Also:

Constant Field Values

PARAM_BACKLINK

static final java.lang.String PARAM_BACKLINK

The back-link parameter.

See Also:

Constant Field Values

Method Detail

loadDefinition

CmsContentDefinition loadDefinition(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 definition

Throws:

java.lang.Exception - if something goes wrong processing the request

loadDefinition

CmsContentDefinition loadDefinition(java.lang.String entityId,
                                    java.lang.String newLink,
                                    CmsUUID modelFileId,
                                    java.lang.String editContext)
                                    throws CmsRpcException

Loads the content definition for a given entity.

Parameters:

entityId - the entity id/URI

newLink - the new link

modelFileId - the optional model file id

editContext - the container page currently being edited (may be null)

Returns:

the content definition

Throws:

CmsRpcException - if something goes wrong processing the request

loadNewDefinition

CmsContentDefinition loadNewDefinition(java.lang.String entityId)
                                       throws CmsRpcException

Loads new entity definition.

This will load the entity representation of a new locale node.

Parameters:

entityId - the entity id/URI

Returns:

the content definition

Throws:

CmsRpcException - if something goes wrong processing the request

prefetch

CmsContentDefinition prefetch()
                              throws CmsRpcException

Returns the content definition of the resource requested through parameter 'resource'.

Returns:

the content definition

Throws:

CmsRpcException - if something goes wrong

saveAndDeleteEntities

com.alkacon.acacia.shared.ValidationResult saveAndDeleteEntities(java.util.List<com.alkacon.acacia.shared.Entity> changedEntities,
                                                                 java.util.List<java.lang.String> deletedEntities,
                                                                 boolean clearOnSuccess)
                                                                 throws CmsRpcException

Saves and deletes the given entities. Returns a validation result in case of invalid entities.

Parameters:

changedEntities - the changed entities

deletedEntities - the entity id's to delete

clearOnSuccess - true to unlock resource after saving

Returns:

the validation result in case of invalid entities

Throws:

CmsRpcException - if something goes wrong processing the request