Skip navigation links

com.oracle.sft.api
Interface MessageSummary

public interface MessageSummary

This interface encapsulates the NOTIFY Bodies for MWI notification.

Method Summary

Collection<MessageSummaryExtensionHeader>	getAllExtensionHeaders() Returns all extension headers.
Collection<MessageSummaryLine>	getAllMessageSummaryLines() Returns all message summary lines.
String	getBasicMessageSummary() Return a String only include basic Message Summary of this message.
MessageSummaryExtensionHeader	getExtensionHeader(String messageID) Get a ExtensionHeader which Message-ID is specified.
String	getFullMessageSummary() Return a String include full Message Summary of this message.
URI	getMessageAccount() Returns the value of the message account.
MessageSummaryLine	getMessageSummaryLine(MessageContextClass messageContextClass) Get a message summary line which MessageContextClass is specified.
boolean	getStatusLine() Returns the value of the status line.
void	removeExtensionHeader(String messageID) Remove a extension header which Message-ID is specified.
void	removeMessageSummaryLine(MessageContextClass messageContextClass) Remove a message summary line which MessageContextClass is specified.
void	setExtensionHeader(String messageID, String to, String from, String subject, String date, String priority) Set a extension header which Message-ID is specified.
void	setMessageAccount(URI messageAccount) Set the value of the message account.
void	setMessageSummaryLine(MessageContextClass messageContextClass, int newMessageCount, int oldMessageCount, int newUrgentMessageCount, int oldUrgentMessageCount) Set a message summary line which MessageContextClass is specified.
void	setStatusLine(boolean status) Set the value of the status line.

Method Detail

getStatusLine

boolean getStatusLine()

Returns the value of the status line.

Returns:

the value of the status line.

setStatusLine

void setStatusLine(boolean status)

Set the value of the status line.

Parameters:

status -

getMessageAccount

URI getMessageAccount()

Returns the value of the message account.

Returns:

the value of the message account.

setMessageAccount

void setMessageAccount(URI messageAccount)

Set the value of the message account.

Parameters:

messageAccount -

getAllMessageSummaryLines

Collection<MessageSummaryLine> getAllMessageSummaryLines()

Returns all message summary lines.

Returns:

all message summary lines.

setMessageSummaryLine

void setMessageSummaryLine(MessageContextClass messageContextClass,
                           int newMessageCount,
                           int oldMessageCount,
                           int newUrgentMessageCount,
                           int oldUrgentMessageCount)

Set a message summary line which MessageContextClass is specified. If it doesn't exist a new one will be created.

Parameters:

messageContextClass -

newMessageCount -

oldMessageCount -

newUrgentMessageCount -

oldUrgentMessageCount -

getMessageSummaryLine

MessageSummaryLine getMessageSummaryLine(MessageContextClass messageContextClass)

Get a message summary line which MessageContextClass is specified.

Parameters:

messageContextClass -

Returns:

a message summary line.

removeMessageSummaryLine

void removeMessageSummaryLine(MessageContextClass messageContextClass)

Remove a message summary line which MessageContextClass is specified.

Parameters:

messageContextClass - summary line

getAllExtensionHeaders

Collection<MessageSummaryExtensionHeader> getAllExtensionHeaders()

Returns all extension headers.

Returns:

all extension headers.

setExtensionHeader

void setExtensionHeader(String messageID,
                        String to,
                        String from,
                        String subject,
                        String date,
                        String priority)

Set a extension header which Message-ID is specified. If it doesn't exist a new ExtensionHeader will be created.

Parameters:

messageID -

getExtensionHeader

MessageSummaryExtensionHeader getExtensionHeader(String messageID)

Get a ExtensionHeader which Message-ID is specified.

Parameters:

messageID -

Returns:

a extension header.

removeExtensionHeader

void removeExtensionHeader(String messageID)

Remove a extension header which Message-ID is specified.

Parameters:

messageID -

getBasicMessageSummary

String getBasicMessageSummary()

Return a String only include basic Message Summary of this message.

Returns:

a MessageSummary.

getFullMessageSummary

String getFullMessageSummary()

Return a String include full Message Summary of this message.

Returns:

a MessageSummary.

Skip navigation links