ListResponse (SCIM API Model 1.1.4 API)

java.lang.Object
- io.jans.scim.model.scim2.ListResponse

```
public class ListResponse
extends Object
```
This class models the contents of a search response. See section 3.4.2 RFC 7644.

Author:

Rahat Ali Date: 05.08.2015

Constructor Summary

Constructors
Constructor	Description
`ListResponse()`	Default no arg constructor.
`ListResponse(int sindex, int ippage, int total)`	Constructs a list response with the arguments supplied, and `schemas` initialized properly.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addResource(BaseScimResource resource)`	Adds the resource to the list of results of this `ListResponse`.
`int`	`getItemsPerPage()`
`List<BaseScimResource>`	`getResources()`	Retrieves a list with all resources contained in this `ListResponse`.
`List<String>`	`getSchemas()`
`int`	`getStartIndex()`
`int`	`getTotalResults()`
`void`	`setResources(List<BaseScimResource> resources)`
`void`	`setSchemas(List<String> schemas)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListResponse
```
public ListResponse()
```
    Default no arg constructor. It creates a instance of ListResponse with the schemas properly initialized.
  - ListResponse
```
public ListResponse(int sindex,
                    int ippage,
                    int total)
```
    Constructs a list response with the arguments supplied, and schemas initialized properly.
    
    Parameters:
    
    sindex - Specifies a start index
    
    ippage - Specifies a number of items per page
    
    total - Specifies a total number of results
- Method Detail
  - addResource
```
public void addResource(BaseScimResource resource)
```
    Adds the resource to the list of results of this ListResponse.
    
    Parameters:
    
    resource - A SCIM resource
  - getTotalResults
```
public int getTotalResults()
```
  - getStartIndex
```
public int getStartIndex()
```
  - getItemsPerPage
```
public int getItemsPerPage()
```
  - getResources
```
public List<BaseScimResource> getResources()
```
    Retrieves a list with all resources contained in this ListResponse.
    
    Returns:
    
    A List of BaseScimResource objects
  - setResources
```
public void setResources(List<BaseScimResource> resources)
```
  - getSchemas
```
public List<String> getSchemas()
```
  - setSchemas
```
public void setSchemas(List<String> schemas)
```