OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MessageSmartMailboxSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A MessageQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Messages. The messages may be sequenced using the MessageSearchOrder from this session.

This Mailbox has a default query that matches any message and a default search order that specifies no sequencing. The queries may be examined using a MessageQueryInspector. The query may be modified by converting the inspector back to a MessageQuery.

MethodgetMailboxId
Description

Gets the Mailbox Id associated with this session.

Returnosid.id.Idthe Mailbox Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMailbox
Description

Gets the Mailbox associated with this session.

Returnosid.messaging.Mailboxthe Mailbox associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartMailboxes
Description

Tests if this user can manage smart mailboxes. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart mailbox management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMessageQuery
Description

Gets a message query.

Returnosid.messaging.MessageQuerythe message query
CompliancemandatoryThis method must be implemented.
MethodgetMessageSearchOrder
Description

Gets a message search order.

Returnosid.messaging.MessageSearchOrderthe message search order
CompliancemandatoryThis method must be implemented.
MethodapplyMessageQuery
Description

Applies a message query to this mailbox.

Parametersosid.messaging.MessageQuerymessageQuerythe message query
ErrorsNULL_ARGUMENT messageQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED messageQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecMessageQuery
Description

Gets a message query inspector for this mailbox.

Returnosid.messaging.MessageQueryInspectorthe message query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyMessageSequencing
Description

Applies a message search order to this mailbox.

Parametersosid.messaging.MessageSearchOrdermessageSearchOrderthe message search order
ErrorsNULL_ARGUMENT messageSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED messageSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetMessageQueryFromInspector
Description

Gets a message query from an inspector.

Parametersosid.messaging.MessageQueryInspectormessageQueryInspectora message query inspector
Returnosid.messaging.MessageQuerythe message query
ErrorsNULL_ARGUMENT messageQueryInspector is null
UNSUPPORTED messageQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.