Package net.datenwerke.rs.uservariables.client.uservariables.rpc

Interface UserVariablesRpcService

All Known Implementing Classes:

UserVariablesRpcServiceImpl

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

public interface UserVariablesRpcService

Method Summary

Modifier and Type	Method	Description
UserVariableDefinitionDto	addUserVariableDefinition(UserVariableDefinitionDto definition)	Adds a new user variable to the list of available variables.
List<UserVariableInstanceDto>	addUserVariableInstances(List<UserVariableDefinitionDto> definitionDto, AbstractUserManagerNodeDto nodeDto)
<any>	getDefinedUserVariableDefinitions()	Returns all defined variables.
List<UserVariableInstanceDto>	getDefinedUserVariableInstances(AbstractUserManagerNodeDto nodeDto)	Returns the instances for a given node.
List<UserVariableInstanceDto>	getInheritedUserVariableInstances(AbstractUserManagerNodeDto nodeDto)	Returns the inherited instances for a given node.
void	removeUserVariableDefinitions(Collection<UserVariableDefinitionDto> definition, boolean force)
void	removeUserVariableInstances(Collection<UserVariableInstanceDto> instanceDto)
UserVariableDefinitionDto	updateUserVariableDefinition(UserVariableDefinitionDto definition)	Changes the definition of a user variable in the list of available variables.
UserVariableInstanceDto	updateUserVariableInstance(UserVariableInstanceDto instanceDto)

Method Details

addUserVariableInstances

List<UserVariableInstanceDto> addUserVariableInstances(List<UserVariableDefinitionDto> definitionDto,
 AbstractUserManagerNodeDto nodeDto)
                                                throws ServerCallFailedException

Throws:

ServerCallFailedException

updateUserVariableInstance

UserVariableInstanceDto updateUserVariableInstance(UserVariableInstanceDto instanceDto)
                                            throws ServerCallFailedException

Throws:

ServerCallFailedException

removeUserVariableInstances

void removeUserVariableInstances(Collection<UserVariableInstanceDto> instanceDto)
                          throws ServerCallFailedException

Throws:

ServerCallFailedException

addUserVariableDefinition

UserVariableDefinitionDto addUserVariableDefinition(UserVariableDefinitionDto definition)
                                             throws ServerCallFailedException

Adds a new user variable to the list of available variables.

Parameters:

definition -

Throws:

ServerCallFailedException

updateUserVariableDefinition

UserVariableDefinitionDto updateUserVariableDefinition(UserVariableDefinitionDto definition)
                                                throws ServerCallFailedException

Changes the definition of a user variable in the list of available variables.

Parameters:

definition -

Throws:

ServerCallFailedException

removeUserVariableDefinitions

void removeUserVariableDefinitions(Collection<UserVariableDefinitionDto> definition,
 boolean force)
                            throws ServerCallFailedException

Throws:

ServerCallFailedException

getDefinedUserVariableDefinitions

<any> getDefinedUserVariableDefinitions()
                                 throws ServerCallFailedException

Returns all defined variables.

Throws:

ServerCallFailedException

getDefinedUserVariableInstances

List<UserVariableInstanceDto> getDefinedUserVariableInstances(AbstractUserManagerNodeDto nodeDto)
                                                       throws ServerCallFailedException

Returns the instances for a given node.

Parameters:

nodeDto -

Throws:

ServerCallFailedException

getInheritedUserVariableInstances

List<UserVariableInstanceDto> getInheritedUserVariableInstances(AbstractUserManagerNodeDto nodeDto)
                                                         throws ServerCallFailedException

Returns the inherited instances for a given node.

Parameters:

nodeDto -

Throws:

ServerCallFailedException