http://git-wip-us.apache.org/repos/asf/atlas/blob/b0ecc36a/omrs/src/main/java/org/apache/atlas/omrs/metadatacollection/OMRSMetadataCollection.java ---------------------------------------------------------------------- diff --git a/omrs/src/main/java/org/apache/atlas/omrs/metadatacollection/OMRSMetadataCollection.java b/omrs/src/main/java/org/apache/atlas/omrs/metadatacollection/OMRSMetadataCollection.java deleted file mode 100644 index ef3c3d7..0000000 --- a/omrs/src/main/java/org/apache/atlas/omrs/metadatacollection/OMRSMetadataCollection.java +++ /dev/null @@ -1,2139 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * <p/> - * http://www.apache.org/licenses/LICENSE-2.0 - * <p/> - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.atlas.omrs.metadatacollection; - -import org.apache.atlas.omrs.ffdc.*; -import org.apache.atlas.omrs.ffdc.exception.*; -import org.apache.atlas.omrs.localrepository.repositorycontentmanager.OMRSRepositoryHelper; -import org.apache.atlas.omrs.localrepository.repositorycontentmanager.OMRSRepositoryValidator; -import org.apache.atlas.omrs.metadatacollection.properties.MatchCriteria; -import org.apache.atlas.omrs.metadatacollection.properties.SequencingOrder; -import org.apache.atlas.omrs.metadatacollection.properties.instances.*; -import org.apache.atlas.omrs.metadatacollection.properties.typedefs.*; -import org.apache.atlas.omrs.metadatacollection.repositoryconnector.OMRSRepositoryConnector; - -import java.util.List; -import java.util.Date; - -/** - * <p> - * OMRSMetadataCollection is the common interface for working with the contents of a metadata repository. - * Within a metadata collection are the type definitions (TypeDefs) and metadata instances (Entities and - * Relationships). - * - * The methods on OMRSMetadataCollection are in the following major groups: - * </p> - * <ul> - * <li><b>Methods to retrieve information about the metadata repository</b> - - * Used to retrieve or confirm the identity of the metadata repository - * </li> - * <li><b>Methods for working with typedefs</b> - - * Typedefs are used to define the type model for open metadata. - * The open metadata support had a comprehensive set of typedefs implemented, and these can be augmented by - * different vendors or applications. The typedefs can be queried, created, updated and deleted though the - * metadata collection. - * </li> - * - * <li><b>Methods for querying Entities and Relationships</b> - - * The metadata repository stores instances of the typedefs as metadata instances. - * Principally these are entities (nodes in the graph) and relationships (links between nodes). - * Both the entities and relationships can have properties. - * The entity may also have structured properties called structs and classifications attached. - * This second group of methods supports a range of queries to retrieve these instances. - * </li> - * - * <li><b>Methods for maintaining the instances</b> - - * The fourth group of methods supports the maintenance of the metadata instances. Each instance as a status - * (see InstanceStatus) that allows an instance to be proposed, drafted and approved before it becomes - * active. The instances can also be soft-deleted and restored or purged from the metadata - * collection. - * </li> - * <li> - * <b>Methods for repairing the metadata collections of the cohort</b> - - * The fifth group of methods are for editing the control information of entities and relationships to - * manage changes in the cohort. These methods are advanced methods and are rarely used. - * </li> - * <li> - * <b>Methods for local maintenance of a metadata collection</b> - * The final group of methods are for removing reference copies of the metadata instances. These updates - * are not broadcast to the rest of the Cohort as events. - * </li> - * </ul> - */ -public abstract class OMRSMetadataCollection -{ - static final private String defaultRepositoryName = "Open Metadata Repository"; - - protected String metadataCollectionId; /* Initialized in constructor */ - protected OMRSRepositoryHelper repositoryHelper = null; /* Initialized in constructor */ - protected OMRSRepositoryValidator repositoryValidator = null; /* Initialized in constructor */ - protected OMRSRepositoryConnector parentConnector = null; /* Initialized in constructor */ - protected String repositoryName = defaultRepositoryName; /* Initialized in constructor */ - - - /** - * Constructor to save the metadata collection id. - * - * @param metadataCollectionId - unique identifier for the metadata collection - */ - @Deprecated - public OMRSMetadataCollection(String metadataCollectionId) - { - this.metadataCollectionId = metadataCollectionId; - - if (metadataCollectionId == null) - { - String actionDescription = "OMRS Metadata Collection Constructor"; - - OMRSErrorCode errorCode = OMRSErrorCode.NULL_METADATA_COLLECTION_ID; - String errorMessage = errorCode.getErrorMessageId() - + errorCode.getFormattedErrorMessage(defaultRepositoryName); - - throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(), - this.getClass().getName(), - actionDescription, - errorMessage, - errorCode.getSystemAction(), - errorCode.getUserAction()); - - } - } - - - /** - * Constructor to save the metadata collection id, repository helper and repository validator. - * - * @param parentConnector - connector that this metadata collection supports. The connector has the information - * to call the metadata repository. - * @param repositoryName - name of this repository. - * @param repositoryHelper - helper class for building types and instances - * @param repositoryValidator - validator class for checking open metadata repository objects and parameters. - * @param metadataCollectionId - unique identifier for the metadata collection - */ - public OMRSMetadataCollection(OMRSRepositoryConnector parentConnector, - String repositoryName, - String metadataCollectionId, - OMRSRepositoryHelper repositoryHelper, - OMRSRepositoryValidator repositoryValidator) - { - this.metadataCollectionId = metadataCollectionId; - - if (metadataCollectionId == null) - { - String actionDescription = "OMRS Metadata Collection Constructor"; - - OMRSErrorCode errorCode = OMRSErrorCode.NULL_METADATA_COLLECTION_ID; - String errorMessage = errorCode.getErrorMessageId() - + errorCode.getFormattedErrorMessage(repositoryName); - - throw new OMRSLogicErrorException(errorCode.getHTTPErrorCode(), - this.getClass().getName(), - actionDescription, - errorMessage, - errorCode.getSystemAction(), - errorCode.getUserAction()); - - } - - this.repositoryHelper = repositoryHelper; - this.repositoryValidator = repositoryValidator; - this.parentConnector = parentConnector; - this.repositoryName = repositoryName; - } - - - /** - * Verify that a metadata collection is operating with a parent connector. This should always be the case but - * if the metadata collection is being consumed in an unorthodox manner then this exception will catch it. - * - * @param methodName - name of method called - * @throws RepositoryErrorException - null repository connector - */ - public void validateRepositoryConnector(String methodName) throws RepositoryErrorException - { - if (parentConnector == null) - { - OMRSErrorCode errorCode = OMRSErrorCode.NO_REPOSITORY_CONNECTOR_FOR_COLLECTION; - String errorMessage = errorCode.getErrorMessageId() - + errorCode.getFormattedErrorMessage(methodName, repositoryName); - - throw new RepositoryErrorException(errorCode.getHTTPErrorCode(), - this.getClass().getName(), - methodName, - errorMessage, - errorCode.getSystemAction(), - errorCode.getUserAction()); - } - - if (repositoryValidator == null) - { - OMRSErrorCode errorCode = OMRSErrorCode.NO_REPOSITORY_VALIDATOR_FOR_COLLECTION; - String errorMessage = errorCode.getErrorMessageId() - + errorCode.getFormattedErrorMessage(methodName, repositoryName); - - throw new RepositoryErrorException(errorCode.getHTTPErrorCode(), - this.getClass().getName(), - methodName, - errorMessage, - errorCode.getSystemAction(), - errorCode.getUserAction()); - } - - if (repositoryHelper == null) - { - OMRSErrorCode errorCode = OMRSErrorCode.NO_REPOSITORY_HELPER_FOR_COLLECTION; - String errorMessage = errorCode.getErrorMessageId() - + errorCode.getFormattedErrorMessage(methodName, repositoryName); - - throw new RepositoryErrorException(errorCode.getHTTPErrorCode(), - this.getClass().getName(), - methodName, - errorMessage, - errorCode.getSystemAction(), - errorCode.getUserAction()); - } - } - - - /* ====================================================================== - * Group 1: Confirm the identity of the metadata repository being called. - */ - - /** - * Returns the identifier of the metadata repository. This is the identifier used to register the - * metadata repository with the metadata repository cohort. It is also the identifier used to - * identify the home repository of a metadata instance. - * - * @return String - metadata collection id. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository. - */ - public String getMetadataCollectionId() throws RepositoryErrorException - { - return metadataCollectionId; - } - - - /* ============================== - * Group 2: Working with typedefs - */ - - - /** - * 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. - * - * @param userId - unique identifier for requesting user. - * @return TypeDefGallery - List of different categories of type definitions. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract TypeDefGallery getAllTypes(String userId) throws RepositoryErrorException, - UserNotAuthorizedException; - - - /** - * Returns a list of type definitions that have the specified name. Type names should be unique. This - * method allows wildcard character to be included in the name. These are * (asterisk) for an - * arbitrary string of characters and ampersand for an arbitrary character. - * - * @param userId - unique identifier for requesting user. - * @param name - name of the TypeDefs to return (including wildcard characters). - * @return TypeDefGallery - List of different categories of type definitions. - * @throws InvalidParameterException - the name of the TypeDef is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract TypeDefGallery findTypesByName(String userId, - String name) throws InvalidParameterException, - RepositoryErrorException, - UserNotAuthorizedException; - - - /** - * Returns all of the TypeDefs for a specific category. - * - * @param userId - unique identifier for requesting user. - * @param category - enum value for the category of TypeDef to return. - * @return TypeDefs list. - * @throws InvalidParameterException - the TypeDefCategory is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<TypeDef> findTypeDefsByCategory(String userId, - TypeDefCategory category) throws InvalidParameterException, - RepositoryErrorException, - UserNotAuthorizedException; - - /** - * Returns all of the AttributeTypeDefs for a specific category. - * - * @param userId - unique identifier for requesting user. - * @param category - enum value for the category of an AttributeTypeDef to return. - * @return AttributeTypeDefs list. - * @throws InvalidParameterException - the TypeDefCategory is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<AttributeTypeDef> findAttributeTypeDefsByCategory(String userId, - AttributeTypeDefCategory category) throws InvalidParameterException, - RepositoryErrorException, - UserNotAuthorizedException; - - /** - * Return the TypeDefs that have the properties matching the supplied match criteria. - * - * @param userId - unique identifier for requesting user. - * @param matchCriteria - TypeDefProperties - a list of property names and values. - * @return TypeDefs list. - * @throws InvalidParameterException - the matchCriteria is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<TypeDef> findTypeDefsByProperty(String userId, - TypeDefProperties matchCriteria) throws InvalidParameterException, - RepositoryErrorException, - UserNotAuthorizedException; - - - /** - * Return the types that are linked to the elements from the specified standard. - * - * @param userId - unique identifier for requesting user. - * @param standard - name of the standard - null means any. - * @param organization - name of the organization - null means any. - * @param identifier - identifier of the element in the standard - null means any. - * @return TypeDefs list - each entry in the list contains a TypeDef. This is is a structure - * describing the TypeDef's category and properties. - * @throws InvalidParameterException - all attributes of the external id are null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<TypeDef> findTypesByExternalID(String userId, - String standard, - String organization, - String identifier) throws InvalidParameterException, - RepositoryErrorException, - UserNotAuthorizedException; - - /** - * Return the TypeDefs that match the search criteria. - * - * @param userId - unique identifier for requesting user. - * @param searchCriteria - String - search criteria. - * @return TypeDefs list - each entry in the list contains a TypeDef. This is is a structure - * describing the TypeDef's category and properties. - * @throws InvalidParameterException - the searchCriteria is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<TypeDef> searchForTypeDefs(String userId, - String searchCriteria) throws InvalidParameterException, - RepositoryErrorException, - UserNotAuthorizedException; - - - /** - * Return the TypeDef identified by the GUID. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique id of the TypeDef - * @return TypeDef structure describing its category and properties. - * @throws InvalidParameterException - the guid is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - The requested TypeDef is not known in the metadata collection. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract TypeDef getTypeDefByGUID(String userId, - String guid) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - UserNotAuthorizedException; - - /** - * Return the AttributeTypeDef identified by the GUID. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique id of the TypeDef - * @return TypeDef structure describing its category and properties. - * @throws InvalidParameterException - the guid is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - The requested TypeDef is not known in the metadata collection. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract AttributeTypeDef getAttributeTypeDefByGUID(String userId, - String guid) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - UserNotAuthorizedException; - - - /** - * Return the TypeDef identified by the unique name. - * - * @param userId - unique identifier for requesting user. - * @param name - String name of the TypeDef. - * @return TypeDef structure describing its category and properties. - * @throws InvalidParameterException - the name is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - the requested TypeDef is not found in the metadata collection. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract TypeDef getTypeDefByName(String userId, - String name) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - UserNotAuthorizedException; - - - /** - * Return the AttributeTypeDef identified by the unique name. - * - * @param userId - unique identifier for requesting user. - * @param name - String name of the TypeDef. - * @return TypeDef structure describing its category and properties. - * @throws InvalidParameterException - the name is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - the requested TypeDef is not found in the metadata collection. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract AttributeTypeDef getAttributeTypeDefByName(String userId, - String name) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - UserNotAuthorizedException; - - - /** - * Create a collection of related types. - * - * @param userId - unique identifier for requesting user. - * @param newTypes - TypeDefGalleryResponse structure describing the new AttributeTypeDefs and TypeDefs. - * @throws InvalidParameterException - the new TypeDef is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotSupportedException - the repository is not able to support this TypeDef. - * @throws TypeDefKnownException - the TypeDef is already stored in the repository. - * @throws TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef. - * @throws InvalidTypeDefException - the new TypeDef has invalid contents. - * @throws FunctionNotSupportedException - the repository does not support this call. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract void addTypeDefGallery(String userId, - TypeDefGallery newTypes) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotSupportedException, - TypeDefKnownException, - TypeDefConflictException, - InvalidTypeDefException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Create a definition of a new TypeDef. - * - * @param userId - unique identifier for requesting user. - * @param newTypeDef - TypeDef structure describing the new TypeDef. - * @throws InvalidParameterException - the new TypeDef is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotSupportedException - the repository is not able to support this TypeDef. - * @throws TypeDefKnownException - the TypeDef is already stored in the repository. - * @throws TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef. - * @throws InvalidTypeDefException - the new TypeDef has invalid contents. - * @throws FunctionNotSupportedException - the repository does not support this call. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract void addTypeDef(String userId, - TypeDef newTypeDef) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotSupportedException, - TypeDefKnownException, - TypeDefConflictException, - InvalidTypeDefException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - /** - * Create a definition of a new AttributeTypeDef. - * - * @param userId - unique identifier for requesting user. - * @param newAttributeTypeDef - TypeDef structure describing the new TypeDef. - * @throws InvalidParameterException - the new TypeDef is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotSupportedException - the repository is not able to support this TypeDef. - * @throws TypeDefKnownException - the TypeDef is already stored in the repository. - * @throws TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef. - * @throws InvalidTypeDefException - the new TypeDef has invalid contents. - * @throws FunctionNotSupportedException - the repository does not support this call. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract void addAttributeTypeDef(String userId, - AttributeTypeDef newAttributeTypeDef) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotSupportedException, - TypeDefKnownException, - TypeDefConflictException, - InvalidTypeDefException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Verify that a definition of a TypeDef is either new - or matches the definition already stored. - * - * @param userId - unique identifier for requesting user. - * @param typeDef - TypeDef structure describing the TypeDef to test. - * @return boolean - true means the TypeDef matches the local definition - false means the TypeDef is not known. - * @throws InvalidParameterException - the TypeDef is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotSupportedException - the repository is not able to support this TypeDef. - * @throws TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef. - * @throws InvalidTypeDefException - the new TypeDef has invalid contents. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract boolean verifyTypeDef(String userId, - TypeDef typeDef) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotSupportedException, - TypeDefConflictException, - InvalidTypeDefException, - UserNotAuthorizedException; - - - /** - * Verify that a definition of an AttributeTypeDef is either new - or matches the definition already stored. - * - * @param userId - unique identifier for requesting user. - * @param attributeTypeDef - TypeDef structure describing the TypeDef to test. - * @return boolean - true means the TypeDef matches the local definition - false means the TypeDef is not known. - * @throws InvalidParameterException - the TypeDef is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotSupportedException - the repository is not able to support this TypeDef. - * @throws TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef. - * @throws InvalidTypeDefException - the new TypeDef has invalid contents. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract boolean verifyAttributeTypeDef(String userId, - AttributeTypeDef attributeTypeDef) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotSupportedException, - TypeDefConflictException, - InvalidTypeDefException, - UserNotAuthorizedException; - - - /** - * Update one or more properties of the TypeDef. The TypeDefPatch controls what types of updates - * are safe to make to the TypeDef. - * - * @param userId - unique identifier for requesting user. - * @param typeDefPatch - TypeDef patch describing change to TypeDef. - * @return updated TypeDef - * @throws InvalidParameterException - the TypeDefPatch is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - the requested TypeDef is not found in the metadata collection. - * @throws PatchErrorException - the TypeDef can not be updated because the supplied patch is incompatible - * with the stored TypeDef. - * @throws FunctionNotSupportedException - the repository does not support this call. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract TypeDef updateTypeDef(String userId, - TypeDefPatch typeDefPatch) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - PatchErrorException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Delete the TypeDef. This is only possible if the TypeDef has never been used to create instances or any - * instances of this TypeDef have been purged from the metadata collection. - * - * @param userId - unique identifier for requesting user. - * @param obsoleteTypeDefGUID - String unique identifier for the TypeDef. - * @param obsoleteTypeDefName - String unique name for the TypeDef. - * @throws InvalidParameterException - the one of TypeDef identifiers is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - the requested TypeDef is not found in the metadata collection. - * @throws TypeDefInUseException - the TypeDef can not be deleted because there are instances of this type in the - * the metadata collection. These instances need to be purged before the - * TypeDef can be deleted. - * @throws FunctionNotSupportedException - the repository does not support this call. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract void deleteTypeDef(String userId, - String obsoleteTypeDefGUID, - String obsoleteTypeDefName) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - TypeDefInUseException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Delete an AttributeTypeDef. This is only possible if the AttributeTypeDef has never been used to create - * instances or any instances of this AttributeTypeDef have been purged from the metadata collection. - * - * @param userId - unique identifier for requesting user. - * @param obsoleteTypeDefGUID - String unique identifier for the AttributeTypeDef. - * @param obsoleteTypeDefName - String unique name for the AttributeTypeDef. - * @throws InvalidParameterException - the one of AttributeTypeDef identifiers is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - the requested AttributeTypeDef is not found in the metadata collection. - * @throws TypeDefInUseException - the AttributeTypeDef can not be deleted because there are instances of this type in the - * the metadata collection. These instances need to be purged before the - * AttributeTypeDef can be deleted. - * @throws FunctionNotSupportedException - the repository does not support this call. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract void deleteAttributeTypeDef(String userId, - String obsoleteTypeDefGUID, - String obsoleteTypeDefName) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - TypeDefInUseException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Change the guid or name of an existing TypeDef to a new value. This is used if two different - * TypeDefs are discovered to have the same guid. This is extremely unlikely but not impossible so - * the open metadata protocol has provision for this. - * - * @param userId - unique identifier for requesting user. - * @param originalTypeDefGUID - the original guid of the TypeDef. - * @param originalTypeDefName - the original name of the TypeDef. - * @param newTypeDefGUID - the new identifier for the TypeDef. - * @param newTypeDefName - new name for this TypeDef. - * @return typeDef - new values for this TypeDef, including the new guid/name. - * @throws InvalidParameterException - one of the parameters is invalid or null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - the TypeDef identified by the original guid/name is not found - * in the metadata collection. - * @throws FunctionNotSupportedException - the repository does not support this call. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract TypeDef reIdentifyTypeDef(String userId, - String originalTypeDefGUID, - String originalTypeDefName, - String newTypeDefGUID, - String newTypeDefName) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Change the guid or name of an existing TypeDef to a new value. This is used if two different - * TypeDefs are discovered to have the same guid. This is extremely unlikely but not impossible so - * the open metadata protocol has provision for this. - * - * @param userId - unique identifier for requesting user. - * @param originalAttributeTypeDefGUID - the original guid of the AttributeTypeDef. - * @param originalAttributeTypeDefName - the original name of the AttributeTypeDef. - * @param newAttributeTypeDefGUID - the new identifier for the AttributeTypeDef. - * @param newAttributeTypeDefName - new name for this AttributeTypeDef. - * @return attributeTypeDef - new values for this AttributeTypeDef, including the new guid/name. - * @throws InvalidParameterException - one of the parameters is invalid or null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws TypeDefNotKnownException - the AttributeTypeDef identified by the original guid/name is not - * found in the metadata collection. - * @throws FunctionNotSupportedException - the repository does not support this call. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract AttributeTypeDef reIdentifyAttributeTypeDef(String userId, - String originalAttributeTypeDefGUID, - String originalAttributeTypeDefName, - String newAttributeTypeDefGUID, - String newAttributeTypeDefName) throws InvalidParameterException, - RepositoryErrorException, - TypeDefNotKnownException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /* =================================================== - * Group 3: Locating entity and relationship instances - */ - - - /** - * Returns a boolean indicating if the entity is stored in the metadata collection. This entity may be a full - * entity object, or an entity proxy. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique identifier for the entity - * @return the entity details if the entity is found in the metadata collection; otherwise return null - * @throws InvalidParameterException - the guid is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract EntityDetail isEntityKnown(String userId, - String guid) throws InvalidParameterException, - RepositoryErrorException, - UserNotAuthorizedException; - - - /** - * Return the header and classifications for a specific entity. The returned entity summary may be from - * a full entity object or an entity proxy. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique identifier for the entity - * @return EntitySummary structure - * @throws InvalidParameterException - the guid is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws EntityNotKnownException - the requested entity instance is not known in the metadata collection. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract EntitySummary getEntitySummary(String userId, - String guid) throws InvalidParameterException, - RepositoryErrorException, - EntityNotKnownException, - UserNotAuthorizedException; - - - - /** - * Return the header, classifications and properties of a specific entity. This requires the full entity - * object to be available. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique identifier for the entity. - * @return EntityDetail structure. - * @throws InvalidParameterException - the guid is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws EntityNotKnownException - the requested entity instance is not known in the metadata collection. - * @throws EntityProxyOnlyException - the requested entity instance is only a proxy in the metadata collection. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract EntityDetail getEntityDetail(String userId, - String guid) throws InvalidParameterException, - RepositoryErrorException, - EntityNotKnownException, - EntityProxyOnlyException, - UserNotAuthorizedException; - - - /** - * Return a historical version of an entity - includes the header, classifications and properties of the entity. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique identifier for the entity. - * @param asOfTime - the time used to determine which version of the entity that is desired. - * @return EntityDetail structure. - * @throws InvalidParameterException - the guid or date is null or date is for future time - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws EntityNotKnownException - the requested entity instance is not known in the metadata collection - * at the time requested. - * @throws EntityProxyOnlyException - the requested entity instance is only a proxy in the metadata collection. - * @throws FunctionNotSupportedException - the repository does not support satOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract EntityDetail getEntityDetail(String userId, - String guid, - Date asOfTime) throws InvalidParameterException, - RepositoryErrorException, - EntityNotKnownException, - EntityProxyOnlyException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - - /** - * Return the relationships for a specific entity. - * - * @param userId - unique identifier for requesting user. - * @param entityGUID - String unique identifier for the entity. - * @param relationshipTypeGUID - String GUID of the the type of relationship required (null for all). - * @param fromRelationshipElement - the starting element number of the relationships to return. - * This is used when retrieving elements - * beyond the first page of results. Zero means start from the first element. - * @param limitResultsByStatus - By default, relationships in all statuses are returned. However, it is possible - * to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all - * status values. - * @param asOfTime - Requests a historical query of the relationships for the entity. Null means return the - * present values. - * @param sequencingProperty - String name of the property that is to be used to sequence the results. - * Null means do not sequence on a property name (see SequencingOrder). - * @param sequencingOrder - Enum defining how the results should be ordered. - * @param pageSize -- the maximum number of result classifications that can be returned on this request. Zero means - * unrestricted return results size. - * @return Relationships list. Null means no relationships associated with the entity. - * @throws InvalidParameterException - a parameter is invalid or null. - * @throws TypeErrorException - the type guid passed on the request is not known by the metadata collection. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws EntityNotKnownException - the requested entity instance is not known in the metadata collection. - * @throws PropertyErrorException - the sequencing property is not valid for the attached classifications. - * @throws PagingErrorException - the paging/sequencing parameters are set up incorrectly. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<Relationship> getRelationshipsForEntity(String userId, - String entityGUID, - String relationshipTypeGUID, - int fromRelationshipElement, - List<InstanceStatus> limitResultsByStatus, - Date asOfTime, - String sequencingProperty, - SequencingOrder sequencingOrder, - int pageSize) throws InvalidParameterException, - TypeErrorException, - RepositoryErrorException, - EntityNotKnownException, - PropertyErrorException, - PagingErrorException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - - /** - * Return a list of entities that match the supplied properties according to the match criteria. The results - * can be returned over many pages. - * - * @param userId - unique identifier for requesting user. - * @param entityTypeGUID - String unique identifier for the entity type of interest (null means any entity type). - * @param matchProperties - List of entity properties to match to (null means match on entityTypeGUID only). - * @param matchCriteria - Enum defining how the properties should be matched to the entities in the repository. - * @param fromEntityElement - the starting element number of the entities to return. - * This is used when retrieving elements - * beyond the first page of results. Zero means start from the first element. - * @param limitResultsByStatus - By default, entities in all statuses are returned. However, it is possible - * to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all - * status values. - * @param limitResultsByClassification - List of classifications that must be present on all returned entities. - * @param asOfTime - Requests a historical query of the entity. Null means return the present values. - * @param sequencingProperty - String name of the entity property that is to be used to sequence the results. - * Null means do not sequence on a property name (see SequencingOrder). - * @param sequencingOrder - Enum defining how the results should be ordered. - * @param pageSize - the maximum number of result entities that can be returned on this request. Zero means - * unrestricted return results size. - * @return a list of entities matching the supplied criteria - null means no matching entities in the metadata - * collection. - * @throws InvalidParameterException - a parameter is invalid or null. - * @throws TypeErrorException - the type guid passed on the request is not known by the - * metadata collection. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws PropertyErrorException - the properties specified are not valid for any of the requested types of - * entity. - * @throws PagingErrorException - the paging/sequencing parameters are set up incorrectly. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<EntityDetail> findEntitiesByProperty(String userId, - String entityTypeGUID, - InstanceProperties matchProperties, - MatchCriteria matchCriteria, - int fromEntityElement, - List<InstanceStatus> limitResultsByStatus, - List<String> limitResultsByClassification, - Date asOfTime, - String sequencingProperty, - SequencingOrder sequencingOrder, - int pageSize) throws InvalidParameterException, - RepositoryErrorException, - TypeErrorException, - PropertyErrorException, - PagingErrorException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Return a list of entities that have the requested type of classifications attached. - * - * @param userId - unique identifier for requesting user. - * @param entityTypeGUID - unique identifier for the type of entity requested. Null means any type of entity - * (but could be slow so not recommended. - * @param classificationName - name of the classification - a null is not valid. - * @param matchClassificationProperties - list of classification properties used to narrow the search. - * @param matchCriteria - Enum defining how the properties should be matched to the classifications in the repository. - * @param fromEntityElement - the starting element number of the entities to return. - * This is used when retrieving elements - * beyond the first page of results. Zero means start from the first element. - * @param limitResultsByStatus - By default, entities in all statuses are returned. However, it is possible - * to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all - * status values. - * @param asOfTime - Requests a historical query of the entity. Null means return the present values. - * @param sequencingProperty - String name of the entity property that is to be used to sequence the results. - * Null means do not sequence on a property name (see SequencingOrder). - * @param sequencingOrder - Enum defining how the results should be ordered. - * @param pageSize - the maximum number of result entities that can be returned on this request. Zero means - * unrestricted return results size. - * @return a list of entities matching the supplied criteria - null means no matching entities in the metadata - * collection. - * @throws InvalidParameterException - a parameter is invalid or null. - * @throws TypeErrorException - the type guid passed on the request is not known by the - * metadata collection. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws ClassificationErrorException - the classification request is not known to the metadata collection. - * @throws PropertyErrorException - the properties specified are not valid for the requested type of - * classification. - * @throws PagingErrorException - the paging/sequencing parameters are set up incorrectly. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<EntityDetail> findEntitiesByClassification(String userId, - String entityTypeGUID, - String classificationName, - InstanceProperties matchClassificationProperties, - MatchCriteria matchCriteria, - int fromEntityElement, - List<InstanceStatus> limitResultsByStatus, - Date asOfTime, - String sequencingProperty, - SequencingOrder sequencingOrder, - int pageSize) throws InvalidParameterException, - TypeErrorException, - RepositoryErrorException, - ClassificationErrorException, - PropertyErrorException, - PagingErrorException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Return a list of entities whose string based property values match the search criteria. The - * search criteria may include regex style wild cards. - * - * @param userId - unique identifier for requesting user. - * @param entityTypeGUID - GUID of the type of entity to search for. Null means all types will - * be searched (could be slow so not recommended). - * @param searchCriteria - String expression contained in any of the property values within the entities - * of the supplied type. - * @param fromEntityElement - the starting element number of the entities to return. - * This is used when retrieving elements - * beyond the first page of results. Zero means start from the first element. - * @param limitResultsByStatus - By default, entities in all statuses are returned. However, it is possible - * to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all - * status values. - * @param limitResultsByClassification - List of classifications that must be present on all returned entities. - * @param asOfTime - Requests a historical query of the entity. Null means return the present values. - * @param sequencingProperty - String name of the property that is to be used to sequence the results. - * Null means do not sequence on a property name (see SequencingOrder). - * @param sequencingOrder - Enum defining how the results should be ordered. - * @param pageSize - the maximum number of result entities that can be returned on this request. Zero means - * unrestricted return results size. - * @return a list of entities matching the supplied criteria - null means no matching entities in the metadata - * collection. - * @throws InvalidParameterException - a parameter is invalid or null. - * @throws TypeErrorException - the type guid passed on the request is not known by the - * metadata collection. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws PropertyErrorException - the sequencing property specified is not valid for any of the requested types of - * entity. - * @throws PagingErrorException - the paging/sequencing parameters are set up incorrectly. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<EntityDetail> findEntitiesByPropertyValue(String userId, - String entityTypeGUID, - String searchCriteria, - int fromEntityElement, - List<InstanceStatus> limitResultsByStatus, - List<String> limitResultsByClassification, - Date asOfTime, - String sequencingProperty, - SequencingOrder sequencingOrder, - int pageSize) throws InvalidParameterException, - TypeErrorException, - RepositoryErrorException, - PropertyErrorException, - PagingErrorException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Returns a boolean indicating if the relationship is stored in the metadata collection. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique identifier for the relationship. - * @return relationship if the relationship is found in the metadata collection; otherwise return null. - * @throws InvalidParameterException - the guid is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract Relationship isRelationshipKnown(String userId, - String guid) throws InvalidParameterException, - RepositoryErrorException, - UserNotAuthorizedException; - - - /** - * Return the current version of a requested relationship. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique identifier for the relationship. - * @return a relationship structure. - * @throws InvalidParameterException - the guid is null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws RelationshipNotKnownException - the metadata collection does not have a relationship with - * the requested GUID stored. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract Relationship getRelationship(String userId, - String guid) throws InvalidParameterException, - RepositoryErrorException, - RelationshipNotKnownException, - UserNotAuthorizedException; - - /** - * Return a historical version of a relationship. - * - * @param userId - unique identifier for requesting user. - * @param guid - String unique identifier for the relationship. - * @param asOfTime - the time used to determine which version of the entity that is desired. - * @return Relationship structure. - * @throws InvalidParameterException - the guid or date is null or date is for a future time - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws RelationshipNotKnownException - the requested entity instance is not known in the metadata collection - * at the time requested. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract Relationship getRelationship(String userId, - String guid, - Date asOfTime) throws InvalidParameterException, - RepositoryErrorException, - RelationshipNotKnownException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Return a list of relationships that match the requested properties by the matching criteria. The results - * can be received as a series of pages. - * - * @param userId - unique identifier for requesting user. - * @param relationshipTypeGUID - unique identifier (guid) for the new relationship's type. Null means all types - * (but may be slow so not recommended). - * @param matchProperties - list of properties used to narrow the search. The property values may include - * regex style wild cards. - * @param matchCriteria - Enum defining how the properties should be matched to the relationships in the repository. - * @param fromRelationshipElement - the starting element number of the entities to return. - * This is used when retrieving elements - * beyond the first page of results. Zero means start from the first element. - * @param limitResultsByStatus - By default, relationships in all statuses are returned. However, it is possible - * to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all - * status values. - * @param asOfTime - Requests a historical query of the relationships for the entity. Null means return the - * present values. - * @param sequencingProperty - String name of the property that is to be used to sequence the results. - * Null means do not sequence on a property name (see SequencingOrder). - * @param sequencingOrder - Enum defining how the results should be ordered. - * @param pageSize - the maximum number of result relationships that can be returned on this request. Zero means - * unrestricted return results size. - * @return a list of relationships. Null means no matching relationships. - * @throws InvalidParameterException - one of the parameters is invalid or null. - * @throws TypeErrorException - the type guid passed on the request is not known by the - * metadata collection. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws PropertyErrorException - the properties specified are not valid for any of the requested types of - * relationships. - * @throws PagingErrorException - the paging/sequencing parameters are set up incorrectly. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<Relationship> findRelationshipsByProperty(String userId, - String relationshipTypeGUID, - InstanceProperties matchProperties, - MatchCriteria matchCriteria, - int fromRelationshipElement, - List<InstanceStatus> limitResultsByStatus, - Date asOfTime, - String sequencingProperty, - SequencingOrder sequencingOrder, - int pageSize) throws InvalidParameterException, - TypeErrorException, - RepositoryErrorException, - PropertyErrorException, - PagingErrorException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Return a list of relationships whose string based property values match the search criteria. The - * search criteria may include regex style wild cards. - * - * @param userId - unique identifier for requesting user. - * @param relationshipTypeGUID - GUID of the type of entity to search for. Null means all types will - * be searched (could be slow so not recommended). - * @param searchCriteria - String expression contained in any of the property values within the entities - * of the supplied type. - * @param fromRelationshipElement - Element number of the results to skip to when building the results list - * to return. Zero means begin at the start of the results. This is used - * to retrieve the results over a number of pages. - * @param limitResultsByStatus - By default, relationships in all statuses are returned. However, it is possible - * to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all - * status values. - * @param asOfTime - Requests a historical query of the relationships for the entity. Null means return the - * present values. - * @param sequencingProperty - String name of the property that is to be used to sequence the results. - * Null means do not sequence on a property name (see SequencingOrder). - * @param sequencingOrder - Enum defining how the results should be ordered. - * @param pageSize - the maximum number of result relationships that can be returned on this request. Zero means - * unrestricted return results size. - * @return a list of relationships. Null means no matching relationships. - * @throws InvalidParameterException - one of the parameters is invalid or null. - * @throws TypeErrorException - the type guid passed on the request is not known by the - * metadata collection. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws PropertyErrorException - there is a problem with one of the other parameters. - * @throws PagingErrorException - the paging/sequencing parameters are set up incorrectly. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract List<Relationship> findRelationshipsByPropertyValue(String userId, - String relationshipTypeGUID, - String searchCriteria, - int fromRelationshipElement, - List<InstanceStatus> limitResultsByStatus, - Date asOfTime, - String sequencingProperty, - SequencingOrder sequencingOrder, - int pageSize) throws InvalidParameterException, - TypeErrorException, - RepositoryErrorException, - PropertyErrorException, - PagingErrorException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Return all of the relationships and intermediate entities that connect the startEntity with the endEntity. - * - * @param userId - unique identifier for requesting user. - * @param startEntityGUID - The entity that is used to anchor the query. - * @param endEntityGUID - the other entity that defines the scope of the query. - * @param limitResultsByStatus - By default, relationships in all statuses are returned. However, it is possible - * to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all - * status values. - * @param asOfTime - Requests a historical query of the relationships for the entity. Null means return the - * present values. - * @return InstanceGraph - the sub-graph that represents the returned linked entities and their relationships. - * @throws InvalidParameterException - one of the parameters is invalid or null. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws EntityNotKnownException - the entity identified by either the startEntityGUID or the endEntityGUID - * is not found in the metadata collection. - * @throws PropertyErrorException - there is a problem with one of the other parameters. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract InstanceGraph getLinkingEntities(String userId, - String startEntityGUID, - String endEntityGUID, - List<InstanceStatus> limitResultsByStatus, - Date asOfTime) throws InvalidParameterException, - RepositoryErrorException, - EntityNotKnownException, - PropertyErrorException, - FunctionNotSupportedException, - UserNotAuthorizedException; - - - /** - * Return the entities and relationships that radiate out from the supplied entity GUID. - * The results are scoped both the instance type guids and the level. - * - * @param userId - unique identifier for requesting user. - * @param entityGUID - the starting point of the query. - * @param entityTypeGUIDs - list of entity types to include in the query results. Null means include - * all entities found, irrespective of their type. - * @param relationshipTypeGUIDs - list of relationship types to include in the query results. Null means include - * all relationships found, irrespective of their type. - * @param limitResultsByStatus - By default, relationships in all statuses are returned. However, it is possible - * to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all - * status values. - * @param limitResultsByClassification - List of classifications that must be present on all returned entities. - * @param asOfTime - Requests a historical query of the relationships for the entity. Null means return the - * present values. - * @param level - the number of the relationships out from the starting entity that the query will traverse to - * gather results. - * @return InstanceGraph - the sub-graph that represents the returned linked entities and their relationships. - * @throws InvalidParameterException - one of the parameters is invalid or null. - * @throws TypeErrorException - one of the type guids passed on the request is not known by the - * metadata collection. - * @throws RepositoryErrorException - there is a problem communicating with the metadata repository where - * the metadata collection is stored. - * @throws EntityNotKnownException - the entity identified by the entityGUID is not found in the metadata collection. - * @throws PropertyErrorException - there is a problem with one of the other parameters. - * @throws FunctionNotSupportedException - the repository does not support the asOfTime parameter. - * @throws UserNotAuthorizedException - the userId is not permitted to perform this operation. - */ - public abstract InstanceGraph getEntityNeighborhood(String userId, -
<TRUNCATED>
