Package com.priint.pubserverapi.parameter

Interface ParameterServiceLocal

public interface ParameterServiceLocal

Local interface for managing parameter definitions and dropdown elements in the system.

This service provides methods for creating, retrieving, updating, and deleting parameter definition, dropdown definition, dropdown value, and dropdown language entities.

All operations may throw ParameterServiceException if an error occurs during processing.

Method Summary

Modifier and Type	Method	Description
DropDownDefinitionId	createDropDownDefinition(DropDownDefinition dropdownDefinition)	Creates a new dropdown definition.
DropDownDefinitionQuery	createDropDownDefinitionQuery()	Creates a new DropDownDefinitionQuery for querying dropdown definitions.
DropDownLanguageId	createDropDownLanguage(DropDownLanguage dropDownLanguage)	Creates a new dropdown language.
DropDownLanguageQuery	createDropDownLanguageQuery()	Creates a new DropDownLanguageQuery for querying dropdown languages.
DropDownValueId	createDropDownValue(DropDownValue dropDownValue)	Creates a new dropdown value.
DropDownValueQuery	createDropDownValueQuery()	Creates a new DropDownValueQuery for querying dropdown values.
ParameterDefinitionId	createParameterDefinition(ParameterDefinition parameterDefinition)	Creates a new parameter definition.
ParameterDefinitionQuery	createParameterDefinitionQuery()	Creates a new ParameterDefinitionQuery for querying parameter definitions.
void	deleteDropDownDefinition(DropDownDefinitionId dropdownDefinitionId)	Deletes a dropdown definition by its ID.
void	deleteDropDownLanguage(DropDownLanguageId dropDownLanguageId)	Deletes a dropdown language by its ID.
void	deleteDropDownValue(DropDownValueId dropDownValueId)	Deletes a dropdown value by its ID.
void	deleteParameterDefinition(ParameterDefinitionId parameterDefinitionId, boolean permanently)	Deletes a parameter definition by its ID.
Optional<DropDownDefinition>	getDropDownDefinitionById(DropDownDefinitionId dropDownDefinitionId)	Retrieves a dropdown definition by its ID.
Optional<DropDownLanguage>	getDropDownLanguageById(DropDownLanguageId dropDownLanguageId)	Retrieves a DropDownLanguage by its ID.
Optional<DropDownValue>	getDropDownValueById(DropDownValueId dropDownValueId)	Retrieves a DropDownValue by its ID.
Optional<ParameterDefinition>	getParameterDefinitionById(ParameterDefinitionId parameterDefinitionId)	Retrieves a ParameterDefinition by its ID.
boolean	isParameterLinkedToDocuments(ParameterDefinitionId parameterDefinitionId)	Checks if a parameter definition is linked to documents.
boolean	isParameterLinkedToPublications(ParameterDefinitionId parameterDefinitionId)	Checks if a parameter definition is linked to publications.
void	updateDropDownDefinition(DropDownDefinition dropdownDefinition)	Updates an existing dropdown definition.
void	updateDropDownLanguage(DropDownLanguage dropDownLanguage)	Updates an existing dropdown language.
void	updateDropDownValue(DropDownValue dropDownValue)	Updates an existing dropdown value.
void	updateParameterDefinition(ParameterDefinition parameterDefinition)	Updates an existing parameter definition.

Method Details

getParameterDefinitionById

Optional<ParameterDefinition> getParameterDefinitionById(ParameterDefinitionId parameterDefinitionId)
                                                  throws ParameterServiceException

Retrieves a ParameterDefinition by its ID.

Parameters:

parameterDefinitionId - the ID of the parameter definition to retrieve

Returns:

an Optional containing the parameter definition if found, or empty if not

Throws:

ParameterServiceException - if an error occurs during retrieval

createParameterDefinitionQuery

ParameterDefinitionQuery createParameterDefinitionQuery()

Creates a new ParameterDefinitionQuery for querying parameter definitions.

Returns:

a new ParameterDefinitionQuery instance

updateParameterDefinition

void updateParameterDefinition(ParameterDefinition parameterDefinition)
                        throws ParameterServiceException

Updates an existing parameter definition.

Parameters:

parameterDefinition - the parameter definition to update

Throws:

ParameterServiceException - if an error occurs during the update

createParameterDefinition

ParameterDefinitionId createParameterDefinition(ParameterDefinition parameterDefinition)
                                         throws ParameterServiceException

Creates a new parameter definition.

Parameters:

parameterDefinition - the parameter definition to create

Returns:

the ID of the newly created parameter definition

Throws:

ParameterServiceException - if an error occurs during creation

deleteParameterDefinition

void deleteParameterDefinition(ParameterDefinitionId parameterDefinitionId,
 boolean permanently)
                        throws ParameterServiceException

Deletes a parameter definition by its ID.

Parameters:

parameterDefinitionId - the ID of the parameter definition to delete

permanently - whether to permanently delete the parameter definition

Throws:

ParameterServiceException - if an error occurs during deletion

getDropDownDefinitionById

Optional<DropDownDefinition> getDropDownDefinitionById(DropDownDefinitionId dropDownDefinitionId)
                                                throws ParameterServiceException

Retrieves a dropdown definition by its ID.

Parameters:

dropDownDefinitionId - the ID of the dropdown definition to retrieve

Returns:

an Optional containing the dropdown definition if found, or empty if not

Throws:

ParameterServiceException - if an error occurs during retrieval

createDropDownDefinitionQuery

DropDownDefinitionQuery createDropDownDefinitionQuery()

Creates a new DropDownDefinitionQuery for querying dropdown definitions.

Returns:

a new DropDownDefinitionQuery instance

createDropDownValueQuery

DropDownValueQuery createDropDownValueQuery()

Creates a new DropDownValueQuery for querying dropdown values.

Returns:

a new DropDownValueQuery instance

createDropDownLanguageQuery

DropDownLanguageQuery createDropDownLanguageQuery()

Creates a new DropDownLanguageQuery for querying dropdown languages.

Returns:

a new DropDownLanguageQuery instance

updateDropDownDefinition

void updateDropDownDefinition(DropDownDefinition dropdownDefinition)
                       throws ParameterServiceException

Updates an existing dropdown definition.

Parameters:

dropdownDefinition - the dropdown definition to update

Throws:

ParameterServiceException - if an error occurs during the update

getDropDownValueById

Optional<DropDownValue> getDropDownValueById(DropDownValueId dropDownValueId)
                                      throws ParameterServiceException

Retrieves a DropDownValue by its ID.

Parameters:

dropDownValueId - the ID of the dropdown value to retrieve

Returns:

an Optional containing the dropdown value if found, or empty if not

Throws:

ParameterServiceException - if an error occurs during retrieval

updateDropDownValue

void updateDropDownValue(DropDownValue dropDownValue)
                  throws ParameterServiceException

Updates an existing dropdown value.

Parameters:

dropDownValue - the dropdown value to update

Throws:

ParameterServiceException - if an error occurs during the update

getDropDownLanguageById

Optional<DropDownLanguage> getDropDownLanguageById(DropDownLanguageId dropDownLanguageId)
                                            throws ParameterServiceException

Retrieves a DropDownLanguage by its ID.

Parameters:

dropDownLanguageId - the ID of the dropdown language to retrieve

Returns:

an Optional containing the dropdown language if found, or empty if not

Throws:

ParameterServiceException - if an error occurs during retrieval

updateDropDownLanguage

void updateDropDownLanguage(DropDownLanguage dropDownLanguage)
                     throws ParameterServiceException

Updates an existing dropdown language.

Parameters:

dropDownLanguage - the dropdown language to update

Throws:

ParameterServiceException - if an error occurs during the update

createDropDownDefinition

DropDownDefinitionId createDropDownDefinition(DropDownDefinition dropdownDefinition)
                                       throws ParameterServiceException

Creates a new dropdown definition.

Parameters:

dropdownDefinition - the dropdown definition to create

Returns:

the ID of the newly created dropdown definition

Throws:

ParameterServiceException - if an error occurs during creation

createDropDownValue

DropDownValueId createDropDownValue(DropDownValue dropDownValue)
                             throws ParameterServiceException

Creates a new dropdown value.

Parameters:

dropDownValue - the dropdown value to create

Returns:

the ID of the newly created dropdown value

Throws:

ParameterServiceException - if an error occurs during creation

createDropDownLanguage

DropDownLanguageId createDropDownLanguage(DropDownLanguage dropDownLanguage)
                                   throws ParameterServiceException

Creates a new dropdown language.

Parameters:

dropDownLanguage - the dropdown language to create

Returns:

the ID of the newly created dropdown language

Throws:

ParameterServiceException - if an error occurs during creation

deleteDropDownDefinition

void deleteDropDownDefinition(DropDownDefinitionId dropdownDefinitionId)
                       throws ParameterServiceException

Deletes a dropdown definition by its ID.

Parameters:

dropdownDefinitionId - the ID of the dropdown definition to delete

Throws:

ParameterServiceException - if an error occurs during deletion

isParameterLinkedToDocuments

boolean isParameterLinkedToDocuments(ParameterDefinitionId parameterDefinitionId)

Checks if a parameter definition is linked to documents.

Parameters:

parameterDefinitionId - the ID of the parameter definition to check

Returns:

true if the parameter is linked to documents, false otherwise

isParameterLinkedToPublications

boolean isParameterLinkedToPublications(ParameterDefinitionId parameterDefinitionId)

Checks if a parameter definition is linked to publications.

Parameters:

parameterDefinitionId - the ID of the parameter definition to check

Returns:

true if the parameter is linked to publications, false otherwise

deleteDropDownValue

void deleteDropDownValue(DropDownValueId dropDownValueId)
                  throws ParameterServiceException

Deletes a dropdown value by its ID.

Parameters:

dropDownValueId - the ID of the dropdown value to delete

Throws:

ParameterServiceException - if an error occurs during deletion

deleteDropDownLanguage

void deleteDropDownLanguage(DropDownLanguageId dropDownLanguageId)
                     throws ParameterServiceException

Deletes a dropdown language by its ID.

Parameters:

dropDownLanguageId - the ID of the dropdown language to delete

Throws:

ParameterServiceException - if an error occurs during deletion