net.sf.sail.core.beans.service
Interface AnnotationService

public interface AnnotationService

Author:

scott

Method Summary

IAnnotation	getAnnotation(java.lang.Object sailEntity, IAgent agent, java.lang.String source) Returns the first annotation associated with this entity and agent which has the requested source.
IAnnotation[]	getAnnotations(java.lang.Object sailEntity, IAgent agent) Return the list of annotations associated with this entity and agent.
boolean	isAvailable() Indicates if this annotation server actually return annotations.

Method Detail

getAnnotations

IAnnotation[] getAnnotations(java.lang.Object sailEntity,
                             IAgent agent)

Return the list of annotations associated with this entity and agent.

Parameters:

sailEntity - currently this has to be a Pod or Rim

agent - this is typically a workgroup

Returns:

getAnnotation

IAnnotation getAnnotation(java.lang.Object sailEntity,
                          IAgent agent,
                          java.lang.String source)

Returns the first annotation associated with this entity and agent which has the requested source.

Parameters:

sailEntity -

agent -

source -

Returns:

isAvailable

boolean isAvailable()

Indicates if this annotation server actually return annotations. It is possible for an annotation service to be registered which is not configured correctly so it cannot return annotations.

Returns: