net.sf.basedb.ws.server
Class AnnotationTypeService

java.lang.Object
  net.sf.basedb.ws.server.AbstractRPCService
      net.sf.basedb.ws.server.AnnotationTypeService

public class AnnotationTypeService
extends AbstractRPCService

Web service class for annotation types. AnnotationType.

Version:

2.5

Author:

Nicklas

Field Summary

Fields inherited from class net.sf.basedb.ws.server.AbstractRPCService

util

Constructor Summary

AnnotationTypeService()

Method Summary

AnnotationTypeInfo[]	getAnnotationTypes(String ID, String itemType, QueryOptions qOpt) Gets information about annotation types that are available for an active session.
AnnotationTypeInfo	getById(String ID, int itemId) Get information about an annotation type that you know the ID of.

Methods inherited from class net.sf.basedb.ws.server.AbstractRPCService

attachFile, getRemoteId, getSessionControl

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationTypeService

public AnnotationTypeService()

Method Detail

getById

public AnnotationTypeInfo getById(String ID,
                                  int itemId)

Get information about an annotation type that you know the ID of.

Parameters:

ID - Id to identify the session.

itemId - The ID of the annotation type

Returns:

The annotation type information

getAnnotationTypes

public AnnotationTypeInfo[] getAnnotationTypes(String ID,
                                               String itemType,
                                               QueryOptions qOpt)

Gets information about annotation types that are available for an active session.

Parameters:

ID - Id to identify the session.

itemType - Only return annotation types for a specific item type. The value is the string representation of Enum.name(). Use null to return annotation types for all item types

qOpt - QueryOptions to use when getting the projects

Returns:

Information objects in an array for each found annotation type.