Package org.nuclos.api.context

Class InputDelegateSpecification

java.lang.Object

org.nuclos.api.context.InputDelegateSpecification

All Implemented Interfaces:

Serializable

public class InputDelegateSpecification
extends Object
implements Serializable

Specification of a client-side delegate class to produce a customized input panel. It is possible to pass a map of serializable values to the delegate, for instance to setup comboboxes with context-dependant values.

Author:

thomas.schiffmann

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	InputDelegateSpecification.InputDelegateDataMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InputDelegateSpecification()	for deserialization only
	InputDelegateSpecification(String delegateclass)	Constructs a new InputDelegateSpecification.

Method Summary

Modifier and Type	Method	Description
boolean	applyForAllMultiEditObjects()	internal use only
Map<String,Serializable>	getData()	Getter for context data to be passed to delegate instance.
String	getDelegateClass()	Getter for delegate class name.
void	setApplyForAllMultiEditObjects(boolean applyForAllMultiEditObjects)
void	setData(Map<String,Serializable> data)	Setter for context data to be passed to delegate instance.

Methods inherited from class java.lang.Object

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

Constructor Details

InputDelegateSpecification

protected InputDelegateSpecification()

for deserialization only

InputDelegateSpecification

public InputDelegateSpecification(String delegateclass)

Constructs a new InputDelegateSpecification.

Parameters:

delegateclass - The fully qualified name of the delegate class.

Method Details

getDelegateClass

public String getDelegateClass()

Getter for delegate class name.

Returns:

The fully qualified name of the delegate class.

getData

public Map<String,Serializable> getData()

Getter for context data to be passed to delegate instance.

Returns:

Context data to be passed to delegate instance.

setData

public void setData(Map<String,Serializable> data)

Setter for context data to be passed to delegate instance.

Parameters:

data - Context data to be passed to delegate instance.

applyForAllMultiEditObjects

public boolean applyForAllMultiEditObjects()

internal use only

Returns:

applyForAllMultiEditObjects

setApplyForAllMultiEditObjects

public void setApplyForAllMultiEditObjects(boolean applyForAllMultiEditObjects)

Parameters:

applyForAllMultiEditObjects - false (default): One input question for every object during a multi edit. true: The client is instructed to ask for the input only once. You have to choose a general key for your input to work as expected, no object specific data within the key.