org.openspml.v2.msg.spmlsearch
Class SearchRequest

java.lang.Object
  extended byorg.openspml.v2.msg.spml.Extensible
      extended byorg.openspml.v2.msg.spml.ExtensibleMarshallable
          extended byorg.openspml.v2.msg.spml.Request
              extended byorg.openspml.v2.msg.spmlsearch.BasicRequest
                  extended byorg.openspml.v2.msg.spmlsearch.SearchRequest
All Implemented Interfaces:
Marshallable, MarshallableElement, OpenContentContainer

public class SearchRequest
extends org.openspml.v2.msg.spmlsearch.BasicRequest

Author:
kent.spaulding@sun.com

Date: Feb 16, 2006


Constructor Summary
SearchRequest()
           
SearchRequest(java.lang.String requestId, ExecutionMode executionMode, Query query, java.lang.String[] includeDataForCapability, ReturnData returnData)
           
SearchRequest(java.lang.String requestId, ExecutionMode executionMode, Query query, java.lang.String[] includeDataForCapability, ReturnData returnData, int maxSelect)
           
SearchRequest(java.lang.String requestId, ExecutionMode executionMode, Query query, java.lang.String[] includeDataForCapability, ReturnData returnData, java.lang.Integer maxSelect)
           
 
Method Summary
 void addIncludeDataForCapability(java.lang.String includeDataForCapability)
           
 void clearIncludeDataForCapability()
           
 boolean equals(java.lang.Object o)
           
 java.lang.String[] getIncludeDataForCapability()
           
 int getMaxSelect()
           
 PrefixAndNamespaceTuple[] getNamespacesInfo()
          We need to know the namespace of the class to include.
 SearchQuery getQuery()
           
 ReturnData getReturnData()
           
 int hashCode()
           
 boolean removeIncludeDataForCapability(java.lang.String includeDataForCapability)
           
 void setMaxSelect(int maxSelect)
           
 void setQuery(Query query)
           
 void setReturnData(ReturnData returnData)
           
 void useDefaultMaxSelect()
           
 
Methods inherited from class org.openspml.v2.msg.spml.Request
getExecutionMode, getRequestID, setExecutionMode, setRequestID, toXML
 
Methods inherited from class org.openspml.v2.msg.spml.Extensible
addOpenContentAttr, addOpenContentAttr, addOpenContentElement, findOpenContentAttrValueByName, findOperationalAttrByName, findOperationalNVPByName, getOpenContentAttrs, getOpenContentElements, isValid, removeOpenContentAttr, removeOpenContentElement, setOpenContent, setOpenContentAttrs, setOpenContentElements
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.openspml.v2.msg.MarshallableElement
isValid
 

Constructor Detail

SearchRequest

public SearchRequest()

SearchRequest

public SearchRequest(java.lang.String requestId,
                     ExecutionMode executionMode,
                     Query query,
                     java.lang.String[] includeDataForCapability,
                     ReturnData returnData,
                     java.lang.Integer maxSelect)

SearchRequest

public SearchRequest(java.lang.String requestId,
                     ExecutionMode executionMode,
                     Query query,
                     java.lang.String[] includeDataForCapability,
                     ReturnData returnData,
                     int maxSelect)

SearchRequest

public SearchRequest(java.lang.String requestId,
                     ExecutionMode executionMode,
                     Query query,
                     java.lang.String[] includeDataForCapability,
                     ReturnData returnData)
Method Detail

getQuery

public SearchQuery getQuery()

setQuery

public void setQuery(Query query)

getIncludeDataForCapability

public java.lang.String[] getIncludeDataForCapability()

clearIncludeDataForCapability

public void clearIncludeDataForCapability()

addIncludeDataForCapability

public void addIncludeDataForCapability(java.lang.String includeDataForCapability)

removeIncludeDataForCapability

public boolean removeIncludeDataForCapability(java.lang.String includeDataForCapability)

getReturnData

public ReturnData getReturnData()

setReturnData

public void setReturnData(ReturnData returnData)

getMaxSelect

public int getMaxSelect()

setMaxSelect

public void setMaxSelect(int maxSelect)

useDefaultMaxSelect

public void useDefaultMaxSelect()

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class Request

hashCode

public int hashCode()
Overrides:
hashCode in class Request

getNamespacesInfo

public PrefixAndNamespaceTuple[] getNamespacesInfo()
Description copied from interface: MarshallableElement
We need to know the namespace of the class to include.

Specified by:
getNamespacesInfo in interface MarshallableElement
Overrides:
getNamespacesInfo in class Extensible


Copyright © Sun Microsystems, Inc. All Rights Reserved.