OSID - osid.messaging.MessagingProfile Service Interface Definition

Interface	osid.messaging.MessagingProfile
Implements	`osid.OsidProfile`
Description	The message profile describes interoperability among message services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessaging
Description	Tests if sending messages is supported.
Return	`boolean`		`true` if message sending is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageLookup
Description	Tests if message lookup is supported.
Return	`boolean`		`true` if message lookup is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageQuery
Description	Tests if querying messages is supported.
Return	`boolean`		`true` if message query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageSearch
Description	Tests if message search is supported.
Return	`boolean`		`true` if message search is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageAdmin
Description	Tests if creating, updating and deleting messages is supported.
Return	`boolean`		`true` if message administration is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageNotification
Description	Tests if message notification is supported. Messages may be sent when messages are created, modified, or deleted.
Return	`boolean`		`true` if message notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageMailbox
Description	Tests if retrieving mappings of message and mailboxes is supported.
Return	`boolean`		`true` if message mailbox mapping retrieval is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageMailboxAssignment
Description	Tests if managing mappings of messages and mailboxes is supported.
Return	`boolean`		`true` if message mailbox assignment is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageSmartMailbox
Description	Tests if a messaging smart mailbox service is supported.
Return	`boolean`		`true` if a message smart mailbox service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsReceiptLookup
Description	Tests if receipt lookup is supported.
Return	`boolean`		`true` if receipt lookup is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsReceiptAdmin
Description	Tests if updating receipts is supported.
Return	`boolean`		`true` if receipt administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsReceiptNotification
Description	Tests if receipts notification is supported. Messages may be sent when receipts are created, modified, or deleted.
Return	`boolean`		`true` if receipt notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxLookup
Description	Tests if mailbox lookup is supported.
Return	`boolean`		`true` if mailbox lookup is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxSearch
Description	Tests if mailbox search is supported.
Return	`boolean`		`true` if mailbox search is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxAdmin
Description	Tests if mailbox administration is supported.
Return	`boolean`		`true` if mailbox administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxNotification
Description	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.
Return	`boolean`		`true` if mailbox notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxHierarchy
Description	Tests if a mailbox hierarchy traversal is supported.
Return	`boolean`		`true` if a mailbox hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxHierarchyDesign
Description	Tests if a mailbox hierarchy design is supported.
Return	`boolean`		`true` if a mailbox hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessagingBatch
Description	Tests if a messaging batch service is supported.
Return	`boolean`		`true` if a messaging batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMessageRecordTypes
Description	Gets all the message record types supported.
Return	`osid.type.TypeList`		the list of supported message record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageRecordType
Description	Tests if a given message record type is supported.
Parameters	`osid.type.Type`	`messageRecordType`	the message type
Return	`boolean`		`true` if the message record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`messageRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMessageSearchRecordTypes
Description	Gets all the message search record types supported.
Return	`osid.type.TypeList`		the list of supported message search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsMessageSearchRecordType
Description	Tests if a given message search type is supported.
Parameters	`osid.type.Type`	`messageSearchRecordType`	the message search type
Return	`boolean`		`true` if the message search record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`messageSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptRecordTypes
Description	Gets all the receipt record types supported.
Return	`osid.type.TypeList`		the list of supported receipt record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsReceiptRecordType
Description	Tests if a given receipt record type is supported.
Parameters	`osid.type.Type`	`receiptRecordType`	the mesreceiptsage type
Return	`boolean`		`true` if the receipt record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`receiptRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxRecordTypes
Description	Gets all the mailbox record types supported.
Return	`osid.type.TypeList`		the list of supported mailbox record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxRecordType
Description	Tests if a given mailbox record type is supported.
Parameters	`osid.type.Type`	`mailboxRecordType`	the mailbox record type
Return	`boolean`		`true` if the mailbox record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`mailboxRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxSearchRecordTypes
Description	Gets all the mailbox search record types supported.
Return	`osid.type.TypeList`		the list of supported mailbox search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsMailboxSearchRecordType
Description	Tests if a given mailbox search record type is supported.
Parameters	`osid.type.Type`	`mailboxSearchRecordType`	the mailbox search record type
Return	`boolean`		`true` if the mailbox search record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`mailboxSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.