|
BEA Systems, Inc. | |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface is a base interface for paging cursor implementations. It defines methods for manipulating a result set maintained on the server. Methods for accessing items in the result set return arrays of javax.management.openmbean.CompositeData objects. Each component that implements this interface is responsible for converting item objects to self-describing CompositeData objects. An instance of a cursor is represented by a handle.
This is a type-safe interface for a
WebLogic Server MBean, which you can import into your client
classes and access through
weblogic.management.MBeanHome
. As of 9.0, the
MBeanHome
interface and all type-safe interfaces for
WebLogic Server MBeans are deprecated. Instead, client classes that
interact with WebLogic Server MBeans should use standard JMX design
patterns in which clients use the
javax.management.MBeanServerConnection
interface to
discover MBeans, attributes, and attribute types at runtime. For
more information, see "Developing Manageable Applications with JMX"
on http://edocs.bea.com.
CompositeData
Method Summary | |
Void |
closeCursor(String cursorHandle)
Releases the server-side resources associated with the cursor and removes the runtime MBean instance. |
Long |
getCursorEndPosition(String cursorHandle)
Returns the cursor end position in the result set. |
Long |
getCursorSize(String cursorHandle)
Returns the number of items in the result set. |
Long |
getCursorStartPosition(String cursorHandle)
Returns the cursor start position in the result set. |
CompositeData[] |
getItems(String cursorHandle,
Long start,
Integer count)
Returns an array of items from the specified cursor location. |
CompositeData[] |
getNext(String cursorHandle,
Integer count)
Returns an array of items starting from the current cursor end position. |
CompositeData[] |
getPrevious(String cursorHandle,
Integer count)
Returns an array of items up to the current cursor start position. |
Methods inherited from interface weblogic.management.WebLogicMBean |
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, 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 |
public Void closeCursor(String cursorHandle) throws ManagementException
Releases the server-side resources associated with the cursor and removes the runtime MBean instance.
cursorHandle
- The cursor handle.
ManagementException
public Long getCursorEndPosition(String cursorHandle) throws ManagementException
Returns the cursor end position in the result set.
cursorHandle
- The cursor handle.
ManagementException
public Long getCursorSize(String cursorHandle) throws ManagementException
Returns the number of items in the result set.
cursorHandle
- The cursor handle.
ManagementException
public Long getCursorStartPosition(String cursorHandle) throws ManagementException
Returns the cursor start position in the result set.
cursorHandle
- The cursor handle.
ManagementException
public CompositeData[] getItems(String cursorHandle, Long start, Integer count) throws ManagementException
Returns an array of items from the specified cursor location. The new cursor start position will be the location after the old cursor end position. The size of the array returned is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the return array is zero. In this case, the cursor position will not change.
cursorHandle
- The cursor handle.start
- The new cursor start location.count
- The maximum number of items to return.
ManagementException
CompositeData
public CompositeData[] getNext(String cursorHandle, Integer count) throws ManagementException
Returns an array of items starting from the current cursor end position. The new cursor start position is set to be the location of the first item returned to the caller. The new cursor end position is set according to the size of the array returned, which is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the array is zero. In this case, the cursor position will not change.
cursorHandle
- The cursor handle.count
- The maximum number of items to return.
ManagementException
CompositeData
public CompositeData[] getPrevious(String cursorHandle, Integer count) throws ManagementException
Returns an array of items up to the current cursor start position. The new start position will be placed at the location of the first item in the set returned to the caller. The new cursor end position will be placed at the location after the last item in the set that is returned.
cursorHandle
- The cursor handle.count
- The maximum number of item to return.
ManagementException
CompositeData
|
Documentation is available at http://e-docs.bea.com/wls/docs90 Copyright 2005 BEA Systems Inc. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |