TemplateTagAddingService (InterMine 5.0.0 API)

java.lang.Object
- org.intermine.webservice.server.WebService
- - org.intermine.webservice.server.core.JSONService
  - - org.intermine.webservice.server.template.TemplateTagService
    - - org.intermine.webservice.server.template.TemplateTagAddingService

Direct Known Subclasses:

TemplateTagRemovalService
```
public class TemplateTagAddingService
extends TemplateTagService
```
A service for adding tags to a template.

Author:

Julie Sullivan

Field Summary
- 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

TemplateTagAddingService(InterMineAPI im)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`execute()`	Runs service.
`protected void`	`modifyTemplate(java.util.Set<java.lang.String> tags, ApiTemplate template)`	Modify the list by adding the tags.

Methods inherited from class org.intermine.webservice.server.template.TemplateTagService
getHeaderAttributes

Methods inherited from class org.intermine.webservice.server.core.JSONService
addOutputInfo, addResultEntries, addResultEntries, addResultEntry, addResultEntry, addResultItem, addResultItem, addResultValue, addResultValue, addResultValue, getDefaultFormat, 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, validateState, wantsColumnHeaders, wantsDataPackage

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

- Constructor Detail
  - TemplateTagAddingService
```
public TemplateTagAddingService(InterMineAPI im)
```
    Constructor.
    
    Parameters:
    
    im - The InterMine API settings.
- 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.
    
    Overrides:
    
    execute in class TemplateTagService
    
    Throws:
    
    java.lang.Exception - if some error occurs
  - modifyTemplate
```
protected void modifyTemplate(java.util.Set<java.lang.String> tags,
                              ApiTemplate template)
```
    Modify the list by adding the tags.
    
    Parameters:
    
    tags - The tags to add.
    
    template - The template to tag