net.sitecore.android.sdk.api

Class RequestBuilder

java.lang.Object

net.sitecore.android.sdk.api.RequestBuilder

public class RequestBuilder
extends java.lang.Object

Helper class for building requests:

• ReadItemsRequest
• DeleteItemsRequest
• EditItemsRequest
• CreateItemRequest

Method Summary

Methods

Modifier and Type	Method and Description
RequestBuilder	apiVersion(int version) Specifies Sitecore Item Web API version.
ScRequest<? extends ScResponse>	build() Creates ScRequest with specified parameters.
RequestBuilder	byItemId(java.lang.String itemId) Specifies the ID of the content item.
RequestBuilder	byItemPath(java.lang.String path) Specifies item path.
RequestBuilder	bySitecoreQuery(java.lang.String query) Specifies Sitecore Query or Sitecore Fast Query
RequestBuilder	database(java.lang.String database) Specifies the database that contains the content items.
RequestBuilder	fromSite(java.lang.String site) Specifies site name for Sitecore site resolving mechanism.
RequestBuilder	itemVersion(int version) Specifies the version number of the content item.
RequestBuilder	setFields(java.util.Set<java.lang.String> fields) Specifies set of the fields to return in response.
RequestBuilder	setFields(java.lang.String... fields) Specifies set of fields to return in response.
RequestBuilder	setLanguage(java.lang.String language) Specifies the context language for the request.
RequestBuilder	setPage(int pageNumber, int pageSize) If the response contains numerous result items, you can use paging to obtain parts of the whole result set as pages.
RequestBuilder	updateFieldValue(java.lang.String key, java.lang.String value) Update field value.
RequestBuilder	withPayloadType(PayloadType payloadType) Specifies amount of fields to load.
RequestBuilder	withScope(RequestScope scope, RequestScope... otherScopes) Specifies the set of the items that you are working with.

Methods inherited from class java.lang.Object

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

Method Detail

apiVersion

public RequestBuilder apiVersion(int version)

Specifies Sitecore Item Web API version.

Parameters:

version - web api version.

Returns:

this builder.

fromSite

public RequestBuilder fromSite(java.lang.String site)

Specifies site name for Sitecore site resolving mechanism.

Parameters:

site - site name.

Returns:

this builder.

byItemPath

public RequestBuilder byItemPath(java.lang.String path)

Specifies item path.

Parameters:

path - item path.

Returns:

this builder.

byItemId

public RequestBuilder byItemId(java.lang.String itemId)

Specifies the ID of the content item.

Parameters:

itemId - item ID.

Returns:

this builder.

itemVersion

public RequestBuilder itemVersion(int version)

Specifies the version number of the content item.

By default the latest version is used.

Parameters:

version - item version.

Returns:

this builder.

database

public RequestBuilder database(java.lang.String database)

Specifies the database that contains the content items.

Parameters:

database - database name.

Returns:

this builder.

setLanguage

public RequestBuilder setLanguage(java.lang.String language)

Specifies the context language for the request.

Example : da-DK.

Default language : default.

Parameters:

language - language.

Returns:

this builder.

setFields

public RequestBuilder setFields(java.util.Set<java.lang.String> fields)

Specifies set of the fields to return in response.

Parameters:

fields - Set of fields names or IDs.

Returns:

this builder.

setFields

public RequestBuilder setFields(java.lang.String... fields)

Specifies set of fields to return in response.

Parameters:

fields - fields names or IDs.

Returns:

this builder.

withPayloadType

public RequestBuilder withPayloadType(PayloadType payloadType)

Specifies amount of fields to load. (MIN/CONTENT/FULL).

One of PayloadType.

Parameters:

payloadType - PayloadType of fields payload in response.

Returns:

this builder.

See Also:

PayloadType

withScope

public RequestBuilder withScope(RequestScope scope,
                       RequestScope... otherScopes)

Specifies the set of the items that you are working with.

Parameters:

scope - scope of items.

otherScopes - extra scopes of items.

Returns:

this builder.

Throws:

java.lang.IllegalArgumentException - if otherScopes > 2.

bySitecoreQuery

public RequestBuilder bySitecoreQuery(java.lang.String query)

Specifies Sitecore Query or Sitecore Fast Query

Parameters:

query - Sitecore query.

Returns:

this builder.

Throws:

java.lang.IllegalStateException - if query is already set.

setPage

public RequestBuilder setPage(int pageNumber,
                     int pageSize)

If the response contains numerous result items, you can use paging to obtain parts of the whole result set as pages.

Parameters:

pageNumber - number is the index of a given page in a set that starts with 0.

pageSize - page size is the number of the result items that are presented in the page. Should be greater than 0

Returns:

this builder.

Throws:

java.lang.IllegalArgumentException - if pageNumber < 0 or pageSize < 1.

updateFieldValue

public RequestBuilder updateFieldValue(java.lang.String key,
                              java.lang.String value)

Update field value. Used by CreateItemRequest and EditItemsRequest only.

Parameters:

key - field ID or name to update

value - updated field value

Returns:

this builder.

build

public ScRequest<? extends ScResponse> build()

Creates ScRequest with specified parameters.

Returns:

this builder.

Throws:

java.lang.IllegalArgumentException - if request method isn't recognized.