org.eclipse.osbp.runtime.common.help

Class HelpRequestBuilder

java.lang.Object

org.eclipse.osbp.runtime.common.help.HelpRequestBuilder

public class HelpRequestBuilder
extends Object

The Class HelpRequestBuilder.

Method Summary

Modifier and Type	Method and Description
HelpRequestBuilder	data(Object data) Any kind of data.
HelpRequestBuilder	id(Object id) An id which identifies the help for the requestType.
static HelpRequestBuilder	newRequest() New request.
HelpRequestBuilder	property(String key, Object value) Pass any property.
Map<String,Object>	toRequest() Returns the resulting request parameters.
HelpRequestBuilder	type(String requestType) The type of the help.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static final HelpRequestBuilder newRequest()

New request.

Returns:

the help request builder

type

public HelpRequestBuilder type(String requestType)

The type of the help.

Parameters:

requestType - the request type

Returns:

the help request builder

id

public HelpRequestBuilder id(Object id)

An id which identifies the help for the requestType.

Parameters:

id - the id

Returns:

the help request builder

data

public HelpRequestBuilder data(Object data)

Any kind of data.

Parameters:

data - the data

Returns:

the help request builder

property

public HelpRequestBuilder property(String key,
                                   Object value)

Pass any property.

Parameters:

key - the key

value - the value

Returns:

the help request builder

toRequest

public Map<String,Object> toRequest()

Returns the resulting request parameters.

Returns:

the map