org.osid.messaging

Interface MessagingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

MessagingManager, MessagingProxyManager

public interface MessagingProfile
extends OsidProfile

The message profile describes interoperability among message services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getMailboxRecordTypes() Gets all the mailbox record types supported.
TypeList	getMailboxSearchRecordTypes() Gets all the mailbox search record types supported.
TypeList	getMessageRecordTypes() Gets all the message record types supported.
TypeList	getMessageSearchRecordTypes() Gets all the message search record types supported.
TypeList	getReceiptRecordTypes() Gets all the receipt record types supported.
boolean	supportsMailboxAdmin() Tests if mailbox administration is supported.
boolean	supportsMailboxHierarchy() Tests if a mailbox hierarchy traversal is supported.
boolean	supportsMailboxHierarchyDesign() Tests if a mailbox hierarchy design is supported.
boolean	supportsMailboxLookup() Tests if mailbox lookup is supported.
boolean	supportsMailboxNotification() Tests if mailbox notification is supported.
boolean	supportsMailboxRecordType(Type mailboxRecordType) Tests if a given mailbox record type is supported.
boolean	supportsMailboxSearch() Tests if mailbox search is supported.
boolean	supportsMailboxSearchRecordType(Type mailboxSearchRecordType) Tests if a given mailbox search record type is supported.
boolean	supportsMessageAdmin() Tests if creating, updating and deleting messages is supported.
boolean	supportsMessageLookup() Tests if message lookup is supported.
boolean	supportsMessageMailbox() Tests if retrieving mappings of message and mailboxes is supported.
boolean	supportsMessageMailboxAssignment() Tests if managing mappings of messages and mailboxes is supported.
boolean	supportsMessageNotification() Tests if message notification is supported.
boolean	supportsMessageQuery() Tests if querying messages is supported.
boolean	supportsMessageRecordType(Type messageRecordType) Tests if a given message record type is supported.
boolean	supportsMessageSearch() Tests if message search is supported.
boolean	supportsMessageSearchRecordType(Type messageSearchRecordType) Tests if a given message search type is supported.
boolean	supportsMessageSmartMailbox() Tests if a messaging smart mailbox service is supported.
boolean	supportsMessaging() Tests if sending messages is supported.
boolean	supportsMessagingBatch() Tests if a messaging batch service is supported.
boolean	supportsReceiptAdmin() Tests if updating receipts is supported.
boolean	supportsReceiptLookup() Tests if receipt lookup is supported.
boolean	supportsReceiptNotification() Tests if receipts notification is supported.
boolean	supportsReceiptRecordType(Type receiptRecordType) Tests if a given receipt record type is supported.
boolean	supportsVisibleFederation() Tests if federation is visible.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessaging

boolean supportsMessaging()

Tests if sending messages is supported.

Returns:

true if message sending is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessageLookup

boolean supportsMessageLookup()

Tests if message lookup is supported.

Returns:

true if message lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessageQuery

boolean supportsMessageQuery()

Tests if querying messages is supported.

Returns:

true if message query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessageSearch

boolean supportsMessageSearch()

Tests if message search is supported.

Returns:

true if message search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessageAdmin

boolean supportsMessageAdmin()

Tests if creating, updating and deleting messages is supported.

Returns:

true if message administration is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessageNotification

boolean supportsMessageNotification()

Tests if message notification is supported. Messages may be sent when messages are created, modified, or deleted.

Returns:

true if message notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessageMailbox

boolean supportsMessageMailbox()

Tests if retrieving mappings of message and mailboxes is supported.

Returns:

true if message mailbox mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessageMailboxAssignment

boolean supportsMessageMailboxAssignment()

Tests if managing mappings of messages and mailboxes is supported.

Returns:

true if message mailbox assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessageSmartMailbox

boolean supportsMessageSmartMailbox()

Tests if a messaging smart mailbox service is supported.

Returns:

true if a message smart mailbox service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsReceiptLookup

boolean supportsReceiptLookup()

Tests if receipt lookup is supported.

Returns:

true if receipt lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsReceiptAdmin

boolean supportsReceiptAdmin()

Tests if updating receipts is supported.

Returns:

true if receipt administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsReceiptNotification

boolean supportsReceiptNotification()

Tests if receipts notification is supported. Messages may be sent when receipts are created, modified, or deleted.

Returns:

true if receipt notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMailboxLookup

boolean supportsMailboxLookup()

Tests if mailbox lookup is supported.

Returns:

true if mailbox lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMailboxSearch

boolean supportsMailboxSearch()

Tests if mailbox search is supported.

Returns:

true if mailbox search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMailboxAdmin

boolean supportsMailboxAdmin()

Tests if mailbox administration is supported.

Returns:

true if mailbox administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMailboxNotification

boolean supportsMailboxNotification()

Tests if mailbox notification is supported. Messages may be sent when Mailbox objects are created, deleted or updated. Notifications for messages within mailboxes are sent via the message notification session.

Returns:

true if mailbox notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMailboxHierarchy

boolean supportsMailboxHierarchy()

Tests if a mailbox hierarchy traversal is supported.

Returns:

true if a mailbox hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMailboxHierarchyDesign

boolean supportsMailboxHierarchyDesign()

Tests if a mailbox hierarchy design is supported.

Returns:

true if a mailbox hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMessagingBatch

boolean supportsMessagingBatch()

Tests if a messaging batch service is supported.

Returns:

true if a messaging batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getMessageRecordTypes

TypeList getMessageRecordTypes()

Gets all the message record types supported.

Returns:

the list of supported message record types

Compliance:

mandatory - This method must be implemented.

supportsMessageRecordType

boolean supportsMessageRecordType(Type messageRecordType)

Tests if a given message record type is supported.

Parameters:

messageRecordType - the message type

Returns:

true if the message record type is supported , false otherwise

Throws:

NullArgumentException - messageRecordType is null

Compliance:

mandatory - This method must be implemented.

getMessageSearchRecordTypes

TypeList getMessageSearchRecordTypes()

Gets all the message search record types supported.

Returns:

the list of supported message search record types

Compliance:

mandatory - This method must be implemented.

supportsMessageSearchRecordType

boolean supportsMessageSearchRecordType(Type messageSearchRecordType)

Tests if a given message search type is supported.

Parameters:

messageSearchRecordType - the message search type

Returns:

true if the message search record type is supported , false otherwise

Throws:

NullArgumentException - messageSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getReceiptRecordTypes

TypeList getReceiptRecordTypes()

Gets all the receipt record types supported.

Returns:

the list of supported receipt record types

Compliance:

mandatory - This method must be implemented.

supportsReceiptRecordType

boolean supportsReceiptRecordType(Type receiptRecordType)

Tests if a given receipt record type is supported.

Parameters:

receiptRecordType - the mesreceiptsage type

Returns:

true if the receipt record type is supported , false otherwise

Throws:

NullArgumentException - receiptRecordType is null

Compliance:

mandatory - This method must be implemented.

getMailboxRecordTypes

TypeList getMailboxRecordTypes()

Gets all the mailbox record types supported.

Returns:

the list of supported mailbox record types

Compliance:

mandatory - This method must be implemented.

supportsMailboxRecordType

boolean supportsMailboxRecordType(Type mailboxRecordType)

Tests if a given mailbox record type is supported.

Parameters:

mailboxRecordType - the mailbox record type

Returns:

true if the mailbox record type is supported , false otherwise

Throws:

NullArgumentException - mailboxRecordType is null

Compliance:

mandatory - This method must be implemented.

getMailboxSearchRecordTypes

TypeList getMailboxSearchRecordTypes()

Gets all the mailbox search record types supported.

Returns:

the list of supported mailbox search record types

Compliance:

mandatory - This method must be implemented.

supportsMailboxSearchRecordType

boolean supportsMailboxSearchRecordType(Type mailboxSearchRecordType)

Tests if a given mailbox search record type is supported.

Parameters:

mailboxSearchRecordType - the mailbox search record type

Returns:

true if the mailbox search record type is supported , false otherwise

Throws:

NullArgumentException - mailboxSearchRecordType is null

Compliance:

mandatory - This method must be implemented.