org.exoplatform.social.client.api.service
Interface QueryParams

All Known Implementing Classes:

QueryParamsImpl

public interface QueryParams

This class allows setting query params for services, this usually the optional params.

Since:

Oct 6, 2011, 1.0.0-alpha2

Author:

hoatle (hoatlevan at gmail dot com)

Nested Class Summary

static class

QueryParams.QueryParamOption Defines the Query Parameter for create Base URL.

Field Summary

static QueryParams.QueryParamOption	ACTIVITY_STREAM_PARAM
static QueryParams.QueryParamOption	IDENTITY_ID_PARAM
static QueryParams.QueryParamOption	LIMIT_PARAM
static QueryParams.QueryParamOption	MAX_ID_PARAM
static QueryParams.QueryParamOption	NUMBER_OF_COMMENTS_PARAM
static QueryParams.QueryParamOption	NUMBER_OF_LIKES_PARAM
static QueryParams.QueryParamOption	POSTER_IDENTITY_PARAM
static QueryParams.QueryParamOption	SINCE_ID_PARAM

Method Summary

QueryParams	append(QueryParams.QueryParamOption param) Append the query parameter for build URL Request.
String	buildQuery() Builds the query string based on the setted value.
void	clear() Clear all of Query Parameters.
QueryParams.QueryParamOption	get(QueryParams.QueryParamOption param) Gets QueryParamOption which was existing.
QueryParams	remove(QueryParams.QueryParamOption param) Removes the query parameter.

Field Detail

IDENTITY_ID_PARAM

static final QueryParams.QueryParamOption IDENTITY_ID_PARAM

POSTER_IDENTITY_PARAM

static final QueryParams.QueryParamOption POSTER_IDENTITY_PARAM

NUMBER_OF_COMMENTS_PARAM

static final QueryParams.QueryParamOption NUMBER_OF_COMMENTS_PARAM

NUMBER_OF_LIKES_PARAM

static final QueryParams.QueryParamOption NUMBER_OF_LIKES_PARAM

ACTIVITY_STREAM_PARAM

static final QueryParams.QueryParamOption ACTIVITY_STREAM_PARAM

LIMIT_PARAM

static final QueryParams.QueryParamOption LIMIT_PARAM

SINCE_ID_PARAM

static final QueryParams.QueryParamOption SINCE_ID_PARAM

MAX_ID_PARAM

static final QueryParams.QueryParamOption MAX_ID_PARAM

Method Detail

append

QueryParams append(QueryParams.QueryParamOption param)

Append the query parameter for build URL Request.

Parameters:

param -

Returns:

remove

QueryParams remove(QueryParams.QueryParamOption param)

Removes the query parameter.

Parameters:

param -

Returns:

buildQuery

String buildQuery()

Builds the query string based on the setted value. For example output: limit=20&since_id=1234&number_of_comments=7

Returns:

clear

void clear()

Clear all of Query Parameters.

get

QueryParams.QueryParamOption get(QueryParams.QueryParamOption param)

Gets QueryParamOption which was existing.

Parameters:

param -

Returns: