com.ptc.windchill.ws
Class ContentHandle

java.lang.Object
  com.ptc.windchill.ws.ContentHandle

All Implemented Interfaces:

Serializable

public class ContentHandle
extends Object
implements 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

See Also:

Serialized Form

Constructor Summary

ContentHandle()
Creates a new ContentHandle.

Method Summary

boolean	equals(Object obj) Compares this object to another for equality.
String	getMethod() Gets the HTTP method to be used to dereference this ContentHandle.
String	getParameter(String name) Gets a parameter value by name.
String	getParameter(String name, String dflt) Gets a parameter value by name.
Map	getParameters() Gets a Map of parameters (query arguments) on the underlying URL.
String	getUrl() Gets the underlying URL.
void	setMethod(String method) Sets the HTTP method to be used when dereferencing this ContentHandle.
void	setParameter(String name, String value) Sets a parameter by name to a value.
void	setUrl(String url) Sets the underlying URL.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContentHandle

public ContentHandle()

Creates a new ContentHandle.

Supported API: true

Method Detail

getMethod

public String getMethod()

Gets the HTTP method to be used to dereference this ContentHandle.

Supported API: true

Returns:

e.g. "GET", "POST", etc.

setMethod

public void setMethod(String method)

Sets the HTTP method to be used when dereferencing this ContentHandle.

Supported API: true

Parameters:

method - The method. e.g. "GET", "POST", etc.

getUrl

public String getUrl()

Gets the underlying URL.

Supported API: true

Returns:

The underlying URL.

setUrl

public void setUrl(String url)

Sets the underlying URL.

Supported API: true

Parameters:

url - The new URL.

getParameters

public Map 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

public String getParameter(String name)

Gets a parameter value by name.

Supported API: true

Parameters:

name - The parameter name to retrieve.

Returns:

The parameter value or null.

getParameter

public String getParameter(String name,
                           String dflt)

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

public void setParameter(String name,
                         String value)

Sets a parameter by name to a value.

Supported API: true

Parameters:

name - The parameter name.

value - The parameter value.

equals

public boolean equals(Object obj)

Compares this object to another for equality.

Supported API: true

Overrides:

equals in class Object

Returns:

true if the two objects are equivalent.