com.rallydev.rest.request

Class CollectionUpdateRequest

java.lang.Object

com.rallydev.rest.request.Request

com.rallydev.rest.request.CollectionUpdateRequest

public class CollectionUpdateRequest
extends Request

Represents a WSAPI request to update a collection.

Field Summary

Fields inherited from class com.rallydev.rest.request.Request

gsonBuilder

Constructor Summary

Constructors

Constructor and Description
CollectionUpdateRequest(com.google.gson.JsonObject collection, com.google.gson.JsonArray items, boolean add) Create a new update request for the specified collection and values.
CollectionUpdateRequest(String collectionRef, com.google.gson.JsonArray items, boolean adding) Create a new update request for the specified collection and values.

Method Summary

Modifier and Type	Method and Description
String	getBody() Get the JSON encoded string representation of the object to be updated.
Fetch	getFetch() Get the current list of fields to be returned on the updated object.
void	setFetch(Fetch fetch) Set the current list of fields to be returned on the updated object.
String	toUrl() Convert this request into a url compatible with the WSAPI.

Methods inherited from class com.rallydev.rest.request.Request

addParam, getGsonBuilder, getParams, setGsonBuilder, setParams

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionUpdateRequest

public CollectionUpdateRequest(com.google.gson.JsonObject collection,
                               com.google.gson.JsonArray items,
                               boolean add)

Create a new update request for the specified collection and values. Note that this class is only usable with WSAPI versions 2.0 and above.

Parameters:

collection - the collection to be updated

items - the items to be added or removed

add - true if adding, false if removing

CollectionUpdateRequest

public CollectionUpdateRequest(String collectionRef,
                               com.google.gson.JsonArray items,
                               boolean adding)

Create a new update request for the specified collection and values.

Parameters:

collectionRef - the ref of the collection to be updated. May be absolute or relative, e.g. "/defect/12345/tags"

items - the items to be added or removed

adding - true if adding, false if removing

Method Detail

getBody

public String getBody()

Get the JSON encoded string representation of the object to be updated.

Returns:

the JSON encoded object

getFetch

public Fetch getFetch()

Get the current list of fields to be returned on the updated object.

By default all fields will be returned in the response (fetch=true).

Returns:

the current list of fields.

setFetch

public void setFetch(Fetch fetch)

Set the current list of fields to be returned on the updated object.

Parameters:

fetch - the list of fields to be returned.

toUrl

public String toUrl()

Convert this request into a url compatible with the WSAPI.

The current fetch and any other parameters will be included.

Specified by:

toUrl in class Request

Returns:

the url representing this request.