com.vk.api.sdk.queries.database

Class DatabaseGetUniversitiesQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<DatabaseGetUniversitiesQuery,GetUniversitiesResponse>

com.vk.api.sdk.queries.database.DatabaseGetUniversitiesQuery

public class DatabaseGetUniversitiesQuery
extends AbstractQueryBuilder<DatabaseGetUniversitiesQuery,GetUniversitiesResponse>

Query for Database.getUniversities method

Constructor Summary

Constructors

Constructor and Description
DatabaseGetUniversitiesQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
DatabaseGetUniversitiesQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
DatabaseGetUniversitiesQuery	cityId(java.lang.Integer value) City ID.
DatabaseGetUniversitiesQuery	count(java.lang.Integer value) Number of universities to return.
DatabaseGetUniversitiesQuery	countryId(java.lang.Integer value) Country ID.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected DatabaseGetUniversitiesQuery	getThis() Get reference to this object
DatabaseGetUniversitiesQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of universities.
DatabaseGetUniversitiesQuery	q(java.lang.String value) Search query.

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, getQueryHeaders, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version, withHeader, withHeaders

Methods inherited from class com.vk.api.sdk.client.ApiRequest

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseGetUniversitiesQuery

public DatabaseGetUniversitiesQuery(VkApiClient client,
                                    UserActor actor)

Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

DatabaseGetUniversitiesQuery

public DatabaseGetUniversitiesQuery(VkApiClient client,
                                    ServiceActor actor)

Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

Method Detail

q

public DatabaseGetUniversitiesQuery q(java.lang.String value)

Search query.

Parameters:

value - value of "q" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

countryId

public DatabaseGetUniversitiesQuery countryId(java.lang.Integer value)

Country ID.

Parameters:

value - value of "country id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

cityId

public DatabaseGetUniversitiesQuery cityId(java.lang.Integer value)

City ID.

Parameters:

value - value of "city id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

offset

public DatabaseGetUniversitiesQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of universities.

Parameters:

value - value of "offset" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

count

public DatabaseGetUniversitiesQuery count(java.lang.Integer value)

Number of universities to return.

Parameters:

value - value of "count" parameter. Maximum is 10000. Minimum is 0. By default 100.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected DatabaseGetUniversitiesQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DatabaseGetUniversitiesQuery,GetUniversitiesResponse>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<DatabaseGetUniversitiesQuery,GetUniversitiesResponse>

Returns:

list of names