Package io.camunda.optimize.service.db.writer

Interface CollectionWriter

All Known Implementing Classes:

CollectionWriterES, CollectionWriterOS

public interface CollectionWriter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_ROLE_TO_COLLECTION_SCRIPT_CODE
static final String	DEFAULT_COLLECTION_NAME
static final org.slf4j.Logger	LOG
static final String	REMOVE_ROLE_FROM_COLLECTION_SCRIPT_CODE
static final String	REMOVE_ROLE_FROM_COLLECTION_UNLESS_IS_LAST_MANAGER
static final String	REMOVE_SCOPE_ENTRIES_SCRIPT_CODE
static final String	REMOVE_SCOPE_ENTRY_FROM_COLLECTION_SCRIPT_CODE
static final String	REMOVE_SCOPE_ENTRY_SCRIPT_CODE
static final String	UPDATE_ENTITY_SCRIPT_CODE
static final String	UPDATE_ROLE_IN_COLLECTION_SCRIPT_CODE
static final String	UPDATE_SCOPE_ENTITY_SCRIPT_CODE

Method Summary

Modifier and Type	Method	Description
void	addRoleToCollection(String collectionId, List<CollectionRoleRequestDto> rolesToAdd, String userId)
void	addScopeEntriesToCollection(String userId, String collectionId, List<CollectionScopeEntryDto> scopeUpdates)
default void	createNewCollection(CollectionDefinitionDto collectionDefinitionDto)
default IdResponseDto	createNewCollectionAndReturnId(String userId, PartialCollectionDefinitionRequestDto partialCollectionDefinitionDto)
default IdResponseDto	createNewCollectionAndReturnId(String userId, PartialCollectionDefinitionRequestDto partialCollectionDefinitionDto, String id, boolean automaticallyCreated)
void	deleteCollection(String collectionId)
void	deleteScopeEntryFromAllCollections(String scopeEntryId)
void	persistCollection(String id, CollectionDefinitionDto collectionDefinitionDto)
void	removeRoleFromCollectionUnlessIsLastManager(String collectionId, String roleEntryId, String userId)
void	removeScopeEntries(String collectionId, List<String> scopeEntryIds, String userId)
void	removeScopeEntry(String collectionId, String scopeEntryId, String userId)
void	updateCollection(CollectionDefinitionUpdateDto collection, String id)
void	updateRoleInCollection(String collectionId, String roleEntryId, CollectionRoleUpdateRequestDto roleUpdateDto, String userId)
void	updateScopeEntity(String collectionId, CollectionScopeEntryUpdateDto scopeEntry, String userId, String scopeEntryId)

Field Details

DEFAULT_COLLECTION_NAME

static final String DEFAULT_COLLECTION_NAME

See Also:

• Constant Field Values

UPDATE_ENTITY_SCRIPT_CODE

static final String UPDATE_ENTITY_SCRIPT_CODE

See Also:

• Constant Field Values

REMOVE_SCOPE_ENTRY_FROM_COLLECTION_SCRIPT_CODE

static final String REMOVE_SCOPE_ENTRY_FROM_COLLECTION_SCRIPT_CODE

See Also:

• Constant Field Values

REMOVE_SCOPE_ENTRY_SCRIPT_CODE

static final String REMOVE_SCOPE_ENTRY_SCRIPT_CODE

See Also:

• Constant Field Values

REMOVE_SCOPE_ENTRIES_SCRIPT_CODE

static final String REMOVE_SCOPE_ENTRIES_SCRIPT_CODE

See Also:

• Constant Field Values

UPDATE_SCOPE_ENTITY_SCRIPT_CODE

static final String UPDATE_SCOPE_ENTITY_SCRIPT_CODE

See Also:

• Constant Field Values

ADD_ROLE_TO_COLLECTION_SCRIPT_CODE

static final String ADD_ROLE_TO_COLLECTION_SCRIPT_CODE

See Also:

• Constant Field Values

UPDATE_ROLE_IN_COLLECTION_SCRIPT_CODE

static final String UPDATE_ROLE_IN_COLLECTION_SCRIPT_CODE

See Also:

• Constant Field Values

REMOVE_ROLE_FROM_COLLECTION_SCRIPT_CODE

static final String REMOVE_ROLE_FROM_COLLECTION_SCRIPT_CODE

See Also:

• Constant Field Values

REMOVE_ROLE_FROM_COLLECTION_UNLESS_IS_LAST_MANAGER

static final String REMOVE_ROLE_FROM_COLLECTION_UNLESS_IS_LAST_MANAGER

See Also:

• Constant Field Values

LOG

static final org.slf4j.Logger LOG

Method Details

createNewCollectionAndReturnId

default IdResponseDto createNewCollectionAndReturnId(String userId,
 PartialCollectionDefinitionRequestDto partialCollectionDefinitionDto)

createNewCollectionAndReturnId

default IdResponseDto createNewCollectionAndReturnId(String userId,
 PartialCollectionDefinitionRequestDto partialCollectionDefinitionDto,
 String id,
 boolean automaticallyCreated)

createNewCollection

default void createNewCollection(CollectionDefinitionDto collectionDefinitionDto)

updateCollection

void updateCollection(CollectionDefinitionUpdateDto collection,
 String id)

deleteCollection

void deleteCollection(String collectionId)

addScopeEntriesToCollection

void addScopeEntriesToCollection(String userId,
 String collectionId,
 List<CollectionScopeEntryDto> scopeUpdates)

deleteScopeEntryFromAllCollections

void deleteScopeEntryFromAllCollections(String scopeEntryId)

updateScopeEntity

void updateScopeEntity(String collectionId,
 CollectionScopeEntryUpdateDto scopeEntry,
 String userId,
 String scopeEntryId)

removeScopeEntries

void removeScopeEntries(String collectionId,
 List<String> scopeEntryIds,
 String userId)
                 throws NotFoundException

Throws:

NotFoundException

removeScopeEntry

void removeScopeEntry(String collectionId,
 String scopeEntryId,
 String userId)
               throws NotFoundException

Throws:

NotFoundException

addRoleToCollection

void addRoleToCollection(String collectionId,
 List<CollectionRoleRequestDto> rolesToAdd,
 String userId)

updateRoleInCollection

void updateRoleInCollection(String collectionId,
 String roleEntryId,
 CollectionRoleUpdateRequestDto roleUpdateDto,
 String userId)

removeRoleFromCollectionUnlessIsLastManager

void removeRoleFromCollectionUnlessIsLastManager(String collectionId,
 String roleEntryId,
 String userId)

persistCollection

void persistCollection(String id,
 CollectionDefinitionDto collectionDefinitionDto)