MarkLogic XCC/.Net Library

Request Members

Request overview

Public Instance Properties

EffectiveOptions A newly created RequestOptions instance that reflects the execution options that will be applied to this request. This may be a blend of the option values set on the Request and those set on the Session. This method will always return a newly created, non-null result. The object returned is NOT the RequestOptions object associated with either the Request or the Session. Making changes to the returned RequestOptions object will not affect subsequent submissions of this Request. Although it's possible to modify and pass the returned object back to the Options property, this is not recommended. In general, you should create your own instance of RequestOptions and set only those options you explictly want to override. When submitted, the options set on the Request are merged with those, if any, set for the Session. This method mainly used internally. It can be used to determine which values will be submitted with a request. Most client code will not need this method.
Options An instance of RequestOptions or null if none is currently in effect.
Session The session which created this Request. Request objects are created by factory methods on Session and their implementations are interdependent.
Variable Associate an XdmVariable with this Request. When an invocation of Session.submitRequest(Request) is made, all currently set variables are sent with the request and defined as XQuery external variables when the query runs in the server. If another variable with the same name is already set, it is replaced. Note that XName instances with the same namespace/local name values are considered to be equal.
Variables An array (possibly zero length) of all the XdmVariable objects currently set on this Request.

Public Instance Methods

ClearVariable Remove the given variable from this Request context. The variable and its value are still valid and may be reassociated with the session by passing it to the Variable property.
ClearVariables Remove any variables set in this Request.
SetNewIntegerVariableOverloaded. Convenience method that creates a new XSInteger, binds it to this Request and then returns the new XSInteger instance. This method is equivalent to: 
            XdmVariable temp = ValueFactory.newVariable (
            ValueFactory.newXName (namespace, localname),
            ValueFactory.newValue (ValueType.XS_INTEGER, value));
            request.setVariable (temp);
            return temp;
SetNewStringVariableOverloaded. Convenience method that creates a new XSString, binds it to this Request and then returns the new XSString instance. This method is equivalent to: 
            XdmVariable temp = ValueFactory.newVariable (
            ValueFactory.newXName (namespace, localname),
            ValueFactory.newValue (ValueType.XS_STRING, value));
            request.setVariable (temp);
            return temp;
SetNewVariableOverloaded. Convenience method that creates a new XdmVariable, binds it to this Request and then returns the new XdmVariable object. This method is equivalent to: 
            XdmVariable temp = ValueFactory.newVariable (xname, value);
            request.setVariable (temp);
            return temp;

See Also

Request Interface | Marklogic.Xcc Namespace