com.edorasware.commons.core.maintenance

Interface MaintenanceService

All Known Implementing Classes:

DefaultMaintenanceService

public interface MaintenanceService

Method Summary

Modifier and Type	Method and Description
void	deleteHiddenWorkObjectVariable(String workObjectId, String variableName) Deletes a hidden work object variable.
void	deleteWorkObjectDefinition(String definitionId) Deletes the work object definition with the given id.
void	deleteWorkObjectDefinitionProperties(Collection<Property> properties) Deletes all specified work object definition properties.
void	deleteWorkObjectDefinitionsResourceString(Collection<String> workObjectDefinitionIds) Set resource string in work object definition to null.
void	insertWorkObjectDefinitionProperties(Collection<Property> properties) Inserts all specified work object definition properties.
void	updateDefinitionKey(String definitionId, String newDefinitionKey) Updates the definition key.
void	updateDefinitionProperties(PropertyName<String> propertyName, String oldValue, String newValue) Updates all definition properties with the given name and value.
void	updateTypeOfAnyWorkObjects(Set<String> anyGearWorkObjectIds, String newType) Updates the Type of the work objects with the given WorkObjectIds with the given new type.
void	updateWorkObjectDefinitionIdOnWorkObjects(Set<String> currentWorkObjectDefinitionIds, String newWorkObjectDefinitionId) Sets the specified new work object definition id on all work objects which point to one of the given current work object definition ids.
void	updateWorkObjectGlobalId(String workObjectId, String newGlobalId) Sets the work object global id on a specific work object.
void	updateWorkObjectVariables() Updates all work object variables by reading them and writing them again.

Method Detail

updateWorkObjectGlobalId

void updateWorkObjectGlobalId(String workObjectId,
                              String newGlobalId)

Sets the work object global id on a specific work object.

Parameters:

workObjectId - the work object id of the work object to be updated

newGlobalId - the new work object global id

Throws:

IllegalArgumentException - if the parameters are not valid

updateWorkObjectDefinitionIdOnWorkObjects

void updateWorkObjectDefinitionIdOnWorkObjects(Set<String> currentWorkObjectDefinitionIds,
                                               String newWorkObjectDefinitionId)

Sets the specified new work object definition id on all work objects which point to one of the given current work object definition ids.

Parameters:

currentWorkObjectDefinitionIds - the work object definition ids of those work objects that need to be updated

newWorkObjectDefinitionId - the new work object definition id to set on the matching work objects

Throws:

IllegalArgumentException - if the parameters are not valid

updateWorkObjectVariables

void updateWorkObjectVariables()

Updates all work object variables by reading them and writing them again. This ensures that the latest variable converters are applied on the write-operation.

deleteHiddenWorkObjectVariable

void deleteHiddenWorkObjectVariable(String workObjectId,
                                    String variableName)

Deletes a hidden work object variable.

updateTypeOfAnyWorkObjects

void updateTypeOfAnyWorkObjects(Set<String> anyGearWorkObjectIds,
                                String newType)

Updates the Type of the work objects with the given WorkObjectIds with the given new type. This only works for AnyWorkObjects.

Parameters:

anyGearWorkObjectIds - the ids of the AnyWorkObjects for which to change the type

newType - the new work object type

deleteWorkObjectDefinitionsResourceString

void deleteWorkObjectDefinitionsResourceString(Collection<String> workObjectDefinitionIds)

Set resource string in work object definition to null.

Parameters:

workObjectDefinitionIds - the work object definitions to update resource string in

Throws:

IllegalArgumentException - if the workObjectDefinitionIds parameter is not valid or if the id of a work object definition is not defined

insertWorkObjectDefinitionProperties

void insertWorkObjectDefinitionProperties(Collection<Property> properties)

Inserts all specified work object definition properties.

Parameters:

properties - the properties to insert

Throws:

IllegalArgumentException - if the properties parameter is not valid or if the source of a property is not defined

deleteWorkObjectDefinitionProperties

void deleteWorkObjectDefinitionProperties(Collection<Property> properties)

Deletes all specified work object definition properties.

Parameters:

properties - the properties to delete

Throws:

IllegalArgumentException - if the properties parameter is not valid or if the id of a property is not defined

deleteWorkObjectDefinition

void deleteWorkObjectDefinition(String definitionId)

Deletes the work object definition with the given id. It first deletes the properties which have the given #definitionId as parent and then removes the definition itself.

Parameters:

definitionId - the id of the definition to delete

Throws:

IllegalArgumentException - if the given definition id is null or empty

updateDefinitionProperties

void updateDefinitionProperties(PropertyName<String> propertyName,
                                String oldValue,
                                String newValue)

Updates all definition properties with the given name and value.

Parameters:

propertyName - the property name to be updated

oldValue - the old property value to be replaced

newValue - the new property value

updateDefinitionKey

void updateDefinitionKey(String definitionId,
                         String newDefinitionKey)

Updates the definition key.

Parameters:

definitionId - the definition ID to be updated

newDefinitionKey - the new definition key