Class ListsService
- java.lang.Object
-
- org.intermine.webservice.server.WebService
-
- org.intermine.webservice.server.lists.AvailableListsService
-
- org.intermine.webservice.server.lists.ListsService
-
public class ListsService extends AvailableListsService
Web service that returns all public lists (bags) that contain object with specified id. SeeListsRequestParser
for parameter description URL examples:-
Get all public lists with specified intermine id:
/listswithobject?format=xml&id=1343743
-
Get all public lists with specified id, corresponding intermine id is found with lookup:
/listswithobject?format=xml&publicId=1343743
- Author:
- Jakub Kulaviak
-
Get all public lists with specified intermine id:
-
-
Field Summary
-
Fields inherited from class org.intermine.webservice.server.WebService
dataPackageOutput, DEFAULT_CALLBACK, im, os, out, output, request, response, webProperties
-
-
Constructor Summary
Constructors Constructor Description ListsService(InterMineAPI im)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.Collection<InterMineBag>
getLists()
Executes service specific logic.-
Methods inherited from class org.intermine.webservice.server.lists.AvailableListsService
canServe, execute, getDefaultFormat, getListsMatching
-
Methods inherited from class org.intermine.webservice.server.WebService
cleanUp, 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, postInit, service, setFormat, setNameSpace, validateState, wantsColumnHeaders, wantsDataPackage
-
-
-
-
Constructor Detail
-
ListsService
public ListsService(InterMineAPI im)
Constructor- Parameters:
im
- The InterMine API
-
-
Method Detail
-
getLists
protected java.util.Collection<InterMineBag> getLists()
Executes service specific logic.- Overrides:
getLists
in classAvailableListsService
- Returns:
- The lists relevant to this request.
-
-