| com.microstrategy.web.objects.WebMessages |
The WebMessages interface simply represents a collection of
WebMessage objects. This object cannot be directly instantiated,
and must instead be obtained from WebInboxSource interface
| 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.
| ||||||||||
Returns a java.util.Enumeration containing the items in the collection.
Return the WebMessage object according to the index.
| index | 0-based index |
|---|
| IndexOutOfBoundsException | If the index is less than 0 or greater than the size, an exception of IndexOutOfBoundsException will be thrown. |
|---|
Returns the max number of items in any block of messages.
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.
| WebObjectsException |
|---|
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 total number of messages per user inbox including the child messages that are embedded in the document messages.
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
| WebObjectsException |
|---|
Returns the count of the number of reports/documents from this collection that are saved on the Inbox Server
| WebObjectsException |
|---|
Returns the current sorting field of EnumWebMessageSortByField on the current object.
EnumWebMessageSortByField.
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 time zone from the inbox content tag.
Return true if there is no WebMessage objects in the collection, else return false.
WebMessage objects in the collection, else return false.
Returns the current sorting order.
Removes all WebMessage objects currently in this collection. If any messages are still executing,
their execution is cancelled.
| WebObjectsException | Thrown if an error occurs in the XML creation. |
|---|
Sets the status for all messages in this collection
| WebObjectsException | Thrown if an error occurs in the XML creation. |
|---|
Return the number of WebMessage in this collection
WebMessage objects inside this collection.
Sets the sorting field to the specified one and then sorts the collection in the specified sorting order.
| newSortField | the specified new sorting type of EnumWebMessageSortByField. |
|---|---|
| ascending | specifying the sorting order. True if sorting in ascending order. |
Sets the sorting field to the specified one and then sorts the collection in the default order -- ascending order.
| newSortField | the specified new sorting type of EnumWebMessageSortByField.
|
|---|