AbstractListService (InterMine 5.0.0 API)

java.lang.Object
- org.intermine.webservice.server.WebService
- - org.intermine.webservice.server.core.JSONService
  - - org.intermine.webservice.server.lists.AbstractListService

Direct Known Subclasses:

AuthenticatedListService, ListTagService
```
public abstract class AbstractListService
extends JSONService
```
Base class for list services.

Author:

Alex Kalderimis

Field Summary

Fields
Modifier and Type	Field	Description
`protected static java.lang.String`	`LIST_DESCRIPTION_KEY`
`protected static java.lang.String`	`LIST_ID_KEY`
`protected static java.lang.String`	`LIST_NAME_KEY`
`protected static java.lang.String`	`LIST_SIZE_KEY`

Fields inherited from class org.intermine.webservice.server.core.JSONService
bagManager, model

Fields inherited from class org.intermine.webservice.server.WebService
dataPackageOutput, DEFAULT_CALLBACK, im, os, out, output, request, response, webProperties

Constructor Summary

Constructors
Constructor Description

AbstractListService(InterMineAPI im)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.util.Set<ClassDescriptor>`	`getClassesForBags(java.util.Collection<InterMineBag> bags)`	Get the classes represented by a collection of bags.
`protected ListInput`	`getInput()`

Methods inherited from class org.intermine.webservice.server.core.JSONService
addOutputInfo, addResultEntries, addResultEntries, addResultEntry, addResultEntry, addResultItem, addResultItem, addResultValue, addResultValue, addResultValue, getDefaultFormat, getHeaderAttributes, getResultsKey, lazyList, postInit

Methods inherited from class org.intermine.webservice.server.WebService
canServe, cleanUp, execute, formatIsFlatFile, formatIsJSON, formatIsJSONP, formatIsXML, getAuthenticatedUser, getCallback, getColumnHeaderStyle, getDefaultFileName, getDefaultOutput, getDefaultOutput, getExtension, getFormat, getIntParameter, getIntParameter, getLineBreak, getListManager, getOptionalParameter, getOptionalParameter, getPermission, getProperty, getRawOutput, getRequestFileName, getRequiredParameter, hasCallback, initState, isAuthenticated, isGzip, isUncompressed, isZip, makeJSONOutput, makeXMLOutput, service, setFormat, setNameSpace, validateState, wantsColumnHeaders, wantsDataPackage

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

- Field Detail
  - LIST_NAME_KEY
```
protected static final java.lang.String LIST_NAME_KEY
```
    See Also:
    
    Constant Field Values
  - LIST_SIZE_KEY
```
protected static final java.lang.String LIST_SIZE_KEY
```
    See Also:
    
    Constant Field Values
  - LIST_ID_KEY
```
protected static final java.lang.String LIST_ID_KEY
```
    See Also:
    
    Constant Field Values
  - LIST_DESCRIPTION_KEY
```
protected static final java.lang.String LIST_DESCRIPTION_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractListService
```
public AbstractListService(InterMineAPI im)
```
    Parameters:
    
    im - The InterMine state object
- Method Detail
  - getClassesForBags
```
protected java.util.Set<ClassDescriptor> getClassesForBags(java.util.Collection<InterMineBag> bags)
```
    Get the classes represented by a collection of bags.
    
    Parameters:
    
    bags - The bags.
    
    Returns:
    
    The classes.
  - getInput
```
protected ListInput getInput()
```
    Returns:
    
    The Input for this request.