Package org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors

Class VerifyTypeDefExecutor

java.lang.Object

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.VerifyTypeDefExecutor

All Implemented Interfaces:

RepositoryExecutor

public class VerifyTypeDefExecutor
extends RepositoryExecutorBase

VerifyTypeDefExecutor provides the executor for the verifyTypeDef method. This method returns confirmation that a specific type is supported somewhere in the cohort.

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

methodName, userId

Constructor Summary

Constructors

Constructor	Description
VerifyTypeDefExecutor(String userId, TypeDef typeDef, AuditLog auditLog, String methodName)	Constructor takes the parameters for the request.

Method Summary

Modifier and Type	Method	Description
boolean	getResult()	Return the result of the execution.
boolean	issueRequestToRepository(String metadataCollectionId, OMRSMetadataCollection metadataCollection)	Perform the required action for the supplied repository.

Methods inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

getMethodName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutor

augmentResultFromRepository, getResultsForAugmentation

Constructor Details

VerifyTypeDefExecutor

public VerifyTypeDefExecutor(String userId,
 TypeDef typeDef,
 AuditLog auditLog,
 String methodName)

Constructor takes the parameters for the request.

Parameters:

userId - unique identifier for requesting user.

typeDef - TypeDef structure describing the TypeDef to test.

auditLog - logging destination

methodName - calling method

Method Details

issueRequestToRepository

public boolean issueRequestToRepository(String metadataCollectionId,
 OMRSMetadataCollection metadataCollection)

Perform the required action for the supplied repository. Create requests occur in the first repository that accepts the call. Some repositories may produce exceptions. These exceptions are saved and will be returned if there are no positive results from any repository.

Specified by:

issueRequestToRepository in interface RepositoryExecutor

Specified by:

issueRequestToRepository in class RepositoryExecutorBase

Parameters:

metadataCollectionId - unique identifier for the metadata collection for the repository

metadataCollection - metadata collection object for the repository

Returns:

boolean true means that the required results have been achieved

getResult

public boolean getResult()
                  throws InvalidParameterException,
RepositoryErrorException,
TypeDefNotSupportedException,
TypeDefConflictException,
InvalidTypeDefException,
UserNotAuthorizedException

Return the result of the execution. Hopefully this is a result - but may be an exception

Returns:

boolean true means the TypeDef matches the local definition false means the TypeDef is not known.

Throws:

InvalidParameterException - the TypeDef is null.

RepositoryErrorException - there is a problem communicating with the metadata repository where the metadata collection is stored.

TypeDefNotSupportedException - the repository is not able to support this TypeDef.

TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef.

InvalidTypeDefException - the new TypeDef has invalid contents.

UserNotAuthorizedException - the userId is not permitted to perform this operation.