Uses of Class
org.pipservices3.commons.run.Parameters

Packages that use Parameters

Package	Description
org.pipservices3.commons.commands
org.pipservices3.commons.run

Uses of Parameters in org.pipservices3.commons.commands

Methods in org.pipservices3.commons.commands with parameters of type Parameters

Modifier and Type	Method	Description
Object	Command.execute(String correlationId, Parameters args)	Executes the command.
Object	CommandSet.execute(String correlationId, String commandName, Parameters args)	Executes a ICommand command specified by its name.
Object	ICommandInterceptor.execute(String correlationId, ICommand command, Parameters args)	Executes the wrapped command with specified arguments.
Object	InterceptedCommand.execute(String correlationId, Parameters args)	Executes the next command in the execution chain using the given Parameters parameters (arguments).
void	CommandSet.notify(String correlationId, String eventName, Parameters args)	Fires event specified by its name and notifies all registered IEventListener listeners
void	Event.notify(String correlationId, Parameters args)	Fires this event and notifies all registered listeners.
void	IEventListener.onEvent(String correlationId, IEvent event, Parameters args)	A method called when events this listener is subscrubed to are fired.
List<ValidationResult>	Command.validate(Parameters args)	Validates the command Parameters args before execution using the defined schema.
List<ValidationResult>	CommandSet.validate(String commandName, Parameters args)	Validates Parameters args for command specified by its name using defined schema.
List<ValidationResult>	ICommand.validate(Parameters args)	Validates command arguments before execution using defined schema.
List<ValidationResult>	ICommandInterceptor.validate(ICommand command, Parameters args)	Validates arguments of the wrapped command before its execution.
List<ValidationResult>	InterceptedCommand.validate(Parameters args)	Validates the Parameters args that are to be passed to the command that is next in the execution chain.

Uses of Parameters in org.pipservices3.commons.run

Methods in org.pipservices3.commons.run that return Parameters

Modifier and Type	Method	Description
static Parameters	Parameters.fromConfig(ConfigParams config)	Creates new Parameters from ConfigMap object.
static Parameters	Parameters.fromJson(String json)	Creates new Parameters from JSON object.
static Parameters	Parameters.fromTuples(Object... tuples)	Creates a new Parameters object filled with provided key-value pairs called tuples.
static Parameters	Parameters.fromValue(Object value)	Creates a new Parameters object filled with key-value pairs from specified object.
Parameters	Parameters.getAsNullableParameters(String key)	Converts map element into an Parameters or returns null if conversion is not possible.
Parameters	Parameters.getAsParameters(String key)	Converts map element into an Parameters or returns empty Parameters if conversion is not possible.
Parameters	Parameters.getAsParametersWithDefault(String key, Parameters defaultValue)	Converts map element into an Parameters or returns default value if conversion is not possible.
static Parameters	Parameters.mergeParams(Parameters... parameters)	Merges two or more Parameters into one.
Parameters	Parameters.omit(String... paths)	Omits selected parameters from this Parameters and returns the rest as a new Parameters object.
Parameters	Parameters.override(Parameters parameters)	Overrides parameters with new values from specified Parameters and returns a new Parameters object.
Parameters	Parameters.override(Parameters parameters, boolean recursive)	Overrides parameters with new values from specified Parameters and returns a new Parameters object.
Parameters	Parameters.pick(String... paths)	Picks select parameters from this Parameters and returns them as a new Parameters object.
Parameters	Parameters.setDefaults(Parameters defaultParameters)	Set default values from specified Parameters and returns a new Parameters object.
Parameters	Parameters.setDefaults(Parameters defaultParameters, boolean recursive)	Set default values from specified Parameters and returns a new Parameters object.

Methods in org.pipservices3.commons.run with parameters of type Parameters

Modifier and Type	Method	Description
static List<Object>	Executor.execute(String correlationId, Iterable<Object> components, Parameters args)	Executes multiple components.
Object	IExecutable.execute(String correlationId, Parameters args)	Executes component with arguments and receives execution result.
static Object	Executor.executeOne(String correlationId, Object component, Parameters args)	Executes specific component.
Parameters	Parameters.getAsParametersWithDefault(String key, Parameters defaultValue)	Converts map element into an Parameters or returns default value if conversion is not possible.
static Parameters	Parameters.mergeParams(Parameters... parameters)	Merges two or more Parameters into one.
void	INotifiable.notify(String correlationId, Parameters args)	Notifies the component about occured event.
static void	Notifier.notify(String correlationId, Iterable<Object> components, Parameters args)	Notifies multiple components.
static void	Notifier.notifyOne(String correlationId, Object component, Parameters args)	Notifies specific component.
Parameters	Parameters.override(Parameters parameters)	Overrides parameters with new values from specified Parameters and returns a new Parameters object.
Parameters	Parameters.override(Parameters parameters, boolean recursive)	Overrides parameters with new values from specified Parameters and returns a new Parameters object.
Parameters	Parameters.setDefaults(Parameters defaultParameters)	Set default values from specified Parameters and returns a new Parameters object.
Parameters	Parameters.setDefaults(Parameters defaultParameters, boolean recursive)	Set default values from specified Parameters and returns a new Parameters object.
void	IParameterized.setParameters(Parameters parameters)	Sets execution parameters.