edu.ucsb.cs.jicos.services.external
Class ExternalRequest

java.lang.Object
  edu.ucsb.cs.jicos.services.external.ExternalRequest

public class ExternalRequest
extends java.lang.Object

Field Summary

static int	ACTION_ByEMail Index for the delayed by email action.
static int	ACTION_ByWeb Index for the delayed by web action.
static int	ACTION_Immediate Index for the immediate (wait for an answer) action.
static int	ITEM_Unknown Identier for an unknown item.
static java.lang.String	RESPONSE_Action XPath selector for the response action value.
static java.lang.String[]	RESPONSE_ActionList List of actions to be taken to get the answer.
static java.lang.String	RESPONSE_ByEMail Value of the delayed by email action.
static java.lang.String	RESPONSE_ByWeb Value of the delayed by web action.
static java.lang.String	RESPONSE_EMail XPath selector for the response email value.
static java.lang.String	RESPONSE_Immediate Value of the immediate (wait for an answer) action.
static java.lang.String	TOP_LEVEL First path component of the request.

Constructor Summary

ExternalRequest()
An external request.

ExternalRequest(ExternalRequest externalRequest)
Copy constructor.

ExternalRequest(java.lang.Object input, Shared shared, Task task)
An external request.

Method Summary

edu.ucsb.cs.jicos.services.external.services.CollectorResponse	getCollectorResponse() Return the response from the collector.
ExternalRequestId	getExternalRequestId() Return the external request identifier.
java.lang.Object	getInput() Return the input object.
Shared	getShared() Return the shared object.
Task	getTask() Return the task.
java.lang.String	getTaskName() Return the task name.
boolean	isReady() Return the status.
void	setCollectorResponse(edu.ucsb.cs.jicos.services.external.services.CollectorResponse collectorResponse) Set the collector's response.
void	setInput(java.lang.Object input) Set the input object.
void	setIsReady(boolean isReady)
void	setRequestId(ExternalRequestId requestId) Set the request id.
void	setShared(Shared shared) Set the Shared object.
void	setTask(Task task) Set the task.

Methods inherited from class java.lang.Object

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

Field Detail

TOP_LEVEL

public static final java.lang.String TOP_LEVEL

First path component of the request.

See Also:

Constant Field Values

ITEM_Unknown

public static final int ITEM_Unknown

Identier for an unknown item.

See Also:

Constant Field Values

RESPONSE_Action

public static final java.lang.String RESPONSE_Action

XPath selector for the response action value.

See Also:

Constant Field Values

RESPONSE_EMail

public static final java.lang.String RESPONSE_EMail

XPath selector for the response email value.

See Also:

Constant Field Values

RESPONSE_ActionList

public static final java.lang.String[] RESPONSE_ActionList

List of actions to be taken to get the answer.

ACTION_Immediate

public static final int ACTION_Immediate

Index for the immediate (wait for an answer) action.

See Also:

Constant Field Values

ACTION_ByWeb

public static final int ACTION_ByWeb

Index for the delayed by web action.

See Also:

Constant Field Values

ACTION_ByEMail

public static final int ACTION_ByEMail

Index for the delayed by email action.

See Also:

Constant Field Values

RESPONSE_Immediate

public static final java.lang.String RESPONSE_Immediate

Value of the immediate (wait for an answer) action.

RESPONSE_ByWeb

public static final java.lang.String RESPONSE_ByWeb

Value of the delayed by web action.

RESPONSE_ByEMail

public static final java.lang.String RESPONSE_ByEMail

Value of the delayed by email action.

See Also:

Constant Field Values

Constructor Detail

ExternalRequest

public ExternalRequest()

An external request.

ExternalRequest

public ExternalRequest(java.lang.Object input,
                       Shared shared,
                       Task task)

An external request.

Parameters:

input - The Jicos Input object.

shared - The Jicos shared object.

task - The Jicos task.

ExternalRequest

public ExternalRequest(ExternalRequest externalRequest)

Copy constructor.

Parameters:

externalRequest - An external request.

Method Detail

getTask

public Task getTask()

Return the task.

getTaskName

public java.lang.String getTaskName()

Return the task name.

getInput

public java.lang.Object getInput()

Return the input object.

getShared

public Shared getShared()

Return the shared object.

getExternalRequestId

public ExternalRequestId getExternalRequestId()

Return the external request identifier.

getCollectorResponse

public edu.ucsb.cs.jicos.services.external.services.CollectorResponse getCollectorResponse()

Return the response from the collector.

isReady

public boolean isReady()

Return the status.

setTask

public void setTask(Task task)

Set the task.

setInput

public void setInput(java.lang.Object input)

Set the input object.

setShared

public void setShared(Shared shared)

Set the Shared object.

setRequestId

public void setRequestId(ExternalRequestId requestId)

Set the request id.

setCollectorResponse

public void setCollectorResponse(edu.ucsb.cs.jicos.services.external.services.CollectorResponse collectorResponse)

Set the collector's response.

setIsReady

public void setIsReady(boolean isReady)