Package org.opencms.acacia.client.entity
Interface I_CmsEntityBackend
-
- All Known Implementing Classes:
CmsEntityBackend
public interface I_CmsEntityBackend
The interface for VIE implementations.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
changeEntityContentValues(org.opencms.acacia.shared.CmsEntity original, org.opencms.acacia.shared.CmsEntity newContent)
Changes the original entities content to the given new content.void
clearEntities()
Clears all entities from VIE.org.opencms.acacia.shared.CmsEntity
createEntity(java.lang.String entityId, java.lang.String entityType)
Creates a new entity registering it within VIE.org.opencms.acacia.shared.CmsType
createType(java.lang.String id)
Creates a new type.java.util.List<com.google.gwt.dom.client.Element>
getAttributeElements(java.lang.String entityId, java.lang.String attributeName, com.google.gwt.dom.client.Element context)
Returns DOM elements displaying the given attribute's value.java.util.List<com.google.gwt.dom.client.Element>
getAttributeElements(org.opencms.acacia.shared.CmsEntity entity, java.lang.String attributeName, com.google.gwt.dom.client.Element context)
Returns DOM elements displaying the given attribute's value.org.opencms.acacia.shared.CmsEntity
getEntity(java.lang.String entityId)
Returns the entity with the given id.org.opencms.acacia.shared.CmsType
getType(java.lang.String id)
Returns the type with the given id/name.org.opencms.acacia.shared.CmsEntity
registerEntity(org.opencms.acacia.shared.CmsEntity entity)
Registers the given entity within the VIE model.org.opencms.acacia.shared.CmsEntity
registerEntity(org.opencms.acacia.shared.CmsEntity entity, boolean discardIds)
Registers the given entity within the VIE model.void
registerTypes(org.opencms.acacia.shared.CmsType type, java.util.Map<java.lang.String,org.opencms.acacia.shared.CmsType> types)
Registers the type and it's sub-types.void
removeEntity(java.lang.String entityId)
Removes the given entity from VIE.
-
-
-
Method Detail
-
changeEntityContentValues
void changeEntityContentValues(org.opencms.acacia.shared.CmsEntity original, org.opencms.acacia.shared.CmsEntity newContent)
Changes the original entities content to the given new content.- Parameters:
original
- the original entity to changenewContent
- the new content entity
-
clearEntities
void clearEntities()
Clears all entities from VIE.
-
createEntity
org.opencms.acacia.shared.CmsEntity createEntity(java.lang.String entityId, java.lang.String entityType)
Creates a new entity registering it within VIE.- Parameters:
entityId
- the entity identityType
- the entity type- Returns:
- the new entity
-
createType
org.opencms.acacia.shared.CmsType createType(java.lang.String id)
Creates a new type.- Parameters:
id
- the type id/name- Returns:
- the new type
-
getAttributeElements
java.util.List<com.google.gwt.dom.client.Element> getAttributeElements(org.opencms.acacia.shared.CmsEntity entity, java.lang.String attributeName, com.google.gwt.dom.client.Element context)
Returns DOM elements displaying the given attribute's value.- Parameters:
entity
- the entityattributeName
- the attribute namecontext
- the context to search within- Returns:
- the elements
-
getAttributeElements
java.util.List<com.google.gwt.dom.client.Element> getAttributeElements(java.lang.String entityId, java.lang.String attributeName, com.google.gwt.dom.client.Element context)
Returns DOM elements displaying the given attribute's value.- Parameters:
entityId
- the entity id/subjectattributeName
- the attribute namecontext
- the context to search within- Returns:
- the elements
-
getEntity
org.opencms.acacia.shared.CmsEntity getEntity(java.lang.String entityId)
Returns the entity with the given id.- Parameters:
entityId
- the entity id- Returns:
- the entity
-
getType
org.opencms.acacia.shared.CmsType getType(java.lang.String id)
Returns the type with the given id/name.- Parameters:
id
- the type id/name- Returns:
- the type
-
registerEntity
org.opencms.acacia.shared.CmsEntity registerEntity(org.opencms.acacia.shared.CmsEntity entity)
Registers the given entity within the VIE model.- Parameters:
entity
- the entity to register- Returns:
- the new registered entity object
-
registerEntity
org.opencms.acacia.shared.CmsEntity registerEntity(org.opencms.acacia.shared.CmsEntity entity, boolean discardIds)
Registers the given entity within the VIE model.- Parameters:
entity
- the entity to registerdiscardIds
-true
to discard the entity ids and generate ids- Returns:
- the new registered entity object
-
registerTypes
void registerTypes(org.opencms.acacia.shared.CmsType type, java.util.Map<java.lang.String,org.opencms.acacia.shared.CmsType> types)
Registers the type and it's sub-types.- Parameters:
type
- the type to registertypes
- the available types
-
removeEntity
void removeEntity(java.lang.String entityId)
Removes the given entity from VIE.- Parameters:
entityId
- the entity id
-
-