CohortListResponse (Repository Services General APIs 3.2 API)

java.lang.Object
- org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse
- - org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedResponse
  - - org.odpi.openmetadata.repositoryservices.rest.properties.CohortListResponse

All Implemented Interfaces:

Serializable
```
public class CohortListResponse
extends OMRSAPIPagedResponse
```
CohortListResponse support an OMRS REST API response that returns a list of cohort description objects.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedResponse
  nextPageURL, offset, pageSize
- Fields inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse
  actionDescription, exceptionCausedBy, exceptionClassName, exceptionErrorMessage, exceptionErrorMessageId, exceptionErrorMessageParameters, exceptionProperties, exceptionSystemAction, exceptionUserAction, relatedHTTPCode

Constructor Summary

Constructors
Constructor Description

CohortListResponse()
Default constructor

CohortListResponse(CohortListResponse template)
Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object objectToCompare)`	Compare the values of the supplied object with those stored in the current object.
`List<CohortDescription>`	`getCohorts()`	Return the list of cohorts.
`int`	`hashCode()`	Create a hash code for this element type.
`void`	`setCohorts(List<CohortDescription> cohorts)`	Set up the list of cohorts.
`String`	`toString()`	Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedResponse
getNextPageURL, getOffset, getPageSize, setNextPageURL, setOffset, setPageSize

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse
getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

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

- Constructor Detail
  - CohortListResponse
```
public CohortListResponse()
```
    Default constructor
  - CohortListResponse
```
public CohortListResponse(CohortListResponse template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getCohorts
```
public List<CohortDescription> getCohorts()
```
    Return the list of cohorts.
    
    Returns:
    
    entity list
  - setCohorts
```
public void setCohorts(List<CohortDescription> cohorts)
```
    Set up the list of cohorts.
    
    Parameters:
    
    cohorts - entity list
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class OMRSAPIPagedResponse
    
    Returns:
    
    print out of variables in a JSON-style
  - equals
```
public boolean equals(Object objectToCompare)
```
    Compare the values of the supplied object with those stored in the current object.
    
    Overrides:
    
    equals in class OMRSAPIPagedResponse
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Create a hash code for this element type.
    
    Overrides:
    
    hashCode in class OMRSAPIPagedResponse
    
    Returns:
    
    int hash code