Package weblogic.management.runtime

Interface SAFMessageCursorRuntimeMBean

All Superinterfaces:

CursorRuntimeMBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, MessageCursorRuntimeMBean, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

All Known Subinterfaces:

JMSRemoteEndpointRuntimeMBean, SAFRemoteEndpointRuntimeMBean, WSRMRemoteEndpointRuntimeMBean

public interface SAFMessageCursorRuntimeMBean
extends MessageCursorRuntimeMBean

This runtime MBean represents a handle to a SAF message result set. It is used for paging through large sets of messages. Messages are returned in an array of MessageInfo objects.

Method Summary

Modifier and Type	Method	Description
java.lang.Long	sort(java.lang.String cursorHandle, java.lang.Long start, java.lang.String[] fields, java.lang.Boolean[] ascending)	Sorts the entire message result set managed by the cursor according to the SAF header attributes specified.

Methods inherited from interface weblogic.management.runtime.CursorRuntimeMBean

closeCursor, getCursorEndPosition, getCursorSize, getCursorStartPosition, getItems, getNext, getPrevious

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface weblogic.management.runtime.MessageCursorRuntimeMBean

getMessage, getMessage

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Method Detail

sort

java.lang.Long sort(java.lang.String cursorHandle,
                    java.lang.Long start,
                    java.lang.String[] fields,
                    java.lang.Boolean[] ascending)
             throws ManagementException

Sorts the entire message result set managed by the cursor according to the SAF header attributes specified. The cursor position is set to the new position of the message corresponding to the "start" location before the sort is performed. The method returns the new cursor position.

Parameters:

cursorHandle - The handle of the cursor on which to perform the sort operation

start - The location of the message before the sort that will be the first message returned after the sort. A value of -1 will place the cursor start position at the head of the new sort order.

fields - The SAF header attributes on which to sort.

ascending - Determines whether the sort of the corresponding fields element is in ascending or descending order.

Returns:

The new position of the message specified by the start parameter.

Throws:

ManagementException - Thrown when an internal error occurs while processing the request.

Access limited to the following security roles:

Operator, Monitor