oracle.mail.sdk.esmail
Class AnnotateTerm

java.lang.Object
  |
  +--javax.mail.search.SearchTerm
        |
        +--oracle.mail.sdk.esmail.AnnotateTerm

public class AnnotateTerm

extends javax.mail.search.SearchTerm

This class implements a AnnotateTerm. With Oracle's Email Server OCS R3, the user has the ability to set annotations or comments on messages. Comments are key-value pairs. Per message, a user can choose to set comments. This specialized search term enables the user to search comments based on a cobination consisting of the key of the comment and either the size of of the value or the value string.

NOTE: ...

See Also:

Serialized Form

Field Summary

static int	ANNOTATE_VALUE
static int	ANNOTATE_VALUE_SIZE

Constructor Summary

AnnotateTerm(java.lang.String pattern, int valueSize)
Constructor

AnnotateTerm(java.lang.String pattern, int valueType, java.lang.String theValueOrtheSize)

AnnotateTerm(java.lang.String pattern, java.lang.String value)
Constructor

Method Summary

java.lang.String	getPattern() Return the entry name
int	getValueSize() Return the size of the annotation value
java.lang.String	getValueString() Return the annotation value
int	getValueType() Return the type of the annotation value
static void	main(java.lang.String[] args)
boolean	match(javax.mail.Message msg) Apply the search term to this message

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATE_VALUE

public static final int ANNOTATE_VALUE

ANNOTATE_VALUE_SIZE

public static final int ANNOTATE_VALUE_SIZE

Constructor Detail

AnnotateTerm

public AnnotateTerm(java.lang.String pattern,
                    int valueType,
                    java.lang.String theValueOrtheSize)
             throws java.lang.Exception

AnnotateTerm

public AnnotateTerm(java.lang.String pattern,
                    int valueSize)

Constructor

Parameters:

pattern - - annotation entry name

valueSize - - size of the value string

AnnotateTerm

public AnnotateTerm(java.lang.String pattern,
                    java.lang.String value)

Constructor

Parameters:

pattern - - annotation entry name

value - - the value string

Method Detail

match

public boolean match(javax.mail.Message msg)

Apply the search term to this message

Overrides:

match in class javax.mail.search.SearchTerm

Returns:

boolean

getPattern

public java.lang.String getPattern()

Return the entry name

Returns:

String entry_name

getValueString

public java.lang.String getValueString()

Return the annotation value

Returns:

String annotation_value

getValueSize

public int getValueSize()

Return the size of the annotation value

Returns:

int - Size of the annotation value

getValueType

public int getValueType()

Return the type of the annotation value

Returns:

int - ANNOTATION_VALUE or ANNOTATION_VALUE_SIZE

main

public static void main(java.lang.String[] args)