Package org.tweetyproject.web.services.sequenceexplanation

Class SequenceExplanationPost

java.lang.Object

org.tweetyproject.web.services.sequenceexplanation.SequenceExplanationPost

public class SequenceExplanationPost
extends Object

Request payload for sequence explanation web service calls. This class encapsulates the optional notification email, the timeout configuration, and the concrete command information required to execute a sequence explanation request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SequenceExplanationPost.GetSequenceExplanationsCmd	Command payload for requesting sequence explanations.
static interface	SequenceExplanationPost.SequenceExplanationCmd	Marker interface for sequence explanation request commands.

Constructor Summary

Constructors

Constructor	Description
SequenceExplanationPost(String email, int timeout, String unit_timeout, SequenceExplanationPost.SequenceExplanationCmd cmd)	Creates a new request for sequence explanations.

Method Summary

Modifier and Type	Method	Description
SequenceExplanationPost.SequenceExplanationCmd	getCmd()	Returns the command payload for this request.
String	getEmail()	Returns the optional email address for request notifications.
int	getTimeout()	Returns the timeout value for the request.
String	getUnit_timeout()	Returns the timeout unit for the request.

Methods inherited from class java.lang.Object

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

Constructor Details

SequenceExplanationPost

public SequenceExplanationPost(String email,
 int timeout,
 String unit_timeout,
 SequenceExplanationPost.SequenceExplanationCmd cmd)

Creates a new request for sequence explanations.

Parameters:

email - optional notification email address

timeout - timeout value for the request

unit_timeout - timeout unit for the request

cmd - command payload that defines the requested action

Method Details

getEmail

public String getEmail()

Returns the optional email address for request notifications.

Returns:

email address or null if not provided

getTimeout

public int getTimeout()

Returns the timeout value for the request.

Returns:

request timeout

getUnit_timeout

public String getUnit_timeout()

Returns the timeout unit for the request.

Returns:

timeout unit string

getCmd

public SequenceExplanationPost.SequenceExplanationCmd getCmd()

Returns the command payload for this request.

Returns:

sequence explanation command