com.oakgrovesystems.reactor.requests
Class QueryAllObjects

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

public class QueryAllObjects
extends QueryRequest

A request for the set of all Process Mediation Objects in the Reactor system.

See Also:
Serialized Form

Field Summary
static java.lang.String ALL_OBJECTS
          The type of a query for all objects
static java.lang.String REQUEST_TYPE
          The request type of Query requests.
static java.lang.String TYPE_PARM_NAME
          The name of the request parameter that is the query type
 
Fields inherited from class com.oakgrovesystems.reactor.requests.QueryRequest
operandBuilder, policyBuilder, processBuilder, statusBuilder, useLabelPaths
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
QueryAllObjects()
          Creates a QueryAllObjects request without specifying the authentication token to use to make the request.
QueryAllObjects(java.lang.String authToken)
          Creates a QueryAllObjects request that will use the specified authentication token
 
Method Summary
 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
 
Methods inherited from class com.oakgrovesystems.reactor.requests.QueryRequest
addObject, addOperand, addPolicy, addProcess, addReference, addStatus, createRtnValXML, getLabelPathFromReference, getUseLabelPaths, parseReturnValues, setUseLabelPaths
 
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

ALL_OBJECTS

public static final java.lang.String ALL_OBJECTS
The type of a query for all objects

See Also:
Constant Field Values

TYPE_PARM_NAME

public static final java.lang.String TYPE_PARM_NAME
The name of the request parameter that is the query type

See Also:
Constant Field Values

REQUEST_TYPE

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

See Also:
Constant Field Values
Constructor Detail

QueryAllObjects

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


QueryAllObjects

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

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

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.

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


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