com.metamatrix.admin.api.objects
Interface Request

All Superinterfaces:

AdminObject

All Known Implementing Classes:

MMRequest

public interface Request
extends AdminObject

When a user submits a SQL command to the system for processing, usually that represents a single request. A single request might have one or more source requests (the requests that are being processed on the physical data sources) as part of original request.

A request is identified by a numbers separated by '|'. usually in they are arranged in the pattern [session]|[request] or [session]|[request]|[source request]

Since:

4.3

Field Summary

Fields inherited from interface com.metamatrix.admin.api.objects.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Method Summary

java.lang.String	getConnectorBindingName()
java.util.Date	getCreated()
java.lang.String	getNodeID()
java.util.Date	getProcessingDate() Get the Date processing began for the Request
java.lang.String	getRequestID() Get the RequestID for a Request
java.lang.String	getSessionID() Get the SessionID for a Request
java.lang.String	getSqlCommand() Get the SQL Command sent to the Server for a Request
java.lang.String	getTransactionID() Get the TransactionID of the Request
java.lang.String	getUserName() Get the UserName of the Request
boolean	isSource()

Methods inherited from interface com.metamatrix.admin.api.objects.AdminObject

getIdentifier, getName, getProperties, getPropertyValue

Method Detail

getCreated

java.util.Date getCreated()

Returns:

Date the request was created

Since:

4.3

getRequestID

java.lang.String getRequestID()

Get the RequestID for a Request

Returns:

RequestID

getSessionID

java.lang.String getSessionID()

Get the SessionID for a Request

Returns:

long SessionID

getSqlCommand

java.lang.String getSqlCommand()

Get the SQL Command sent to the Server for a Request

Returns:

MetaMatrix SQL Command

getProcessingDate

java.util.Date getProcessingDate()

Get the Date processing began for the Request

Returns:

Date processing began

getTransactionID

java.lang.String getTransactionID()

Get the TransactionID of the Request

Returns:

String of TransactionID if in a transaction

getUserName

java.lang.String getUserName()

Get the UserName of the Request

Returns:

String username for the Request

getConnectorBindingName

java.lang.String getConnectorBindingName()

Returns:

Returns the connectorBindingName.

Since:

4.3

isSource

boolean isSource()

Returns:

Returns whether this is a Source Request.

Since:

4.3

getNodeID

java.lang.String getNodeID()

Returns:

In the case that this is a source request this represents the node id. Otherwise blank

Since:

4.3