public interface

WebMessages

com.microstrategy.web.objects.WebMessages

Class Overview

The WebMessages interface simply represents a collection of WebMessage objects. This object cannot be directly instantiated, and must instead be obtained from WebInboxSource interface

Summary

Public Methods
abstract Enumeration elements()
Returns a java.util.Enumeration containing the items in the collection.
abstract WebMessage get(int index)
Return the WebMessage object according to the index.
abstract int getBlockSize()
Returns the max number of items in any block of messages.
abstract WebDisplayUnits getChildUnits()
Returns the collection of child display units, or null if the object is not a collection.
abstract int getMaxMessageCount()
Returns the max number of messages per user inbox.
abstract int getMessageCount()
Returns the total number of messages per user inbox including the child messages that are embedded in the document messages.
abstract int getSavedCount(int requestType)
Returns the count of the number of reports/documents from this collection that are saved on the Inbox Server filtered by the request Type.
abstract int getSavedCount()
Returns the count of the number of reports/documents from this collection that are saved on the Inbox Server
abstract int getSortBy()
Returns the current sorting field of EnumWebMessageSortByField on the current object.
abstract int getStartMessageIndex()
Returns the index of the starting message in the user inbox when only partial content is returned.
abstract String getTimeZone()
Returns the time zone from the inbox content tag.
abstract boolean isEmpty()
Return true if there is no WebMessage objects in the collection, else return false.
abstract boolean isSortAsc()
Returns the current sorting order.
abstract void removeFromInbox()
Removes all WebMessage objects currently in this collection.
abstract void setStatus(int newStatus)
Sets the status for all messages in this collection
abstract int size()
Return the number of WebMessage in this collection
abstract void sort(int newSortField, boolean ascending)
Sets the sorting field to the specified one and then sorts the collection in the specified sorting order.
abstract void sort(int newSortField)
Sets the sorting field to the specified one and then sorts the collection in the default order -- ascending order.

Public Methods

public abstract Enumeration elements ()

Returns a java.util.Enumeration containing the items in the collection.

Returns
  • An Enumeration object containing the objects in the collection.

public abstract WebMessage get (int index)

Return the WebMessage object according to the index.

Parameters
index 0-based index
Returns
  • The WebMessage object according to the index
Throws
IndexOutOfBoundsException If the index is less than 0 or greater than the size, an exception of IndexOutOfBoundsException will be thrown.

public abstract int getBlockSize ()

Returns the max number of items in any block of messages.

Returns
  • The max number of items in any block of messages.

public abstract WebDisplayUnits getChildUnits ()

Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.

Returns
  • The collection of child display units of this instance, or null if this object is not a collection.

public abstract int getMaxMessageCount ()

Returns the max number of messages per user inbox.

The default value of the max message count parameter is -1, which means that all messages will be brought back.

Returns
  • The max number of messages per user inbox.

public abstract int getMessageCount ()

Returns the total number of messages per user inbox including the child messages that are embedded in the document messages.

Returns
  • The total number of messages per user inbox including the child messages that are embedded in the document messages.

public abstract int getSavedCount (int requestType)

Returns the count of the number of reports/documents from this collection that are saved on the Inbox Server filtered by the request Type. Possible request types are listed in EnumDSSXMLRequestTypes

Returns
  • the count of the reports/documents (from this messages collection) of the request type saved on the Inbox Server

public abstract int getSavedCount ()

Returns the count of the number of reports/documents from this collection that are saved on the Inbox Server

Returns
  • the count of the reports/documents from this messages collection saved on the Inbox Server

public abstract int getSortBy ()

Returns the current sorting field of EnumWebMessageSortByField on the current object.

Returns

public abstract int getStartMessageIndex ()

Returns the index of the starting message in the user inbox when only partial content is returned. The starting message and the block size determine the window of the inbox messages

Returns
  • The index of the starting message in the user inbox when only partial content is returned.

public abstract String getTimeZone ()

Returns the time zone from the inbox content tag.

Returns
  • The time zone from the inbox content tag.

public abstract boolean isEmpty ()

Return true if there is no WebMessage objects in the collection, else return false.

Returns
  • True if there is no WebMessage objects in the collection, else return false.

public abstract boolean isSortAsc ()

Returns the current sorting order.

Returns
  • true if sorting order is ascending.

public abstract void removeFromInbox ()

Removes all WebMessage objects currently in this collection. If any messages are still executing, their execution is cancelled.

Throws
WebObjectsException Thrown if an error occurs in the XML creation.

public abstract void setStatus (int newStatus)

Sets the status for all messages in this collection

Throws
WebObjectsException Thrown if an error occurs in the XML creation.

public abstract int size ()

Return the number of WebMessage in this collection

Returns
  • The number of WebMessage objects inside this collection.

public abstract void sort (int newSortField, boolean ascending)

Sets the sorting field to the specified one and then sorts the collection in the specified sorting order.

Parameters
newSortField the specified new sorting type of EnumWebMessageSortByField.
ascending specifying the sorting order. True if sorting in ascending order.

public abstract void sort (int newSortField)

Sets the sorting field to the specified one and then sorts the collection in the default order -- ascending order.

Parameters
newSortField the specified new sorting type of EnumWebMessageSortByField.