Package io.dialob.form.service.api

Interface FormVersionControlDatabase

public interface FormVersionControlDatabase

Form database with version control support

Method Summary

Modifier and Type	Method	Description
String	createSnapshot(String tenantId, String formId)	Creates copy of form document and returns id of new form.
Optional<io.dialob.api.form.FormTag>	createTag(String tenantId, String formName, String tag, String description, String formDocumentIdOrRefName, io.dialob.api.form.FormTag.Type type)
Optional<io.dialob.api.form.FormTag>	createTagOnLatest(String tenantId, String formName, String tag, String description, boolean snapshot)
boolean	delete(String tenantId, String formName)
boolean	deleteTag(String tenantId, String formName, String tag)
Optional<io.dialob.api.form.FormTag>	findTag(String tenantId, String formName, String name)
List<io.dialob.api.form.FormTag>	findTags(String tenantId, String formId, io.dialob.api.form.FormTag.Type type)
FormDatabase	getFormDatabase()	Get form database service without version control support
boolean	isName(String tenantId, String formId)
Optional<io.dialob.api.form.FormTag>	moveTag(String tenantId, io.dialob.api.form.FormTag updateTag)
List<io.dialob.api.form.FormTag>	queryTags(String tenantId, String formName, String formId, String name, io.dialob.api.form.FormTag.Type type)
boolean	updateLabel(String tenantId, String formName, String label)
boolean	updateLatest(String tenantId, String formId, io.dialob.api.form.FormTag tag)

Method Detail

getFormDatabase

@Nonnull
FormDatabase getFormDatabase()

Get form database service without version control support

Returns:

form database service

createTagOnLatest

Optional<io.dialob.api.form.FormTag> createTagOnLatest(String tenantId,
                                                       @Nonnull
                                                       String formName,
                                                       String tag,
                                                       String description,
                                                       boolean snapshot)

Parameters:

tenantId -

formName -

tag -

description -

snapshot - create snapshot of form before tagging

Returns:

delete

boolean delete(String tenantId,
               @Nonnull
               String formName)

deleteTag

boolean deleteTag(String tenantId,
                  @Nonnull
                  String formName,
                  String tag)

createTag

Optional<io.dialob.api.form.FormTag> createTag(String tenantId,
                                               @Nonnull
                                               String formName,
                                               String tag,
                                               String description,
                                               String formDocumentIdOrRefName,
                                               @Nonnull
                                               io.dialob.api.form.FormTag.Type type)

updateLabel

boolean updateLabel(String tenantId,
                    @Nonnull
                    String formName,
                    String label)

createSnapshot

String createSnapshot(String tenantId,
                      @Nonnull
                      String formId)

Creates copy of form document and returns id of new form.

Parameters:

tenantId -

formId -

Returns:

formId of new copy

isName

boolean isName(String tenantId,
               @Nonnull
               String formId)

Returns:

true when formId is not form document id, but name.

findTags

@Nonnull
List<io.dialob.api.form.FormTag> findTags(String tenantId,
                                          @Nonnull
                                          String formId,
                                          @Nullable
                                          io.dialob.api.form.FormTag.Type type)

findTag

Optional<io.dialob.api.form.FormTag> findTag(String tenantId,
                                             @Nonnull
                                             String formName,
                                             @Nullable
                                             String name)

updateLatest

boolean updateLatest(String tenantId,
                     @Nonnull
                     String formId,
                     @Nonnull
                     io.dialob.api.form.FormTag tag)

queryTags

@Nonnull
List<io.dialob.api.form.FormTag> queryTags(String tenantId,
                                           String formName,
                                           String formId,
                                           String name,
                                           io.dialob.api.form.FormTag.Type type)

moveTag

Optional<io.dialob.api.form.FormTag> moveTag(String tenantId,
                                             io.dialob.api.form.FormTag updateTag)

Parameters:

tenantId -

updateTag -

Returns: