org.opencms.ade.contenteditor.shared.rpc

接口 I_CmsContentService

所有超级接口:

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

所有已知实现类:

CmsContentService

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

The content editor service interface.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DICT_CONTENT_DEFINITION The content definition dictionary name.
static java.lang.String	PARAM_BACKLINK The back-link parameter.

方法概要

方法

限定符和类型	方法和说明
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.

从接口继承的方法 com.alkacon.acacia.shared.rpc.I_ContentService

loadContentDefinition, saveEntities, saveEntity, updateEntityHtml, validateEntities

字段详细资料

DICT_CONTENT_DEFINITION

static final java.lang.String DICT_CONTENT_DEFINITION

The content definition dictionary name.

另请参阅:

常量字段值

PARAM_BACKLINK

static final java.lang.String PARAM_BACKLINK

The back-link parameter.

另请参阅:

常量字段值

方法详细资料

loadDefinition

CmsContentDefinition loadDefinition(java.lang.String entityId)
                                    throws java.lang.Exception

Loads the content definition for a given entity.

参数:

entityId - the entity id/URI

返回:

the content definition

抛出:

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.

参数:

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)

返回:

the content definition

抛出:

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.

参数:

entityId - the entity id/URI

返回:

the content definition

抛出:

CmsRpcException - if something goes wrong processing the request

prefetch

CmsContentDefinition prefetch()
                              throws CmsRpcException

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

返回:

the content definition

抛出:

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.

参数:

changedEntities - the changed entities

deletedEntities - the entity id's to delete

clearOnSuccess - true to unlock resource after saving

返回:

the validation result in case of invalid entities

抛出:

CmsRpcException - if something goes wrong processing the request