Package com.ptc.windchill.ws
Class ContentHandle
java.lang.Object
com.ptc.windchill.ws.ContentHandle
- All Implemented Interfaces:
Serializable
The ContentHandle class is a bean class that defines the HTTP method
and URL to be used in uploading or downloading a content item to/from
a Windchill server.
Supported API: true
Extendable: false
Supported API: true
Extendable: false
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanCompares this object to another for equality.Gets the HTTP method to be used to dereference this ContentHandle.getParameter(String name) Gets a parameter value by name.getParameter(String name, String dflt) Gets a parameter value by name.Gets a Map of parameters (query arguments) on the underlying URL.getUrl()Gets the underlying URL.voidSets the HTTP method to be used when dereferencing this ContentHandle.voidsetParameter(String name, String value) Sets a parameter by name to a value.voidSets the underlying URL.
-
Constructor Details
-
ContentHandle
public ContentHandle()Creates a new ContentHandle.
Supported API: true
-
-
Method Details
-
getMethod
Gets the HTTP method to be used to dereference this ContentHandle.
Supported API: true- Returns:
- e.g. "GET", "POST", etc.
-
setMethod
Sets the HTTP method to be used when dereferencing this ContentHandle.
Supported API: true- Parameters:
method- The method. e.g. "GET", "POST", etc.
-
getUrl
Gets the underlying URL.
Supported API: true- Returns:
- The underlying URL.
-
setUrl
Sets the underlying URL.
Supported API: true- Parameters:
url- The new URL.
-
getParameters
Gets a Map of parameters (query arguments) on the underlying URL.
Supported API: true- Returns:
- A String to String, name to value Map of parameters.
-
getParameter
Gets a parameter value by name.
Supported API: true- Parameters:
name- The parameter name to retrieve.- Returns:
- The parameter value or null.
-
getParameter
Gets a parameter value by name.
Supported API: true- Parameters:
name- The parameter name to retrieve.dflt- The default value to return if the parameter is not set.- Returns:
- The parameter value or dflt.
-
setParameter
Sets a parameter by name to a value.
Supported API: true- Parameters:
name- The parameter name.value- The parameter value.
-
equals
Compares this object to another for equality.
Supported API: true
-