com.authlete.common.dto

Class ClientListResponse

java.lang.Object

com.authlete.common.dto.ClientListResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthorizedClientListResponse

public class ClientListResponse
extends Object
implements Serializable

Response from Authlete's /client/get/list API.

Author:

Takahiko Kawasaki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientListResponse()

Method Summary

Modifier and Type	Method and Description
Client[]	getClients() Get the list of clients that match the query conditions.
String	getDeveloper() Get the developer specified in the query.
int	getEnd() Get the end index (exclusive) for the result set of the query.
int	getStart() Get the start index (inclusive) for the result set of the query.
int	getTotalCount() Get the total count of client applications either of the service (when developer is null) or of the developer (when developer is not null).
ClientListResponse	setClients(Client[] clients) Set the list of clients that match the query conditions.
ClientListResponse	setDeveloper(String developer) Set the developer.
ClientListResponse	setEnd(int end) Set the end index (exclusive) for the result set of the query.
ClientListResponse	setStart(int start) Set the start index (inclusive) for the result set of the query.
ClientListResponse	setTotalCount(int count) Set the total count of client applications either of the service (when developer is null) or of the developer (when developer is not null).

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientListResponse

public ClientListResponse()

Method Detail

getStart

public int getStart()

Get the start index (inclusive) for the result set of the query. It is the value contained in the original request (= the value of 'start' parameter), or the default value (0) if the original request did not contain the parameter.

Returns:

The start index for the result set of the query.

setStart

public ClientListResponse setStart(int start)

Set the start index (inclusive) for the result set of the query.

Parameters:

start - The start index for the result set of the query.

Returns:

this object.

getEnd

public int getEnd()

Get the end index (exclusive) for the result set of the query. It is the value contained in the original request (= the value of 'end' parameter), or the default value defined in Authlete server if the original request did not contain the parameter.

Returns:

The end index for the result set of the query.

setEnd

public ClientListResponse setEnd(int end)

Set the end index (exclusive) for the result set of the query.

Parameters:

end - The end index for the result set of the query.

Returns:

this object.

getDeveloper

public String getDeveloper()

Get the developer specified in the query. It is the value contained in the original request (= the value of 'developer' parameter) or null. When null, it means that all the clients that belong to the service are targeted.

Returns:

The developer unique ID assigned by the service. May be null if the original request was not bound to any developer.

setDeveloper

public ClientListResponse setDeveloper(String developer)

Set the developer.

Parameters:

developer - The developer unique ID assigned by the service.

Returns:

this object.

getTotalCount

public int getTotalCount()

Get the total count of client applications either of the service (when developer is null) or of the developer (when developer is not null).

The value returned by this method is not the size of the array returned by getClients(). Instead, it is the total count of the client applications (either of the service or of the developer) which exist in Authlete's database.

Returns:

The total count of client applications.

setTotalCount

public ClientListResponse setTotalCount(int count)

Set the total count of client applications either of the service (when developer is null) or of the developer (when developer is not null).

Parameters:

count - The total count of client applications.

Returns:

this object.

getClients

public Client[] getClients()

Get the list of clients that match the query conditions.

Returns:

List of clients, or null when no client matched the query conditions.

setClients

public ClientListResponse setClients(Client[] clients)

Set the list of clients that match the query conditions.

Parameters:

clients - List of clients, or null when no client matched the query conditions.

Returns:

this object.