Esri Geoportal Server
1.0

com.esri.gpt.server.csw.provider.components
Class RequestOptions

java.lang.Object
  extended by com.esri.gpt.server.csw.provider.components.RequestOptions

public class RequestOptions
extends Object

Options associated with a CSW operation request.


Constructor Summary
RequestOptions()
          Default constructor
 
Method Summary
 Map<String,Object> getAdditionalOptions()
          Gets the free form map of additional options.
 CapabilityOptions getCapabilityOptions()
          Gets the GetCapabilities request options.
 DescribeRecordOptions getDescribeRecordOptions()
          Gets the DescribeRecord request options.
 QueryOptions getQueryOptions()
          Gets the query options.
 Document getRequestDom()
          Gets the XML request document.
 String getRequestXml()
          Gets the request XML.
 TransactionOptions getTransactionOptions()
          Gets the transaction options.
 void setAdditionalOptions(Map<String,Object> additionalOptions)
          Sets the free form map of additional options.
 void setCapabilityOptions(CapabilityOptions options)
          Sets the DescribeRecord request options.
 void setDescribeRecordOptions(DescribeRecordOptions options)
          Sets the DescribeRecord request options.
 void setQueryOptions(QueryOptions options)
          Sets the query options.
 void setRequestDom(Document requestDom)
          Sets the XML request document.
 void setRequestXml(String xml)
          Sets the request XML.
 void setTransactionOptions(TransactionOptions options)
          Sets the transaction options.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RequestOptions

public RequestOptions()
Default constructor

Method Detail

getAdditionalOptions

public Map<String,Object> getAdditionalOptions()
Gets the free form map of additional options.

Returns:
the additional options

setAdditionalOptions

public void setAdditionalOptions(Map<String,Object> additionalOptions)
Sets the free form map of additional options.

Parameters:
additionalOptions - the additional options

getCapabilityOptions

public CapabilityOptions getCapabilityOptions()
Gets the GetCapabilities request options.

Returns:
the GetCapabilities options

setCapabilityOptions

public void setCapabilityOptions(CapabilityOptions options)
Sets the DescribeRecord request options.

Parameters:
options - the DescribeRecord options

getDescribeRecordOptions

public DescribeRecordOptions getDescribeRecordOptions()
Gets the DescribeRecord request options.

Returns:
the DescribeRecord options

setDescribeRecordOptions

public void setDescribeRecordOptions(DescribeRecordOptions options)
Sets the DescribeRecord request options.

Parameters:
options - the DescribeRecord options

getQueryOptions

public QueryOptions getQueryOptions()
Gets the query options.
Applies to the GetRecordById and GetRecords operations.

Returns:
the query options

setQueryOptions

public void setQueryOptions(QueryOptions options)
Sets the query options.
Applies to the GetRecordById and GetRecords operations.

Parameters:
options - the query options

getRequestDom

public Document getRequestDom()
Gets the XML request document.

Returns:
the XML request document (can be null)

setRequestDom

public void setRequestDom(Document requestDom)
Sets the XML request document.

Parameters:
requestDom - the XML request document

getRequestXml

public String getRequestXml()
Gets the request XML.

Returns:
the request XML (can be null)

setRequestXml

public void setRequestXml(String xml)
Sets the request XML.

Parameters:
xml - the request XML (can be null)

getTransactionOptions

public TransactionOptions getTransactionOptions()
Gets the transaction options.
Applies to the Insert, Update and Delete.

Returns:
the transaction options

setTransactionOptions

public void setTransactionOptions(TransactionOptions options)
Sets the transaction options.
Applies to the Insert, Update and Delete.

Parameters:
options - the transaction options

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.