Requests and obtains the details of particular event that
is identified by an event ID. The UMF API equivalent of the getEventDetailByID method
are the SOA_EVENT_DETAIL_BY_ID_REQUEST input document and the SOA_EVENT_DETAIL_BY_ID_RESPONSE
output document.
Syntax
getEventDetailByID
(
eventID,
depth
);
Description
Parameters
- eventID
- Type: long integer (64-bit)
- Nullable: No
- This parameter identifies the event for which the details are
being requested.
- 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
EventDetail event = provider.getEventDetail(eventID,
DepthSetting.STANDARD,
null);
if (event == null) {
System.out.println(“Event “ + eventID + “ does not exist.”);
} else {
String location = event.getLocation();
String memo1 = event.getMemo1();
BigDecimal quantity = event.getQuantity();
System.out.println(”Event ” + eventID + “ exists.”);
System.out.println(“Location: “+ location);
System.out.println(“Memo: “ + memo1);
System.out.println(“Quantity: “ + quantity);
}
Description
Returns
- getEventDetailByIDResponse
- eventDetail
- Nullible: Yes
- If the return value is null, then the subject event was not found,
otherwise an EventDetail object is returned describing the entity
to various degrees of detail depending 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.