Additional search methods in Classification Manager OMAS

[mandy-chessell]

Description

This PR adds methods to Classification Manager OMAS to:

• getElements - Retrieve elements of the requested type name. If no type name is specified then any type of element may be returned.

• getElementsByPropertyValue - Retrieve elements by a value found in one of the properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the results.

• findElementsByPropertyValue - Retrieve elements by a value found in one of the properties specified. The value must be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.

• getElementsByClassification (any element type) - Retrieve elements with the requested classification name. It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of element may be returned.

• getElementsByClassification (specific element type) - Retrieve elements with the requested classification name. It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of element may be returned.

• getElementsByClassificationWithPropertyValue - Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.

• findElementsByClassificationWithPropertyValue - Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must only be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.

• getRelatedElements - Retrieve elements linked via the requested relationship type name (or any relationship type). It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of element may be returned.

• getRelatedElements (all relationship types, all element types) - Retrieve elements linked via the any relationship type name. It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of element may be returned.

• getRelatedElements - Retrieve elements linked via the requested relationship type name. It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of
  element may be returned.

• getRelatedElementsWithPropertyValue - Retrieve elements linked via the requested relationship type name and with the requested a value found in one of the classification's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.

• findRelatedElementsWithPropertyValue - Retrieve elements linked via the requested relationship type name and with the requested value found in one of the relationship's properties specified. The value must only be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.

• getRelationships - Retrieve relationships of the requested relationship type name.

• getRelationshipsWithPropertyValue - Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must match exactly.

• findRelationshipsWithPropertyValue - Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must only be contained in the properties rather than needing to be an exact match.

• name retrieveInstanceForGUID - Retrieve the header for the instance identified by the supplied unique identifier. It may be an element (entity) or a relationship between elements.

Related Issue(s)

Some of the other search methods were not specifying the find search string correctly and these have been fixed.

Testing

Manual testing with the CocoComboArchive content pack loaded. This has many types of elements and relationships to test/

Release Notes & Documentation

The classifcation manager OMVS's web page needs updating with this new capability (wip)

Additional notes

There are a few more methods to add:

• searching for a string in any type of element or relationship
• retrieving the history of an element or a relationship
• a generic search that allows a complex search argument to be specified.