org.gcube.data.tml.clients
Class BindingParameters

java.lang.Object
  org.gcube.data.tml.clients.BindingParameters

public class BindingParameters
extends Object

The input model for a call to the factory.

Author:

Fabio Simeoni

Field Summary

protected org.gcube.data.tm.stubs.BindParameters

parameters

Constructor Summary

BindingParameters(org.gcube.data.tm.stubs.BindParameters parameters)
Creates an instance around a BindParameters.

BindingParameters(String plugin, Element payload)
Creates a new instance

BindingParameters(String plugin, Element payload, boolean broadcast)
Creates a new instance

Method Summary

Element	getPayload() Returns the input specific to the plugin.
String	getPlugin() Returns the name of the target plugin.
boolean	isBroadcast() Indicates whether the input is to be broadcast to other running instances.
void	setBroadcast(boolean broadcast) Indicates whether the input is to be broadcast to other running instances.
void	setPayload(Element payload) Sets the input specific to the plugin.
void	setPlugin(String name) Sets the name of the target plugin.

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected org.gcube.data.tm.stubs.BindParameters parameters

Constructor Detail

BindingParameters

public BindingParameters(String plugin,
                         Element payload)

Creates a new instance

BindingParameters

public BindingParameters(String plugin,
                         Element payload,
                         boolean broadcast)

Creates a new instance

BindingParameters

public BindingParameters(org.gcube.data.tm.stubs.BindParameters parameters)

Creates an instance around a BindParameters.

Parameters:

parameters - the parameters

Method Detail

getPlugin

public String getPlugin()

Returns the name of the target plugin.

Returns:

the name

setPlugin

public void setPlugin(String name)
               throws IllegalArgumentException

Sets the name of the target plugin.

Parameters:

name - the name

Throws:

IllegalArgumentException - if the name is null

isBroadcast

public boolean isBroadcast()

Indicates whether the input is to be broadcast to other running instances.

Returns:

true if it is, falseotherwise

setBroadcast

public void setBroadcast(boolean broadcast)

Indicates whether the input is to be broadcast to other running instances.

Parameters:

broadcast - true if it is, falseotherwise

getPayload

public Element getPayload()

Returns the input specific to the plugin.

Returns:

the input

setPayload

public void setPayload(Element payload)

Sets the input specific to the plugin.

Parameters:

payload - the input.

Throws:

IllegalArgumentException - if the payload is null