RequestObject (com.kms.katalon.core)

com.kms.katalon.core.testobject.RequestObject

All Implemented Interfaces and Traits:: HttpMessage

public class RequestObject
extends com.kms.katalon.core.testobject.TestObject

Constructor Summary

Constructors
Constructor and description
`RequestObject (String objectId)`

Methods Summary

Methods
Type	Name and description
`HttpBodyContent`	`getBodyContent()` Gets the body content of request.
`String`	`getHttpBody()` Get the http body for this request object
`List<TestObjectProperty>`	`getHttpHeaderProperties()` Get the http headers of this request object
`String`	`getName()` Get the name of this request object
`String`	`getObjectId()` Get the id of this request object
`List<TestObjectProperty>`	`getRestParameters()` Get the rest parameters of this request object if it is a "RESTful" request object
`String`	`getRestRequestMethod()` Get the rest request of this request object if it is a "RESTful" request object
`String`	`getRestUrl()` Get the rest url of this request object if it is a "RESTful" request object
`String`	`getServiceType()` Return the request type for this request object
`String`	`getSoapBody()` Get the soap body of this request object if it is a "SOAP" request object
`String`	`getSoapRequestMethod()` Get the soap request method of this request object if it is a "SOAP" request object
`String`	`getSoapServiceFunction()` Get the soap service function of this request object if it is a "SOAP" request object
`Map<String, Object>`	`getVariables()`
`String`	`getVerificationScript()`
`String`	`getWsdlAddress()` Get the wsdl address of this request object if it is a "SOAP" request object
`void`	`setBodyContent(HttpBodyContent bodyContent)` Sets the body content for this request.
`void`	`setHttpBody(String httpBody)` Set the http body for this request object
`void`	`setHttpHeaderProperties(List<TestObjectProperty> httpHeaderProperties)` Set the http headers of this request object
`void`	`setName(String name)` Set the name for this request object
`void`	`setObjectId(String objectId)` Set the id for this request object
`void`	`setRestParameters(List<TestObjectProperty> restParameters)` Set the rest parameters for this request object
`void`	`setRestRequestMethod(String restRequestMethod)` Set the rest request for this request object
`void`	`setRestUrl(String restUrl)` Set the rest url for this request object
`void`	`setServiceType(String serviceType)` Set the service type for this request object
`void`	`setSoapBody(String soapBody)` Set the soap body for this request object
`void`	`setSoapRequestMethod(String soapRequestMethod)` Set the soap request method for this request object
`void`	`setSoapServiceFunction(String soapServiceFunction)` Set the soap service function for this request object
`void`	`setVariables(Map<String, Object> variables)`
`void`	`setVerificationScript(String verificationScript)`
`void`	`setWsdlAddress(String wsdlAddress)` Set the wsdl address of this request object

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class com.kms.katalon.core.testobject.TestObject`	com.kms.katalon.core.testobject.TestObject#toString(), com.kms.katalon.core.testobject.TestObject#getProperties(), com.kms.katalon.core.testobject.TestObject#setProperties(java.util.List), com.kms.katalon.core.testobject.TestObject#setImagePath(java.lang.String), com.kms.katalon.core.testobject.TestObject#addXpath(com.kms.katalon.core.testobject.TestObjectXpath), com.kms.katalon.core.testobject.TestObject#addXpath(java.lang.String, com.kms.katalon.core.testobject.ConditionType, java.lang.String, boolean), com.kms.katalon.core.testobject.TestObject#addXpath(java.lang.String, com.kms.katalon.core.testobject.ConditionType, java.lang.String), com.kms.katalon.core.testobject.TestObject#getImagePath(), com.kms.katalon.core.testobject.TestObject#getParentObject(), com.kms.katalon.core.testobject.TestObject#getActiveXpaths(), com.kms.katalon.core.testobject.TestObject#addProperty(java.lang.String, com.kms.katalon.core.testobject.ConditionType, java.lang.String), com.kms.katalon.core.testobject.TestObject#addProperty(com.kms.katalon.core.testobject.TestObjectProperty), com.kms.katalon.core.testobject.TestObject#addProperty(java.lang.String, com.kms.katalon.core.testobject.ConditionType, java.lang.String, boolean), com.kms.katalon.core.testobject.TestObject#setXpaths(java.util.List), com.kms.katalon.core.testobject.TestObject#getActiveProperties(), com.kms.katalon.core.testobject.TestObject#setParentObject(com.kms.katalon.core.testobject.TestObject), com.kms.katalon.core.testobject.TestObject#findXpath(java.lang.String), com.kms.katalon.core.testobject.TestObject#findXpathValue(java.lang.String, boolean), com.kms.katalon.core.testobject.TestObject#findXpathValue(java.lang.String), com.kms.katalon.core.testobject.TestObject#getXpaths(), com.kms.katalon.core.testobject.TestObject#setParentObjectShadowRoot(boolean), com.kms.katalon.core.testobject.TestObject#findProperty(java.lang.String), com.kms.katalon.core.testobject.TestObject#findPropertyValue(java.lang.String, boolean), com.kms.katalon.core.testobject.TestObject#findPropertyValue(java.lang.String), com.kms.katalon.core.testobject.TestObject#getObjectId(), com.kms.katalon.core.testobject.TestObject#getSelectorCollection(), com.kms.katalon.core.testobject.TestObject#isParentObjectShadowRoot(), com.kms.katalon.core.testobject.TestObject#getSelectorMethod(), com.kms.katalon.core.testobject.TestObject#getUseRelativeImagePath(), com.kms.katalon.core.testobject.TestObject#setSelectorValue(com.kms.katalon.core.testobject.SelectorMethod, java.lang.String), com.kms.katalon.core.testobject.TestObject#setUseRelativeImagePath(boolean), com.kms.katalon.core.testobject.TestObject#setSelectorMethod(com.kms.katalon.core.testobject.SelectorMethod), com.kms.katalon.core.testobject.TestObject#wait(long, int), com.kms.katalon.core.testobject.TestObject#wait(long), com.kms.katalon.core.testobject.TestObject#wait(), com.kms.katalon.core.testobject.TestObject#equals(java.lang.Object), com.kms.katalon.core.testobject.TestObject#hashCode(), com.kms.katalon.core.testobject.TestObject#getClass(), com.kms.katalon.core.testobject.TestObject#notify(), com.kms.katalon.core.testobject.TestObject#notifyAll()
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public RequestObject(String objectId)
- Method Detail
  - @Override public HttpBodyContent getBodyContent()
    
    Gets the body content of request.
    See Also:
    HttpTextBodyContent
    Since:
    5.4
  - public String getHttpBody()
    
    Get the http body for this request object
    deprecated:
    Deprecated from 5.4. Please use setBodyContent(HttpBodyContent) instead.
    
    Returns:
    the http body for this request object as a String
  - public List<TestObjectProperty> getHttpHeaderProperties()
    
    Get the http headers of this request object
    Returns:
    the list contains the http headers of this request object
  - public String getName()
    
    Get the name of this request object
    Returns:
    the name of this request object
  - public String getObjectId()
    
    Get the id of this request object
    Returns:
    the id of this request object
  - public List<TestObjectProperty> getRestParameters()
    
    Get the rest parameters of this request object if it is a "RESTful" request object
    Returns:
    the rest parameters of this request object if it is a "RESTful" request object, or empty list if it is not
  - public String getRestRequestMethod()
    
    Get the rest request of this request object if it is a "RESTful" request object
    Possible values: GET, POST, PUT, DELETE
    Returns:
    the get request of this request object if it is a "RESTful" request object, or null if it is not
  - public String getRestUrl()
    
    Get the rest url of this request object if it is a "RESTful" request object
    Returns:
    the rest url of this request object if it is a "RESTful" request object, or null if it is not
  - public String getServiceType()
    
    Return the request type for this request object
    Possible values: SOAP, RESTful
    Returns:
    the request type for this request object
  - public String getSoapBody()
    
    Get the soap body of this request object if it is a "SOAP" request object
    Returns:
    the soap body of this request object if it is a "SOAP" request object, or null if it is not
  - public String getSoapRequestMethod()
    
    Get the soap request method of this request object if it is a "SOAP" request object
    Possible values: SOAP, SOAP12, GET, POST
    Returns:
    the soap request method of this request object if it is a "SOAP" request object, or null if it is not
  - public String getSoapServiceFunction()
    
    Get the soap service function of this request object if it is a "SOAP" request object
    Returns:
    the soap service function of this request object if it is a "SOAP" request object, or null if it is not
  - public Map<String, Object> getVariables()
  - public String getVerificationScript()
  - public String getWsdlAddress()
    
    Get the wsdl address of this request object if it is a "SOAP" request object
    Returns:
    the wsdl address of this request object if it is a "SOAP" request object, or null if it is not
  - public void setBodyContent(HttpBodyContent bodyContent)
    
    Sets the body content for this request.
    Parameters:
    bodyContent - an implementation of HttpBodyContent
    See Also:
    HttpTextBodyContent
    HttpFileBodyContent
    HttpFormDataBodyContent
    HttpUrlEncodedBodyContent
  - public void setHttpBody(String httpBody)
    
    Set the http body for this request object
    deprecated:
    Deprecated from 5.4. Please use setBodyContent(HttpBodyContent) instead.
    
    Parameters:
    httpBody - the new http body for this request object as a String
  - public void setHttpHeaderProperties(List<TestObjectProperty> httpHeaderProperties)
    
    Set the http headers of this request object
    Parameters:
    httpHeaderProperties - the new list contains the http headers for this request object
  - public void setName(String name)
    
    Set the name for this request object
    Parameters:
    name - the new name of this request object
  - public void setObjectId(String objectId)
    
    Set the id for this request object
    Parameters:
    objectId - the new id of this request object
  - public void setRestParameters(List<TestObjectProperty> restParameters)
    
    Set the rest parameters for this request object
    Parameters:
    restParameters - the new rest parameters of this request object
  - public void setRestRequestMethod(String restRequestMethod)
    
    Set the rest request for this request object
    Parameters:
    restRequestMethod - the new get request for this request object
  - public void setRestUrl(String restUrl)
    
    Set the rest url for this request object
    Parameters:
    restUrl - the new rest url for this request object
  - public void setServiceType(String serviceType)
    
    Set the service type for this request object
    Parameters:
    serviceType - the new request type for this request object
  - public void setSoapBody(String soapBody)
    
    Set the soap body for this request object
    Parameters:
    soapBody - the new soap body for this request object
  - public void setSoapRequestMethod(String soapRequestMethod)
    
    Set the soap request method for this request object
    Parameters:
    soapRequestMethod - the new soap request method for this request object
  - public void setSoapServiceFunction(String soapServiceFunction)
    
    Set the soap service function for this request object
    Parameters:
    soapServiceFunction - the new soap service function for this request object
  - public void setVariables(Map<String, Object> variables)
  - public void setVerificationScript(String verificationScript)
  - public void setWsdlAddress(String wsdlAddress)
    
    Set the wsdl address of this request object
    Parameters:
    wsdlAddress - the new wsdl address of this request object

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Java] Class RequestObject

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public RequestObject(String objectId)

Method Detail

@Override public HttpBodyContent getBodyContent()

public String getHttpBody()

public List<TestObjectProperty> getHttpHeaderProperties()

public String getName()

public String getObjectId()

public List<TestObjectProperty> getRestParameters()

public String getRestRequestMethod()

public String getRestUrl()

public String getServiceType()

public String getSoapBody()

public String getSoapRequestMethod()

public String getSoapServiceFunction()

public Map<String, Object> getVariables()

public String getVerificationScript()

public String getWsdlAddress()

public void setBodyContent(HttpBodyContent bodyContent)

public void setHttpBody(String httpBody)

public void setHttpHeaderProperties(List<TestObjectProperty> httpHeaderProperties)

public void setName(String name)

public void setObjectId(String objectId)

public void setRestParameters(List<TestObjectProperty> restParameters)

public void setRestRequestMethod(String restRequestMethod)

public void setRestUrl(String restUrl)

public void setServiceType(String serviceType)

public void setSoapBody(String soapBody)

public void setSoapRequestMethod(String soapRequestMethod)

public void setSoapServiceFunction(String soapServiceFunction)

public void setVariables(Map<String, Object> variables)

public void setVerificationScript(String verificationScript)

public void setWsdlAddress(String wsdlAddress)