Package org.intermine.webservice.server.lists

Class ListUpdateService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.core.JSONService

org.intermine.webservice.server.lists.AbstractListService

org.intermine.webservice.server.lists.AuthenticatedListService

org.intermine.webservice.server.lists.ListUpdateService

public class ListUpdateService
extends AuthenticatedListService

A service for updating list descriptions.

Author:

Daniela Butano

Field Summary

Fields inherited from class org.intermine.webservice.server.lists.AbstractListService

LIST_DESCRIPTION_KEY, LIST_ID_KEY, LIST_NAME_KEY, 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
ListUpdateService(InterMineAPI im)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	execute()	Runs service.

Methods inherited from class org.intermine.webservice.server.lists.AuthenticatedListService

validateState

Methods inherited from class org.intermine.webservice.server.lists.AbstractListService

getClassesForBags, 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, 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, wantsColumnHeaders, wantsDataPackage

Methods inherited from class java.lang.Object

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

Constructor Detail

ListUpdateService

public ListUpdateService(InterMineAPI im)

Constructor.

Parameters:

im - The InterMine application object.

Method Detail

execute

protected void execute()
                throws java.lang.Exception

Description copied from class: WebService

Runs service. This is abstract method, that must be defined in subclasses and so performs something useful. Standard procedure is overwrite this method in subclasses and let this method to be called from WebService.doGet method that encapsulates logic common for all web services else you can overwrite doGet method in your web service class and manage all the things alone.

Specified by:

execute in class WebService

Throws:

java.lang.Exception - if some error occurs