com.timestock.tess.webservices.api
Interface IEventsDataOutService

All Superinterfaces:
java.rmi.Remote

public interface IEventsDataOutService
extends java.rmi.Remote

This web service provides methods to fetch CEM event data objects - defects and incidents.


Method Summary
 DDefect getDefectById(long defectId)
          Gets a specified Defect.
 DDefectRS getDefectsByBusinessProcess(long businessProcessId, java.util.Date startTime, java.util.Date endTime, int startIndex)
          Gets the Defects that happened in a specified time range, and are associated with a specified Business Process.
 DDefectRS getDefectsByBusinessTransaction(long businessTransactionId, java.util.Date startTime, java.util.Date endTime, int startIndex)
          Gets the Defects that happened in a specified time range, and are associated with a specified Business Transaction.
 DDefectRS getDefectsByIncident(long incidentId, java.util.Date startTime, java.util.Date endTime, int startIndex)
          Gets the Defects that happened in a specified time range, and are associated with a specified Incident.
 DDefectRS getDefectsByType(java.lang.String type, java.util.Date startTime, java.util.Date endTime, int startIndex)
          Gets the Defects that happened in a specified time range, and are of the specified type.
 DDefectRS getDefectsByUser(long userId, java.util.Date startTime, java.util.Date endTime, int startIndex)
          Gets the Defects that happened in a specified time range, and are associated with a specified User.
 DDefectRS getDefectsByUserGroup(long userGroupId, java.util.Date startTime, java.util.Date endTime, int startIndex)
          Gets the Defects that happened in a specified time range, and are associated with a specified User Group.
 DIncident getIncident(long incidentId)
          Gets a specified Incident.
 DIncidentRS getIncidentsByTime(java.util.Date startTime, java.util.Date endTime, int startIndex)
          Gets the Incidents that happened in a specified time range.
 

Method Detail

getIncident

DIncident getIncident(long incidentId)
                      throws java.rmi.RemoteException,
                             CEMWebServicesException
Gets a specified Incident. Throws exception if specified Incident is not found.

Parameters:
incidentId - the Incident id
Returns:
the Incident object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getIncidentsByTime

DIncidentRS getIncidentsByTime(java.util.Date startTime,
                               java.util.Date endTime,
                               int startIndex)
                               throws java.rmi.RemoteException,
                                      CEMWebServicesException
Gets the Incidents that happened in a specified time range. The number of Incident objects that are returned in one call are limited to avoid memory explosion on the server. The limit is specified as TESS configuration property "maxWebServiceRows" and the default value is 500.

Parameters:
startTime - The start time
endTime - The end Time
startIndex - The index position of the first row to return
Returns:
the Incident Resultset object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getDefectById

DDefect getDefectById(long defectId)
                      throws java.rmi.RemoteException,
                             CEMWebServicesException
Gets a specified Defect. Throws exception if specified Defect is not found.

Parameters:
defectId - the Defect id
Returns:
the Defect object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getDefectsByUser

DDefectRS getDefectsByUser(long userId,
                           java.util.Date startTime,
                           java.util.Date endTime,
                           int startIndex)
                           throws java.rmi.RemoteException,
                                  CEMWebServicesException
Gets the Defects that happened in a specified time range, and are associated with a specified User. The number of Defect objects that are returned in one call are limited to avoid memory explosion on the server. The limit is specified as TESS configuration property "maxWebServiceRows" and the default value is 500.

Parameters:
userId - the user id
startTime - The start time
endTime - The end Time
startIndex - The index position of the first row to return
Returns:
the Defect Resultset object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getDefectsByUserGroup

DDefectRS getDefectsByUserGroup(long userGroupId,
                                java.util.Date startTime,
                                java.util.Date endTime,
                                int startIndex)
                                throws java.rmi.RemoteException,
                                       CEMWebServicesException
Gets the Defects that happened in a specified time range, and are associated with a specified User Group. The number of Defect objects that are returned in one call are limited to avoid memory explosion on the server. The limit is specified as TESS configuration property "maxWebServiceRows" and the default value is 500.

Parameters:
userGroupId - the user group id
startTime - The start time
endTime - The end Time
startIndex - The index position of the first row to return
Returns:
the Defect Resultset object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getDefectsByBusinessTransaction

DDefectRS getDefectsByBusinessTransaction(long businessTransactionId,
                                          java.util.Date startTime,
                                          java.util.Date endTime,
                                          int startIndex)
                                          throws java.rmi.RemoteException,
                                                 CEMWebServicesException
Gets the Defects that happened in a specified time range, and are associated with a specified Business Transaction. The number of Defect objects that are returned in one call are limited to avoid memory explosion on the server. The limit is specified as TESS configuration property "maxWebServiceRows" and the default value is 500.

Parameters:
businessTransactionId - the business transaction id
startTime - The start time
endTime - The end Time
startIndex - The index position of the first row to return
Returns:
the Defect Resultset object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getDefectsByBusinessProcess

DDefectRS getDefectsByBusinessProcess(long businessProcessId,
                                      java.util.Date startTime,
                                      java.util.Date endTime,
                                      int startIndex)
                                      throws java.rmi.RemoteException,
                                             CEMWebServicesException
Gets the Defects that happened in a specified time range, and are associated with a specified Business Process. The number of Defect objects that are returned in one call are limited to avoid memory explosion on the server. The limit is specified as TESS configuration property "maxWebServiceRows" and the default value is 500.

Parameters:
businessProcessId - the business process id
startTime - The start time
endTime - The end Time
startIndex - The index position of the first row to return
Returns:
the Defect Resultset object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getDefectsByType

DDefectRS getDefectsByType(java.lang.String type,
                           java.util.Date startTime,
                           java.util.Date endTime,
                           int startIndex)
                           throws java.rmi.RemoteException,
                                  CEMWebServicesException
Gets the Defects that happened in a specified time range, and are of the specified type. Possible values for defect type are: 1 (DEFECT_TYPE_SLOW_TRAN_TIME), 2 (DEFECT_TYPE_FAST_TRAN_TIME), 3 (DEFECT_TYPE_HIGH_THROUGHPUT), 4 (DEFECT_TYPE_LOW_THROUGHPUT), 5 (DEFECT_TYPE_LARGE_TRAN_SIZE), 6 (DEFECT_TYPE_SMALL_TRAN_SIZE), 8 (DEFECT_TYPE_HTTP_STATUS_ERROR), 9 (DEFECT_TYPE_MISSING_SUB_PART), 10 (DEFECT_TYPE_CONTENT_ERROR), 11 (DEFECT_TYPE_MISSING_RESPONSE), 16 (DEFECT_TYPE_PARTIAL_RESPONSE) You can also query for Defects which are not of a certain type by prefixing by "!". For example, to fetch all defects of type Slow Transaction Time, the type would be "1", and to fetch all defects which are not of type Slow Transaction Time, the type would be "!1". The number of Defect objects that are returned in one call are limited to avoid memory explosion on the server. The limit is specified as TESS configuration property "maxWebServiceRows" and the default value is 500.

Parameters:
type - the defect type
startTime - The start time
endTime - The end Time
startIndex - The index position of the first row to return
Returns:
the Defect Resultset object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0

getDefectsByIncident

DDefectRS getDefectsByIncident(long incidentId,
                               java.util.Date startTime,
                               java.util.Date endTime,
                               int startIndex)
                               throws java.rmi.RemoteException,
                                      CEMWebServicesException
Gets the Defects that happened in a specified time range, and are associated with a specified Incident. The number of Defect objects that are returned in one call are limited to avoid memory explosion on the server. The limit is specified as TESS configuration property "maxWebServiceRows" and the default value is 500.

Parameters:
incidentId - the incident id
startTime - The start time
endTime - The end Time
startIndex - The index position of the first row to return
Returns:
the Defect Resultset object
Throws:
CEMWebServicesException
java.rmi.RemoteException
Since:
4.0