Package org.odpi.openmetadata.frameworks.governanceaction.client

Interface OpenMetadataTypesInterface

All Known Implementing Classes:

OpenMetadataClient

public interface OpenMetadataTypesInterface

OpenMetadataTypesInterface enables callers to query the defined open metadata types.

Method Summary

Modifier and Type	Method	Description
List<OpenMetadataAttributeTypeDef>	findAttributeTypeDefsByCategory(String userId, OpenMetadataAttributeTypeDefCategory category)	Returns all the AttributeTypeDefs for a specific category.
List<OpenMetadataTypeDef>	findTypeDefsByCategory(String userId, OpenMetadataTypeDefCategory category)	Returns all the TypeDefs for a specific category.
List<OpenMetadataTypeDef>	findTypesByExternalId(String userId, String standard, String organization, String identifier)	Return the types that are linked to the elements from the specified standard.
OpenMetadataTypeDefGallery	getAllTypes(String userId)	Returns the list of different types of metadata organized into two groups.
OpenMetadataAttributeTypeDef	getAttributeTypeDefByGUID(String userId, String guid)	Return the AttributeTypeDef identified by the GUID.
OpenMetadataAttributeTypeDef	getAttributeTypeDefByName(String userId, String name)	Return the AttributeTypeDef identified by the unique name.
List<OpenMetadataTypeDef>	getSubTypes(String userId, String typeName)	Returns all the TypeDefs for a specific subtype.
OpenMetadataTypeDef	getTypeDefByGUID(String userId, String guid)	Return the TypeDef identified by the GUID.
OpenMetadataTypeDef	getTypeDefByName(String userId, String name)	Return the TypeDef identified by the unique name.

Method Details

getAllTypes

OpenMetadataTypeDefGallery getAllTypes(String userId)
                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Returns the list of different types of metadata organized into two groups. The first are the attribute type definitions (AttributeTypeDefs). These provide types for properties in full type definitions. Full type definitions (TypeDefs) describe types for entities, relationships and classifications.

Parameters:

userId - unique identifier for requesting user.

Returns:

TypeDefGallery List of different categories of type definitions.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.

findTypeDefsByCategory

List<OpenMetadataTypeDef> findTypeDefsByCategory(String userId,
 OpenMetadataTypeDefCategory category)
                                          throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Returns all the TypeDefs for a specific category.

Parameters:

userId - unique identifier for requesting user.

category - enum value for the category of TypeDef to return.

Returns:

TypeDefs list.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the TypeDefCategory is null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.

findAttributeTypeDefsByCategory

List<OpenMetadataAttributeTypeDef> findAttributeTypeDefsByCategory(String userId,
 OpenMetadataAttributeTypeDefCategory category)
                                                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Returns all the AttributeTypeDefs for a specific category.

Parameters:

userId - unique identifier for requesting user.

category - enum value for the category of an AttributeTypeDef to return.

Returns:

AttributeTypeDefs list.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the TypeDefCategory is null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.

findTypesByExternalId

List<OpenMetadataTypeDef> findTypesByExternalId(String userId,
 String standard,
 String organization,
 String identifier)
                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Return the types that are linked to the elements from the specified standard.

Parameters:

userId - unique identifier for requesting user.

standard - name of the standard null means any.

organization - name of the organization null means any.

identifier - identifier of the element in the standard null means any.

Returns:

TypeDefs list each entry in the list contains a TypeDef. This is a structure describing the TypeDef's category and properties.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - all attributes of the external id are null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.

getTypeDefByGUID

OpenMetadataTypeDef getTypeDefByGUID(String userId,
 String guid)
                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Return the TypeDef identified by the GUID.

Parameters:

userId - unique identifier for requesting user.

guid - String unique id of the TypeDef

Returns:

TypeDef structure describing its category and properties.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the guid is null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository where the metadata collection is stored.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.

getSubTypes

List<OpenMetadataTypeDef> getSubTypes(String userId,
 String typeName)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Returns all the TypeDefs for a specific subtype. If a null result is returned it means the type has no subtypes. *

Parameters:

userId - unique identifier for requesting user.

typeName - name of the standard null means any.

Returns:

TypeDefs list each entry in the list contains a TypeDef. This is a structure describing the TypeDef's category and properties. If null is returned as the TypeDef list it means the type has no known subtypes

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - all attributes of the external id are null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.

getAttributeTypeDefByGUID

OpenMetadataAttributeTypeDef getAttributeTypeDefByGUID(String userId,
 String guid)
                                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Return the AttributeTypeDef identified by the GUID.

Parameters:

userId - unique identifier for requesting user.

guid - String unique id of the TypeDef

Returns:

TypeDef structure describing its category and properties.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the guid is null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository where the metadata collection is stored.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.

getTypeDefByName

OpenMetadataTypeDef getTypeDefByName(String userId,
 String name)
                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Return the TypeDef identified by the unique name.

Parameters:

userId - unique identifier for requesting user.

name - String name of the TypeDef.

Returns:

TypeDef structure describing its category and properties.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the name is null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository where the metadata collection is stored.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.

getAttributeTypeDefByName

OpenMetadataAttributeTypeDef getAttributeTypeDefByName(String userId,
 String name)
                                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Return the AttributeTypeDef identified by the unique name.

Parameters:

userId - unique identifier for requesting user.

name - String name of the TypeDef.

Returns:

TypeDef structure describing its category and properties.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the name is null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the metadata repository where the metadata collection is stored.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the userId is not permitted to perform this operation.