SAFMessageCursorRuntimeMBean (Java API Reference for Oracle WebLogic Server)

Class

Use

Tree

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.runtime
Interface SAFMessageCursorRuntimeMBean

All Superinterfaces:: CursorRuntimeMBean, DynamicMBean, MBeanRegistration, MessageCursorRuntimeMBean, 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.

Since:: 9.0.0.0

Method Summary
`abstract Long`	`sort(String cursorHandle, Long start, String[] fields, 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.MessageCursorRuntimeMBean
`getMessage, getMessage`

Methods inherited from interface weblogic.management.runtime.CursorRuntimeMBean
`closeCursor, getCursorEndPosition, getCursorSize, getCursorStartPosition, getItems, getNext, getPrevious`

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`

Methods inherited from interface javax.management.DynamicMBean
`getAttribute, getAttributes, invoke, setAttribute, setAttributes`

Methods inherited from interface javax.management.MBeanRegistration
`postDeregister, postRegister, preDeregister, preRegister`

Methods inherited from interface javax.management.NotificationBroadcaster
`addNotificationListener, getNotificationInfo, removeNotificationListener`

Method Detail

sort

Long sort(String cursorHandle,
          Long start,
          String[] fields,
          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.

Overview

Package