com.oakgrovesystems.reactor.requests
Class GetOperandIdsByLabelAndValue

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.requests.ReactorRequest
        |
        +--com.oakgrovesystems.reactor.requests.GetOperandIdsByLabelAndValue
All Implemented Interfaces:
java.io.Serializable

public class GetOperandIdsByLabelAndValue
extends ReactorRequest

A fine-grained request to retrieve zero or more Operand ID strings by both label name and value.

See Also:
Serialized Form

Field Summary
static java.lang.String OPERAND_LABEL_PARM_NAME
          The name of the request parameter that is the label of the operand(s) to get
static java.lang.String OPERAND_VALUE_PARM_NAME
          The name of the request parameter that is the value of the operand(s) to get
static java.lang.String REQUEST_TYPE
          The request type of Get requests.
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
GetOperandIdsByLabelAndValue()
          Creates a Get request without specifying the authentication token to use to make the request.
GetOperandIdsByLabelAndValue(java.lang.String authToken)
          Creates a Get request that will use the specified authentication token
 
Method Summary
protected  org.jdom.Element createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse res, com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
          This (superclass) implementation simply returns null, which is perfect for requests that don't have return values.
 java.lang.String getLabel()
          Accessor for OPERAND_LABEL.
 java.lang.String getValue()
          Accessor for OPERAND_VALUE.
 java.util.List paramsToXML()
          Returns a List of Elements representing the parameters of the request
protected  void parseParameters(org.jdom.Element params, com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
          Configures the parameters from the XML representation
protected  com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
           
 void setLabel(java.lang.String label)
          Specifies the label of the operand(s) to get.
 void setValue(java.lang.String value)
          Specifies the value of the operand(s) to get.
 
Methods inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
configureFromXML, configureFromXML, createResponseXML, createResponseXML, createReturnValuesElem, getAuthToken, getLabelPath, getObjectId, getParameter, getParameter, getParameterNames, getRequestType, makeAuthTokenXML, makeObjectElement, makeOperandElement, makePolicyElement, makeProcessElement, makeReferenceElement, makeStatusElement, parseResponse, send, sendAsXML, sendViaHttp, setAuthToken, setParameter, setRequestType, toString, toXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPERAND_LABEL_PARM_NAME

public static final java.lang.String OPERAND_LABEL_PARM_NAME
The name of the request parameter that is the label of the operand(s) to get

See Also:
Constant Field Values

OPERAND_VALUE_PARM_NAME

public static final java.lang.String OPERAND_VALUE_PARM_NAME
The name of the request parameter that is the value of the operand(s) to get

See Also:
Constant Field Values

REQUEST_TYPE

public static final java.lang.String REQUEST_TYPE
The request type of Get requests. Used as a parameter to setRequestType() in the instance initializer.

See Also:
Constant Field Values
Constructor Detail

GetOperandIdsByLabelAndValue

public GetOperandIdsByLabelAndValue()
Creates a Get request without specifying the authentication token to use to make the request. setAuthToken() must be called before the request can be sent successfully.


GetOperandIdsByLabelAndValue

public GetOperandIdsByLabelAndValue(java.lang.String authToken)
Creates a Get request that will use the specified authentication token

Parameters:
authToken - the authentication token to use to make the request
Method Detail

setLabel

public void setLabel(java.lang.String label)
Specifies the label of the operand(s) to get.

Parameters:
label - the label

setValue

public void setValue(java.lang.String value)
Specifies the value of the operand(s) to get.

Parameters:
value - the value

getLabel

public java.lang.String getLabel()
Accessor for OPERAND_LABEL.

Returns:
the label of the operand(s) to get.

getValue

public java.lang.String getValue()
Accessor for OPERAND_VALUE.

Returns:
the value of the operand(s) to get.

parseParameters

protected void parseParameters(org.jdom.Element params,
                               com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
                        throws FailedRequestException
Description copied from class: ReactorRequest
Configures the parameters from the XML representation

Specified by:
parseParameters in class ReactorRequest
Parameters:
params - the 'parameters' Element of the request
Throws:
FailedRequestException - if the parameters can't be configured from the XML.

createRtnValXML

protected org.jdom.Element createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse res,
                                           com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
                                    throws FailedRequestException
Description copied from class: ReactorRequest
This (superclass) implementation simply returns null, which is perfect for requests that don't have return values. Subclass implementations should override this method if they have return values. This method should return a 'return_values' Element or null if there are no return values. A precondition of this method is that the ReactorResponse parameter is not a failure.

Overrides:
createRtnValXML in class ReactorRequest
Parameters:
res - the ReactorResponse to translate to XML.
mapper - object to convert IDs to label paths in return values
Returns:
the XML representation of the return values
Throws:
FailedRequestException - if the return values Element can't be created

paramsToXML

public java.util.List paramsToXML()
                           throws FailedRequestException
Description copied from class: ReactorRequest
Returns a List of Elements representing the parameters of the request

Specified by:
paramsToXML in class ReactorRequest
Returns:
a List of Elements representing the parameters of the request
FailedRequestException

parseReturnValues

protected com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
                                                                 throws FailedRequestException
Specified by:
parseReturnValues in class ReactorRequest
FailedRequestException


Copyright (c) 1999-2004 Oak Grove Systems. All Rights Reserved.