com.qcadoo.view.api.utils

Class NumberGeneratorService

java.lang.Object

com.qcadoo.view.api.utils.NumberGeneratorService

@Service
public class NumberGeneratorService
extends Object

Helper service for automatically generating numbers for entities

Since:

0.4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NUM_OF_DIGITS
static String	DEFAULT_NUMBER_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
NumberGeneratorService()

Method Summary

Modifier and Type	Method and Description
boolean	checkIfShouldInsertNumber(ViewDefinitionState state, String formFieldReferenceName, String numberFieldReferenceName) Checks if new entity number should be generated and inserted
void	generateAndInsertNumber(ViewDefinitionState state, String plugin, String entityName, String formFieldReferenceName, String numberFieldReferenceName) Generates and inserts new number to entity's form
String	generateNumber(String pluginIdentifier, String modelName) Generate new 6-digits number of entity
String	generateNumber(String pluginIdentifier, String modelName, int numOfDigits) Generate new number of entity with specified digits number
String	generateNumberWithPrefix(String pluginIdentifier, String modelName, int numOfDigits, String prefix) Generate new number of entity with specified digits number
String	generateNumberWithSuffix(String pluginIdentifier, String modelName, int numOfDigits, String suffix, String numberFieldName) Generate new number of entity with specified digits number

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NUM_OF_DIGITS

public static final int DEFAULT_NUM_OF_DIGITS

See Also:

Constant Field Values

DEFAULT_NUMBER_FIELD_NAME

public static final String DEFAULT_NUMBER_FIELD_NAME

See Also:

Constant Field Values

Constructor Detail

NumberGeneratorService

public NumberGeneratorService()

Method Detail

checkIfShouldInsertNumber

public boolean checkIfShouldInsertNumber(ViewDefinitionState state,
                                         String formFieldReferenceName,
                                         String numberFieldReferenceName)

Checks if new entity number should be generated and inserted

Parameters:

state - main view state definition

formFieldReferenceName - reference name of form

numberFieldReferenceName - reference name of field into which generated number should be inserted

Returns:

true if new entity number should be generated and inserted

generateAndInsertNumber

public void generateAndInsertNumber(ViewDefinitionState state,
                                    String plugin,
                                    String entityName,
                                    String formFieldReferenceName,
                                    String numberFieldReferenceName)

Generates and inserts new number to entity's form

Parameters:

state - main view state definition

plugin - plugin identifier of entity

entityName - name of entity

formFieldReferenceName - reference name of form

numberFieldReferenceName - reference name of field into which generated number should be inserted

generateNumber

public String generateNumber(String pluginIdentifier,
                             String modelName)

Generate new 6-digits number of entity

Parameters:

pluginIdentifier - plugin identifier of entity

modelName - name of entity

Returns:

new number of entity

generateNumber

public String generateNumber(String pluginIdentifier,
                             String modelName,
                             int numOfDigits)

Generate new number of entity with specified digits number

Parameters:

pluginIdentifier - plugin identifier of entity

modelName - name of entity

numOfDigits - number of digits of generated number

Returns:

new number of entity

generateNumberWithPrefix

public String generateNumberWithPrefix(String pluginIdentifier,
                                       String modelName,
                                       int numOfDigits,
                                       String prefix)

Generate new number of entity with specified digits number

Parameters:

pluginIdentifier - plugin identifier of entity

modelName - name of entity

numOfDigits - number of digits of generated number

prefix - number prefix

Returns:

new number of entity

generateNumberWithSuffix

public String generateNumberWithSuffix(String pluginIdentifier,
                                       String modelName,
                                       int numOfDigits,
                                       String suffix,
                                       String numberFieldName)

Generate new number of entity with specified digits number

Parameters:

pluginIdentifier - plugin identifier of entity

modelName - name of entity

numOfDigits - number of digits of generated number

suffix - number suffix

Returns:

new number of entity