com.ibm.portal.um.exceptions
Class SizeLimitExceedException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.portal.um.exceptions.PumaException
              extended by com.ibm.portal.um.exceptions.PumaSystemException
                  extended by com.ibm.portal.um.exceptions.SizeLimitExceedException
All Implemented Interfaces:
Localized, java.io.Serializable

public class SizeLimitExceedException
extends PumaSystemException

A SizeLimitExceedException is thrown if the search result exceeds a
defined maximum amount of entries to be returned.
The exception can be handled by either increasing the max allowed entries of a search result or by redefining the search query.

Since:
5.1.0.1
See Also:
Serialized Form

Constructor Summary
protected SizeLimitExceedException(java.lang.Throwable cause)
           
 
Method Summary
 int getActualResult()
          Returns the size of the performed search result.
 int getMaxResultLimit()
          Returns the maximum size of a search result.
 
Methods inherited from class com.ibm.portal.um.exceptions.PumaException
getDescription, getLocales, getTitle
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SizeLimitExceedException

protected SizeLimitExceedException(java.lang.Throwable cause)
Parameters:
cause -
Method Detail

getMaxResultLimit

public int getMaxResultLimit()
Returns the maximum size of a search result. If this information is not provided by the subsystem -1 will be returned

Returns:
max search result

getActualResult

public int getActualResult()
Returns the size of the performed search result. If this information is not provided by the subsystem -1 will be returned

Returns:
actual search result