net.sf.basedb.core
Interface AnnotatableProxy

All Superinterfaces:

AccessControlled, Annotatable, Identifiable

All Known Implementing Classes:

PluginConfiguration, PluginDefinition

public interface AnnotatableProxy
extends Annotatable

This interface is implemented by items that can be used to hold annotations that are intended for other items. This is for example used to enable plug-in configurations to hold annotation that can be copied to other items when a job using that configuration is executed. The RawDataFlatFileImporter supports this feature and can be used to automatically annotate a raw bioassay when raw data is imported.

Version:

2.5

Author:

Nicklas

See Also:

AnnotationSetterPlugin, AnnotationSet

Last modified

$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

Method Summary

String	getAnnotationMessage() A help message that should tell users how the proxied annotations are used.
ItemQuery<AnnotationType>	getAnnotationTypes() Get the annotation types that can be proxied.

Methods inherited from interface net.sf.basedb.core.Annotatable

getAnnotatableParents, getAnnotationSet, getProtocol, isAnnotated, removeAnnotations

Methods inherited from interface net.sf.basedb.core.Identifiable

getId, getType, getVersion

Methods inherited from interface net.sf.basedb.core.AccessControlled

checkPermission, getPermissions, hasPermission

Method Detail

getAnnotationTypes

ItemQuery<AnnotationType> getAnnotationTypes()

Get the annotation types that can be proxied. This is, for example, in the case of the RawDataFlatFileImporter all annotation types that can be used on raw bioassays.

Returns:

A query, or null if no annotation types can be used

getAnnotationMessage

String getAnnotationMessage()

A help message that should tell users how the proxied annotations are used.

Returns:

A message or null