Interface InternalEntityDocumentsService

All Superinterfaces:

EntityDocumentsService

All Known Implementing Classes:

EntityDocumentsServiceImpl

public interface InternalEntityDocumentsService
extends EntityDocumentsService

Method Summary

Modifier and Type	Method	Description
FolderNode	createEntityDocumentsFolder(Entity entity, FolderNode parentFolder)	Create an entity's document folder.
FolderNode	ensureEntityModelFolder(EntityModel entityModel)
FolderNode	getOrCreateEntityDocumentsFolder(Entity entity)	Get or create an entity's document folder.
void	removeRelatedEntity(ContentTreeNode contentTreeNode)	Remove the related entity from the ContentTreeNode
void	setRelatedEntity(ContentTreeNode contentTreeNode, Entity entity)	Set a related entity for the ContentTreeNode

Methods inherited from interface EntityDocumentsService

addTimestampToFilename, createEntityDocumentsInvoker, getDetailDocumentFileName, getDetailDocumentForField, getEntityDocumentsFolder, getEntityModelFolder, getEntityModelFolder, getRelatedEntity, getRelatedEntityRelationName, getSystemDomain, isEntityDetailDocument, isEntityDetailDocument, isEntityDocument, isEntityDocument, isEntityDocumentFolder, isEntityDocumentFolder, isEntityModelFolder, isEntityRootFolder, isRelationToRelatedEntity

Method Details

setRelatedEntity

void setRelatedEntity(ContentTreeNode contentTreeNode,
 Entity entity)
               throws EntityDocumentsException

Set a related entity for the ContentTreeNode

Parameters:

contentTreeNode - ContentTreeNode

entity - a reference entity (there needs to exist a relation rel[Entity model name] from the ContentTreeNode)

Throws:

EntityDocumentsException

removeRelatedEntity

void removeRelatedEntity(ContentTreeNode contentTreeNode)
                  throws EntityDocumentsException

Remove the related entity from the ContentTreeNode

Parameters:

contentTreeNode - ContentTreeNode

Throws:

EntityDocumentsException

getOrCreateEntityDocumentsFolder

FolderNode getOrCreateEntityDocumentsFolder(Entity entity)
                                     throws EntityDocumentsException

Get or create an entity's document folder. It also creates potential required sub-folders (e.g. language folders for multi-language entities).

Parameters:

entity - the entity

Returns:

entity's document folder

Throws:

EntityDocumentsException

ensureEntityModelFolder

FolderNode ensureEntityModelFolder(EntityModel entityModel)
                            throws EntityDocumentsException

Throws:

EntityDocumentsException

createEntityDocumentsFolder

FolderNode createEntityDocumentsFolder(Entity entity,
 FolderNode parentFolder)
                                throws EntityDocumentsException

Create an entity's document folder. It also creates potential required sub-folders (e.g. language folders for multi-language entities).

Parameters:

entity - the entity

parentFolder - the parent folder, i.e. the model's folder

Returns:

entity's document folder

Throws:

EntityDocumentsException

See Also:

• getOrCreateEntityDocumentsFolder(Entity)