oracle.mail.sdk.esmail
Class AnnotateSortCriteria

java.lang.Object
  |
  +--oracle.mail.sdk.esmail.OracleSortCriteria
        |
        +--oracle.mail.sdk.esmail.AnnotateSortCriteria

public class AnnotateSortCriteria

extends OracleSortCriteria

This class supports sorting based on annotations/comments and is an extension to the Standard JMA functionality. A user can construct the AnnotateSortCriteria based on a combination of the entry_name and value string OR entry_name and size of the value string.

Field Summary

static java.lang.String	ANNOTATE
static int	ANNOTATE_VALUE
static int	ANNOTATE_VALUE_SIZE

Fields inherited from class oracle.mail.sdk.esmail.OracleSortCriteria

ASC, CC, DESC, FROM, INTERNAL_DATE, MSG_SIZE, SENT_DATE, SUBJECT, TO

Constructor Summary

AnnotateSortCriteria(java.lang.String key, int valueSize, int sortOrder)
Constructor

AnnotateSortCriteria(java.lang.String key, int valueType, java.lang.String theValueOrtheSize, int sortOrder)
Constructor

AnnotateSortCriteria(java.lang.String key, java.lang.String value, int sortOrder)
Constructor

Method Summary

int	getType() getType - value or size of value.
int	getValueSize() getValueSize - getter for the size of the annotation value.
java.lang.String	getValueString() getValueString - Use this method to get the string representing the annotation value.
void	print()

Methods inherited from class oracle.mail.sdk.esmail.OracleSortCriteria

getHeader, getOrder, setHeader, setOrder

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

ANNOTATE

public static final java.lang.String ANNOTATE

Constructor Detail

AnnotateSortCriteria

public AnnotateSortCriteria(java.lang.String key,
                            int valueType,
                            java.lang.String theValueOrtheSize,
                            int sortOrder)
                     throws java.lang.Exception

Constructor

Parameters:

key - - annotation entry name

valueType - - ANNOTATE_VALUE(value string) or ANNOTATE_VALUE_SIZE(value size)

theValueOrtheSize - - string representation of value or value size

sortOrder - - OracleSortCriteria.ASC, OracleSortCriteria.DESC

AnnotateSortCriteria

public AnnotateSortCriteria(java.lang.String key,
                            java.lang.String value,
                            int sortOrder)
                     throws java.lang.Exception

Constructor

Parameters:

key - - annotation entry name

value - - value string

sortOrder - - OracleSortCriteria.ASC, OracleSortCriteria.DESC

AnnotateSortCriteria

public AnnotateSortCriteria(java.lang.String key,
                            int valueSize,
                            int sortOrder)
                     throws java.lang.Exception

Constructor

Parameters:

key - - annotation entry name

valueSize - - Size of the annotate value

sortOrder - - OracleSortCriteria.ASC, OracleSortCriteria.DESC

Method Detail

getValueString

public java.lang.String getValueString()

getValueString - Use this method to get the string representing the annotation value.

Returns:

String

getValueSize

public int getValueSize()

getValueSize - getter for the size of the annotation value.

Returns:

int

getType

public int getType()

getType - value or size of value.

Returns:

int ANNOTATE_VALUE or ANNOTATE_VALUE_SIZE

print

public void print()

Overrides:

print in class OracleSortCriteria