OSID - osid.messaging.MessageLookupSession Service Interface Definition

Interface	osid.messaging.MessageLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving messages. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated mailbox view: All message methods in this session operate, retrieve and pertain to messages defined explicitly in the current mailbox. Using an isolated view is useful for managing `Messages` with the `MessageAdminSession.` federated mailbox view: All message methods in this session operate, retrieve and pertain to all messages defined in this mailbox and any other messages implicitly available in this mailbox through mailbox inheritence. The methods `useFederatedMailboxView()` and `useIsolatedMailboxView()` behave as a radio group and one should be selected before invoking any lookup methods. Messages may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Message.`
Method	getMailboxId
Description	Gets the `Mailbox` `Id` associated with this session.
Return	`osid.id.Id`		the `Mailbox Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMailbox
Description	Gets the `Mailbox` associated with this session.
Return	`osid.messaging.Mailbox`		the `Mailbox` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupMessages
Description	Tests if this user can perform `Message` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeMessageView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryMessageView
Description	A complete view of the `Message` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedMailboxView
Description	Federates the view for methods in this session. A federated view will include messages in mailboxes which are children of this mailbox in the mailbox hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMailboxView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this mailbox only.
Compliance	`mandatory`		This method is must be implemented.
Method	getMessage
Description	Gets the `Message` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Message` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Message` and retained for compatibility.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Message` to retrieve
Return	`osid.messaging.Message`		the returned `Message`
Errors	NOT_FOUND		no `Message` found with the given `Id`
	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByIds
Description	Gets a `MessageList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the messages specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Messages` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`messageIds`	the list of `Ids` to retrieve
Return	`osid.messaging.MessageList`		the returned `Message list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`messageIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByGenusType
Description	Gets a `MessageList` corresponding to the given message genus `Type` which does not include messages of types derived from the specified `Type.` In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.type.Type`	`messageGenusType`	a message genus type
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`messageGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByParentGenusType
Description	Gets a `MessageList` corresponding to the given message genus `Type` and include any additional messages with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session
Parameters	`osid.type.Type`	`messageGenusType`	a message genus type
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`messageGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByRecordType
Description	Gets a `MessageList` containing the given message record `Type.` In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.type.Type`	`messageRecordType`	a message record type
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`messageRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesBySentTime
Description	Gets a `MessageList` sent within the specified range inclusive. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesBySentTimeAndGenusType
Description	Gets a `MessageList` of the given genus type and sent within the specified range inclusive. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.type.Type`	`messageGenusType`	a message genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`messageGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesFromSender
Description	Gets a `MessageList` sent by the specified sender. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource Id
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByGenusTypeFromSender
Description	Gets a `MessageList` of the given genus type and sender. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource Id
Parameters	`osid.type.Type`	`messageGenusType`	a message genus type
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`resourceId` or `messageGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesBySentTimeFromSender
Description	Gets a `MessageList` sent by the specified sender and sent time. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session
Parameters	`osid.id.Id`	`resourceId`	a resource Id
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesBySentTimeAndGenusTypeFromSender
Description	Gets a `MessageList` of the given genus type and sent within the specified range inclusive. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource Id
	`osid.type.Type`	`messageGenusType`	a message genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, messageGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesForRecipient
Description	Gets a `MessageList` received by the specified recipient. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource Id
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByGenusTypeForRecipient
Description	Gets a `MessageList` received by the specified recipient. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource Id
Parameters	`osid.type.Type`	`messageGenusType`	a message genus type
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`resourceId` or `messageGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByReceivedTimeForRecipient
Description	Gets a `MessageList` received by the specified resource and received time. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource Id
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByReceivedTimeAndGenusTypeForRecipient
Description	Gets a `MessageList` of the given genus type received by the specified resource and received time. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource Id
	`osid.type.Type`	`messageGenusType`	a message genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, messageGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesFromSenderForRecipient
Description	Gets a `MessageList` sent by the specified sender and received by the specified recipient. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`senderResourceId`	a resource Id
Parameters	`osid.id.Id`	`recipientResourceId`	a resource Id
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`senderResourceId` or `recipientResourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByGenusTypeFromSenderForRecipient
Description	Gets a `MessageList` of the given genus type sent by the specified sender and received by the specified recipient. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`senderResourceId`	a resource Id
	`osid.id.Id`	`recipientResourceId`	a resource Id
	`osid.type.Type`	`messageGenusType`	a message genus type
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	NULL_ARGUMENT		`senderResourceId, recipientResourceId` or `messageGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByReceivedTimeFromSenderForRecipient
Description	Gets a `MessageList` by the specified sender, recipient, and received time. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`senderResourceId`	a resource Id
	`osid.id.Id`	`recipientResourceId`	a resource Id
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`senderResourceId, recipientResourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByReceivedTimeAndGenusTypeFromSenderForRecipient
Description	Gets a `MessageList` of the given genus type and received by the specified resource and received time. In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Parameters	`osid.id.Id`	`senderResourceId`	a resource Id
	`osid.id.Id`	`recipientResourceId`	a resource Id
	`osid.type.Type`	`messageGenusType`	a message genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.messaging.MessageList`		the returned `Message` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`senderResourceId, recipientResourceId, messageGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessages
Description	Gets all `Messages.` In plenary mode, the returned list contains all known messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.
Return	`osid.messaging.MessageList`		a list of `Messages`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.