SchemaTypeHandler (OCF Metadata Management Server-side Handlers 1.7 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.SchemaTypeHandler

```
public class SchemaTypeHandler
extends Object
```
SchemaTypeHandler manages SchemaType objects. It runs server-side in the OMAG Server Platform and retrieves SchemaType entities through the OMRSRepositoryConnector.

Constructor Summary

Constructors
Constructor and Description
`SchemaTypeHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, LastAttachmentHandler lastAttachmentHandler)` Construct the handler information needed to interact with the repository services

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addExternalSchemaAttribute(String userId, SchemaAttribute schemaAttribute, String externalSourceGUID, String externalSourceName)` Add the schema type from an external source to the repository.
`String`	`addExternalSchemaType(String userId, SchemaType schemaType, String externalSourceGUID, String externalSourceName)` Add the schema type from an external source to the repository along with any schema types embedded within it.
`ComplexSchemaType`	`getEmptyComplexSchemaType(String schemaTypeGUID, String schemaTypeName)` Return the requested schemaType with the specific type information filled in.
`PrimitiveSchemaType`	`getEmptyPrimitiveSchemaType(String schemaTypeGUID, String schemaTypeName)` Return the requested schemaType with the specific type information filled in.
`SchemaAttribute`	`getEmptySchemaAttribute()` Return a schema attribute object with the type set up.
`SchemaAttribute`	`getEmptyTabularColumn()` Return a schema attribute object with the type set up.
`SchemaAttributeBuilder`	`getSchemaAttributeBuilder(SchemaAttribute schemaAttribute)` Return the appropriate schemaAttribute builder for the supplied schema attribute bean.
`List<SchemaAttribute>`	`getSchemaAttributes(String userId, String schemaTypeGUID, int elementStart, int maxElements, String methodName)` Returns a list of schema attributes for a schema type.
`void`	`removeSchemaAttribute(String userId, String schemaAttributeGUID)` Remove the requested schemaAttribute if it is no longer connected to any other entity.
`void`	`removeSchemaType(String userId, String schemaTypeGUID)` Remove the requested schemaType if it is no longer connected to any other entity.
`void`	`saveExternalSchemaAttributes(String userId, String schemaTypeGUID, List<SchemaAttribute> schemaAttributes, String externalSourceGUID, String externalSourceName, String methodName)` Work through the schema attributes from an external source adding or updating the instances
`String`	`saveExternalSchemaType(String userId, SchemaType schemaType, String externalSourceGUID, String externalSourceName, String methodName)` Determine if the SchemaType object is stored in the repository and create it if it is not.
`String`	`saveSchemaAttribute(String userId, String parentGUID, SchemaAttribute schemaAttribute, String methodName)` Work through the schema attributes adding or updating the instances
`void`	`saveSchemaAttributes(String userId, String schemaTypeGUID, List<SchemaAttribute> schemaAttributes, String methodName)` Work through the schema attributes adding or updating the instances
`String`	`saveSchemaType(String userId, SchemaType schemaType, List<SchemaAttribute> schemaAttributes, String methodName)` Determine if the SchemaType object is stored in the repository and create it if it is not.
`String`	`saveSchemaType(String userId, SchemaType schemaType, String methodName)` Determine if the SchemaType object is stored in the repository and create it if it is not.
`String`	`updateSchemaAttribute(String userId, String existingSchemaAttributeGUID, SchemaAttribute schemaAttribute)` Update a stored schemaAttribute.
`String`	`updateSchemaType(String userId, String existingSchemaTypeGUID, SchemaType schemaType)` Update a stored schemaType.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaTypeHandler

public SchemaTypeHandler(String serviceName,
                         String serverName,
                         InvalidParameterHandler invalidParameterHandler,
                         RepositoryHandler repositoryHandler,
                         OMRSRepositoryHelper repositoryHelper,
                         LastAttachmentHandler lastAttachmentHandler)

Construct the handler information needed to interact with the repository services

Parameters:: serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects; lastAttachmentHandler - handler for recording last attachment

Method Detail

getEmptyComplexSchemaType
```
public ComplexSchemaType getEmptyComplexSchemaType(String schemaTypeGUID,
                                                   String schemaTypeName)
```
Return the requested schemaType with the specific type information filled in.

Parameters:

schemaTypeGUID - unique identifier of the required type

schemaTypeName - unique name of the required type

Returns:

new object

getEmptyPrimitiveSchemaType
```
public PrimitiveSchemaType getEmptyPrimitiveSchemaType(String schemaTypeGUID,
                                                       String schemaTypeName)
```
Return the requested schemaType with the specific type information filled in.

Parameters:

schemaTypeGUID - unique identifier of the required type

schemaTypeName - unique name of the required type

Returns:

new object

getEmptySchemaAttribute
```
public SchemaAttribute getEmptySchemaAttribute()
```
Return a schema attribute object with the type set up.

Returns:

new object

getEmptyTabularColumn
```
public SchemaAttribute getEmptyTabularColumn()
```
Return a schema attribute object with the type set up.

Returns:

new object

getSchemaAttributes

public List<SchemaAttribute> getSchemaAttributes(String userId,
                                                 String schemaTypeGUID,
                                                 int elementStart,
                                                 int maxElements,
                                                 String methodName)
                                          throws InvalidParameterException,
                                                 PropertyServerException,
                                                 UserNotAuthorizedException

Returns a list of schema attributes for a schema type.

Parameters:: userId - String userId of user making request.; schemaTypeGUID - String unique id for containing schema type.; elementStart - int starting position for first returned element.; maxElements - int maximum number of elements to return on the call.; methodName - calling method
Returns:: a schema attributes response
Throws:: InvalidParameterException - - the GUID is not recognized or the paging values are invalid or; PropertyServerException - - there is a problem retrieving the asset properties from the property server or; UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

saveSchemaAttributes

public void saveSchemaAttributes(String userId,
                                 String schemaTypeGUID,
                                 List<SchemaAttribute> schemaAttributes,
                                 String methodName)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Work through the schema attributes adding or updating the instances

Parameters:: userId - calling userId; schemaTypeGUID - anchor object; schemaAttributes - list of nested schema attribute objects or null; methodName - calling method
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

saveSchemaAttribute

public String saveSchemaAttribute(String userId,
                                  String parentGUID,
                                  SchemaAttribute schemaAttribute,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Work through the schema attributes adding or updating the instances

Parameters:: userId - calling userId; parentGUID - anchor object; schemaAttribute - schema attribute object with embedded type; methodName - calling method
Returns:: guid of new schema
Throws:: InvalidParameterException - the guid or bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

saveExternalSchemaAttributes

public void saveExternalSchemaAttributes(String userId,
                                         String schemaTypeGUID,
                                         List<SchemaAttribute> schemaAttributes,
                                         String externalSourceGUID,
                                         String externalSourceName,
                                         String methodName)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Work through the schema attributes from an external source adding or updating the instances

Parameters:: userId - calling userId; schemaTypeGUID - anchor object; schemaAttributes - list of nested schema attribute objects or null; externalSourceGUID - unique identifier of the external source; externalSourceName - unique name of the external source; methodName - calling method
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

addExternalSchemaAttribute

public String addExternalSchemaAttribute(String userId,
                                         SchemaAttribute schemaAttribute,
                                         String externalSourceGUID,
                                         String externalSourceName)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Add the schema type from an external source to the repository.

Parameters:: userId - calling userId; schemaAttribute - object to add; externalSourceGUID - unique identifier(guid) for the external source.; externalSourceName - unique name for the external source.
Returns:: unique identifier of the schemaAttribute in the repository.
Throws:: InvalidParameterException - the schemaAttribute bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

updateSchemaAttribute

public String updateSchemaAttribute(String userId,
                                    String existingSchemaAttributeGUID,
                                    SchemaAttribute schemaAttribute)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Update a stored schemaAttribute.

Parameters:: userId - userId; existingSchemaAttributeGUID - unique identifier of the existing schemaAttribute entity; schemaAttribute - new schemaAttribute values
Returns:: unique identifier of the schemaAttribute in the repository.
Throws:: InvalidParameterException - the schemaAttribute bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getSchemaAttributeBuilder
```
public SchemaAttributeBuilder getSchemaAttributeBuilder(SchemaAttribute schemaAttribute)
```
Return the appropriate schemaAttribute builder for the supplied schema attribute bean.

Parameters:

schemaAttribute - object with properties

Returns:

builder object.

saveSchemaType
```
public String saveSchemaType(String userId,
                             SchemaType schemaType,
                             List<SchemaAttribute> schemaAttributes,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException
```
Determine if the SchemaType object is stored in the repository and create it if it is not. If the schemaType is located, there is no check that the schemaType values are equal to those in the supplied object.

Parameters:

userId - calling userId

schemaType - object to add

schemaAttributes - list of nested schema attribute objects or null. These attributes can not have attributes nested themselves because the GUID is not returned to the caller.

methodName - calling method

Returns:

unique identifier of the schemaType in the repository.

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

saveSchemaType
```
public String saveSchemaType(String userId,
                             SchemaType schemaType,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException
```
Determine if the SchemaType object is stored in the repository and create it if it is not. If the schemaType is located, there is no check that the schemaType values are equal to those in the supplied object.

Parameters:

userId - calling userId

schemaType - object to add

methodName - calling method

Returns:

unique identifier of the schemaType in the repository.

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

saveExternalSchemaType

public String saveExternalSchemaType(String userId,
                                     SchemaType schemaType,
                                     String externalSourceGUID,
                                     String externalSourceName,
                                     String methodName)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Determine if the SchemaType object is stored in the repository and create it if it is not. If the schemaType is located, there is no check that the schemaType values are equal to those in the supplied object.

Parameters:: userId - calling userId; schemaType - object to add; externalSourceGUID - unique identifier(guid) for the external source; externalSourceName - unique name for the external source; methodName - calling method
Returns:: unique identifier of the schemaType in the repository.
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

addExternalSchemaType

public String addExternalSchemaType(String userId,
                                    SchemaType schemaType,
                                    String externalSourceGUID,
                                    String externalSourceName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Add the schema type from an external source to the repository along with any schema types embedded within it.

Parameters:: userId - calling userId; schemaType - object to add; externalSourceGUID - unique identifier(guid) for the external source; externalSourceName - unique name for the external source
Returns:: unique identifier of the schemaType in the repository.
Throws:: InvalidParameterException - the schemaType bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

updateSchemaType

public String updateSchemaType(String userId,
                               String existingSchemaTypeGUID,
                               SchemaType schemaType)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Update a stored schemaType.

Parameters:: userId - userId; existingSchemaTypeGUID - unique identifier of the existing schemaType entity; schemaType - new schemaType values
Returns:: unique identifier of the schemaType in the repository.
Throws:: InvalidParameterException - the schemaType bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

removeSchemaType

public void removeSchemaType(String userId,
                             String schemaTypeGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Remove the requested schemaType if it is no longer connected to any other entity.

Parameters:: userId - calling user; schemaTypeGUID - object to delete
Throws:: InvalidParameterException - the entity guid is not known; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

removeSchemaAttribute

public void removeSchemaAttribute(String userId,
                                  String schemaAttributeGUID)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Remove the requested schemaAttribute if it is no longer connected to any other entity.

Parameters:: userId - calling user; schemaAttributeGUID - object to delete
Throws:: InvalidParameterException - the entity guid is not known; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

Class SchemaTypeHandler