Obtains details on all configured event types. The UMF
API equivalent of the getEventTypes method are the
SOA_EVENT_TYPES_REQUEST input document and the SOA_EVENT_TYPES_RESPONSE
output document.
Syntax
getEventTypes
(
additionalinfo
);
Description
Parameters
- additionalinfo
- Type: CustomInformation
- Nullable: Yes
- Uncustomized, a null value is passed for this parameter. It is
reserved for field customizations to the WSDL and XSLT transforms
without changing the signature of the method. Professional services
engineers can use this parameter to derive their own type from “CustomInformation”
type in the WSDL and modify the XSLT transforms to place data from
that type into UMF tags that are passed to the pipeline. In addition,
they must modify the DQM Rules and UMF Builder configuration to recognize
and utilize the additional data.
Example Request
EventTypeDetail[] types = provider.getEventTypes(null);
int typeCount = 0;
if (types != null) typeCount = types.length;
for (int index = 0; index < typeCount; index++) {
EventTypeDetail type = types[index];
System.out.println(“Type “ + index + “: “ + type.getTypeCode());
}
Description
Returns
- eventTypes
- Nullable? = Yes
- If the returned array is null or an empty then there are no configured
event types. Otherwise, the returned array contains the EventTypeDetail
instances describing all configured event types.
- minOccurs="0"
- type="xsd_3:EventTypeDetail"
- EventTypeDetail
- internalID
- type="xsd:long"
- typeCode
- type="xsd:string"
- description
- minOccurs="0"
- type="xsd:long"
- category
- minOccurs="0"
- type="xsd:string"
- subcategory
- minOccurs="0"
- type="xsd:long"
- unitOfMeasure
- minOccurs="0"
- type="xsd:long"
- memoLabel1
- minOccurs="0"
- type="xsd:decimal"
- memoLabel2
- minOccurs="0"
- type="xsd:decimal"
- status
- minOccurs="0"
- type="xsd_3:Status
- Status
- type="xsd:string"
- Values: ACTIVE, INACTIVE, OTHER
- lastModifiedTimestamp
- minOccurs="0"
- type="xsd:dateTime"
- timestamp
- minOccurs="0"
- type="xsd:dateTime"
- Exceptions
- Type = [Generic Fault]
- Cause = If an internal failure occurred.