Requests and obtains the details of those events that match
the specified criteria. The UMF API equivalent of the getEventDetailByFilter method
are the SOA_EVENT_DETAIL_BY_FILTER_REQUEST input document and the
SOA_EVENT_DETAIL_BY_FILTER_RESPONSE output document.
Syntax
getEventDetailByFilter
(
filter,
depth
);
Description
Parameters
- filter
- Type: EventFilter
- Nullable: Yes
- This parameter identifies contains nullable fields which can be
used for filtering the results. You must provide at least one filtering
parameter. Failure to provide at least one filter-criteria causes
an error-message: "No filter parameters found. When performing a filtered
SOA call, at least one parameter must be present. Please correct the
input and try again."
- depth
- Abstract parameter type: DepthSpecifer
- Default Concrete Type: DepthSetting
- Nullable: Yes
- This parameter indicates the level of detail for the response.
If not specified, then DepthSetting.FULL is assumed. This is the only
recognized value.
- Valid Values: FULL
Example Request
EventFilter filter = new EventFilter();
filter.setStatus(alertStatus);
filter.setMinQuantity(new BigDecimal(“400.00”));
EventDetail[] events
= provider.getEventDetailssByFilter(filter,
DepthSetting.FULL,
null);
int eventCount = 0;
if ((events == null) || (events.length == 0)) {
System.out.println(“No events match the criteria.”);
} else {
eventCount = events.length;
}
for (int index = 0; index < eventCount; index++) {
EventDetail event = events[index];
String location = event.getLocation();
String memo1 = event.getMemo1();
BigDecimal quantity = event.getQuantity();
System.out.println(“--------------------------“);
System.out.println(”Event ” + eventID + “ exists.”);
System.out.println(“Location: “+ location);
System.out.println(“Memo: “ + memo1);
System.out.println(“Quantity: “ + quantity);
}
Description
Returns
- eventDetail
- Nullible: Yes
- If the return value is null or an empty array then no events were
found matching the specified criteria. Otherwise, the returned array
contains one or more EventDetail objects describing the matching events.
The degree of detail to which the EventDetail objects are populated
depends on the specified depth parameter.
- minOccurs="0"
- type="xsd_3:EventDetail"
- EventDetail
- identityHandle
- type=" xsd_1:IdentityHandle"
- IdentityHandle
- internalID
- type="xsd:long"
- externalID
- type="xsd:string"
- dataSourceCode
- type="xsd:string"
- externalReference
- type="xsd:string"
- internalID
- type="xsd:long"
- eventReference
- type="xsd:string"
- eventTypeID
- type="xsd:long"
- location
- type="xsd:string"
- memo1
- type="xsd:long"
- memo2
- type="xsd:long"
- quantity
- type="xsd:decimal"
- value
- type="xsd:decimal"
- unitValue
- type="xsd:decimal"
- startDate
- type="xsd:dateTime"
- endDate
- type="xsd:dateTime"
- timestamp
- type="xsd:dateTime"
Exceptions
- [Generic Fault]
- Cause: An internal failure occurred.