Package org.odpi.openmetadata.commonservices.generichandlers

Class ReferenceableHandler<B>

java.lang.Object
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<B>
Direct Known Subclasses:
ActorProfileHandler, AnnotationHandler, APIOperationHandler, APIParameterListHandler, AssetHandler, CollectionHandler, CommentHandler, CommunityHandler, ConnectionHandler, ConnectorTypeHandler, DisplayDataContainerHandler, EndpointHandler, EventTypeHandler, ExternalIdentifierHandler, ExternalReferenceHandler, ExternalReferenceLinkHandler, GlossaryCategoryHandler, GlossaryHandler, GlossaryTermHandler, GovernanceDefinitionHandler, GovernanceDomainHandler, GovernanceMetricHandler, LocationHandler, MetadataElementHandler, NoteHandler, NoteLogHandler, PersonRoleHandler, ProcessHandler, ProjectHandler, RelatedMediaHandler, SchemaAttributeHandler, SchemaTypeHandler, SoftwareCapabilityHandler, UserIdentityHandler, ValidValuesHandler
public class ReferenceableHandler<B> extends OpenMetadataAPITemplateHandler<B>
ReferenceableHandler manages methods on generic referenceables.

  • Constructor Details

    • ReferenceableHandler

      public ReferenceableHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)
      Construct the handler information needed to interact with the repository services
      Parameters:
      converter - specific converter for this bean class
      beanClass - name of bean class that is represented by the generic class B
      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
      localServerUserId - userId for this server
      securityVerifier - open metadata security services verifier
      supportedZones - list of zones that the access service is allowed to serve Asset instances from.
      defaultZones - list of zones that the access service should set in all new Asset instances.
      publishZones - list of zones that the access service sets up in published Asset instances.
      auditLog - destination for audit log events.

  • Method Details

    • getBeanGUIDByQualifiedName

      public String getBeanGUIDByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Return the unique identifier of the bean with the requested qualified name. The match is exact. It uses the supportedZones supplied with the service.
      Parameters:
      userId - calling user
      typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)
      typeName - unique identifier of the asset type to search for (null for the generic Asset type)
      name - name to search for
      nameParameterName - property that provided the name
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Returns:
      matching B bean
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      PropertyServerException - there is a problem retrieving information from the property server(s).
      UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getBeanGUIDByQualifiedName

      public String getBeanGUIDByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Return the bean with the requested qualified name. The match is exact.
      Parameters:
      userId - calling user
      typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)
      typeName - unique identifier of the asset type to search for (null for the generic Asset type)
      name - name to search for
      nameParameterName - property that provided the name
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      serviceSupportedZones - list of supported zones for this service
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Returns:
      matching B bean
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      PropertyServerException - there is a problem retrieving information from the property server(s).
      UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getBeanByQualifiedName

      public B getBeanByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Return the bean with the requested qualified name. The match is exact. It uses the supportedZones supplied with the service.
      Parameters:
      userId - calling user
      typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)
      typeName - unique identifier of the asset type to search for (null for the generic Asset type)
      name - name to search for
      nameParameterName - property that provided the name
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Returns:
      matching B bean
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      PropertyServerException - there is a problem retrieving information from the property server(s).
      UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getBeanByQualifiedName

      public B getBeanByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Return the bean with the requested qualified name. The match is exact.
      Parameters:
      userId - calling user
      typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)
      typeName - unique identifier of the asset type to search for (null for the generic Asset type)
      name - name to search for
      nameParameterName - property that provided the name
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      serviceSupportedZones - list of supported zones for this service
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Returns:
      matching B bean
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      PropertyServerException - there is a problem retrieving information from the property server(s).
      UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getEntityByUniqueQualifiedName

      public EntityDetail getEntityByUniqueQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Return the entity for a qualified name that is effective at a specific time - if multiple entities have this name, an exception is thrown.
      Parameters:
      userId - calling user
      typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)
      typeName - unique identifier of the asset type to search for (null for the generic Asset type)
      name - name to search for
      nameParameterName - property that provided the name
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Returns:
      list of B beans
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      PropertyServerException - there is a problem retrieving information from the property server(s).
      UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addOwner

      public void addOwner(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String owner, String ownerTypeName, String ownerPropertyName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add or replace the ownership for a referenceable.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      owner - name of the owner
      ownerTypeName - type of element that owner comes from
      ownerPropertyName - name of property used to identify owner
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeOwner

      public void removeOwner(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the ownership classification from a referenceable.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getOwnersElements

      public List<B> getOwnersElements(String userId, String ownerName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are classified with a specific owner.
      Parameters:
      userId - String userId of user making request.
      ownerName - String unique identifier for the owner.
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of elements or
      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.

    • addSecurityTags

      public void addSecurityTags(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, List<String> securityLabels, Map<String,Object> securityProperties, Map<String,List<String>> accessGroups, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add or replace the security tags for a referenceable.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      securityLabels - list of security labels defining the security characteristics of the element
      securityProperties - descriptive labels describing origin of the element
      accessGroups - map from operation to list of security groups
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeSecurityTags

      public void removeSecurityTags(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the security tags classification from a referenceable.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getSecurityTagsClassifiedElements

      public List<B> getSecurityTagsClassifiedElements(String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are classified with the SecurityTags classification.
      Parameters:
      userId - userId of user making request
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of elements or
      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.

    • addGovernanceActionClassification

      public void addGovernanceActionClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String classificationTypeGUID, String classificationTypeName, int statusIdentifier, int confidence, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, int levelIdentifier, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add or replace the governance action classification on a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      classificationTypeGUID - type GUID of governance action classification
      classificationTypeName - type name of governance action classification
      statusIdentifier - identifier for the status of the classification
      confidence - how confident? is this classification right? 0=unknown; 0-100% confident
      steward - who is responsible for this classification
      stewardTypeName - what type of element is used to identify the steward
      stewardPropertyName - what property name is used to identify the steward? guid, qualifiedName etc
      source - what is the source of the classification
      notes - any notes from the steward
      levelIdentifier - what level should the classification be set up as?
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeGovernanceActionClassification

      public void removeGovernanceActionClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String classificationTypeGUID, String classificationTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the governance expectations classification from a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      classificationTypeGUID - type GUID of governance action classification
      classificationTypeName - type name of governance action classification
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getGovernanceActionClassifiedElements

      public List<B> getGovernanceActionClassifiedElements(String userId, String classificationName, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are classified with a specific owner.
      Parameters:
      userId - String userId of user making request.
      classificationName - unique name for the governance action classification
      returnSpecificLevel - flag indicating whether to filter by levelIdentifier
      levelIdentifier - filter value
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of elements or
      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.

    • addRetentionClassification

      public void addRetentionClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, int statusIdentifier, int confidence, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, int basisIdentifier, String associatedGUID, Date archiveAfter, Date deleteAfter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add or replace the governance action classification on a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      statusIdentifier - identifier for the status of the classification
      confidence - how confident? is this classification right? 0=unknown; 0-100% confident
      steward - who is responsible for this classification
      stewardTypeName - what type of element is used to identify the steward
      stewardPropertyName - what property name is used to identify the steward? guid, qualifiedName etc
      source - what is the source of the classification
      notes - any notes from the steward
      basisIdentifier - what level should the classification be set up as?
      associatedGUID - unique identifier of policy/rule controlling this retention decision
      archiveAfter - when should the element be archived?
      deleteAfter - when should the element be deleted?
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeRetentionClassification

      public void removeRetentionClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the governance expectations classification from a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getRetentionClassifiedElements

      public List<B> getRetentionClassifiedElements(String userId, boolean returnSpecificBasisLevel, int levelIdentifier, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are classified with a specific owner.
      Parameters:
      userId - String userId of user making request.
      returnSpecificBasisLevel - flag indicating whether to filter by levelIdentifier
      levelIdentifier - filter value
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of elements or
      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.

    • addGovernanceExpectationsClassification

      public void addGovernanceExpectationsClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, Map<String,Integer> counts, Map<String,String> values, Map<String,Boolean> flags, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add or replace the governance expectations classification to a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      counts - map of name-value counts
      values - map of name-value pairs
      flags - map of name-value flags
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeGovernanceExpectationsClassification

      public void removeGovernanceExpectationsClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the governance expectations classification from a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • addGovernanceMeasurementsClassification

      public void addGovernanceMeasurementsClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, Map<String,Integer> counts, Map<String,String> values, Map<String,Boolean> flags, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add or replace the governance measurements classification to a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      counts - map of name-value counts
      values - map of name-value pairs
      flags - map of name-value flags
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeGovernanceMeasurementsClassification

      public void removeGovernanceMeasurementsClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the governance measurements classification from a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • addSubjectAreaClassification

      public void addSubjectAreaClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String subjectAreaName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add or replace the subject area classification to a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      subjectAreaName - name of the subject area
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeSubjectAreaClassification

      public void removeSubjectAreaClassification(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the subject area classification from a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - entity not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getSubjectAreaMembers

      public List<B> getSubjectAreaMembers(String userId, String subjectAreaName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are classified with a subject area name.
      Parameters:
      userId - String userId of user making request.
      subjectAreaName - String unique id for the subject area.
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of elements or
      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.

    • getSubjectAreaMembers

      public List<B> getSubjectAreaMembers(String userId, String subjectAreaName, List<String> serviceSupportedZones, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are classified with a subject area name.
      Parameters:
      userId - String userId of user making request.
      subjectAreaName - String unique id for the subject area.
      serviceSupportedZones - supported zones for calling service
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of elements or
      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.

    • setBusinessSignificant

      public void setBusinessSignificant(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String description, String scope, String businessCapabilityGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Classify a referenceable as "BusinessSignificant" (this may affect the way that lineage is displayed).
      Parameters:
      userId - calling user
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      description - description of why this is significant
      scope - scope of its business significance
      businessCapabilityGUID - unique identifier of the business capability that rates this as significant
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearBusinessSignificant

      public void clearBusinessSignificant(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the "BusinessSignificant" designation from the element.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of entity to update
      beanGUIDParameterName - name of parameter providing beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • addTemplateClassification

      public void addTemplateClassification(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String name, String versionIdentifier, String description, Map<String,String> additionalProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Classify an entity as suitable to be used as a template for cataloguing assets of a similar types.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      name - name of the template
      versionIdentifier - version identifier for the template eg 1.0
      description - description of when, where and how to use the template
      additionalProperties - any additional properties
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - asset or element not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeTemplateClassification

      public void removeTemplateClassification(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the classification that indicates that this entity can be used as a template.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - asset or element not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • addDataFieldValuesClassification

      public void addDataFieldValuesClassification(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String defaultValue, List<String> sampleValues, List<String> dataPattern, List<String> namePattern, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Classify the referenceable to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      defaultValue - initial value of a data field value
      sampleValues - list of sample values
      dataPattern - regular expression describing the values in the data filed
      namePattern - regular expression describing the name of the data field
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - asset or element not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • removeDataFieldValuesClassification

      public void removeDataFieldValuesClassification(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the classification that indicates that this referenceable describeds a data field.
      Parameters:
      userId - calling user
      beanGUID - unique identifier of bean
      beanGUIDParameterName - name of parameter supplying the beanGUID
      beanGUIDTypeName - type of bean
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - asset or element not known, null userId or guid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getDataFieldValuesClassifiedElement

      public List<B> getDataFieldValuesClassifiedElement(String userId, String defaultValue, List<String> sampleValues, List<String> dataPattern, List<String> namePattern, List<String> serviceSupportedZones, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are classified with a specific set of DataFieldValues properties.
      Parameters:
      userId - userId of user making request
      defaultValue - initial value of a data field value
      sampleValues - list of sample values
      dataPattern - regular expression describing the values in the data filed
      namePattern - regular expression describing the name of the data field
      serviceSupportedZones - supported zones for calling service
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of elements or
      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.

    • getValidValueConsumers

      public List<B> getValidValueConsumers(String userId, String validValueGUID, String validValueGUIDParameter, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Page through the list of consumers for a valid value.
      Parameters:
      userId - calling user
      validValueGUID - unique identifier of valid value to query
      validValueGUIDParameter - parameter name for validValueGUID
      startFrom - paging starting point
      pageSize - maximum number of return values.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Returns:
      list of valid value consumer beans
      Throws:
      InvalidParameterException - one of the parameters is invalid.
      UserNotAuthorizedException - the user is not authorized to make this request.
      PropertyServerException - the repository is not available or not working properly.

    • getReferenceValueAssignees

      public List<B> getReferenceValueAssignees(String userId, String validValueGUID, String validValueGUIDParameter, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Page through the list of referenceables that have this valid value as a reference value.
      Parameters:
      userId - calling user
      validValueGUID - unique identifier of valid value to query
      validValueGUIDParameter - name of parameter that provides the validValueGUID value
      startFrom - paging starting point
      pageSize - maximum number of return values
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Returns:
      list of referenceable beans
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to make this request
      PropertyServerException - the repository is not available or not working properly

    • addMoreInformation

      public void addMoreInformation(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String elementGUIDParameterName, String moreInformationGUID, String moreInformationGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a more information to element.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      elementGUID - unique identifier of the element
      elementGUIDParameterName - parameter supplying the elementGUID
      moreInformationGUID - unique identifier of the element that is supplying more information
      moreInformationGUIDParameterName - parameter supplying the moreInformationGUID
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeMoreInformation

      public void removeMoreInformation(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String elementGUIDParameterName, String moreInformationGUID, String moreInformationGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove more information from an element.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      elementGUID - unique identifier of the project
      elementGUIDParameterName - parameter supplying the elementGUID
      moreInformationGUID - unique identifier of the element that is being added to the project
      moreInformationGUIDParameterName - parameter supplying the moreInformationGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • getMoreInformation

      public List<B> getMoreInformation(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are linked to provide more information. It uses the supportedZones supplied with the service.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getMoreInformation

      public List<B> getMoreInformation(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, List<String> serviceSupportedZones, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are linked to provide more information.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      serviceSupportedZones - supported zones for calling service
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getDescriptiveElements

      public List<B> getDescriptiveElements(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • saveSemanticAssignments

      public void saveSemanticAssignments(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, List<String> glossaryTermGUIDs, String glossaryTermGUIDsParameter, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Create relationships between the identified glossary terms and an Asset.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software capability entity that represented the external source - null for local
      externalSourceName - name of the software capability entity that represented the external source - null for local
      beanGUID - unique identifier of the referenceable that is being described
      beanGUIDParameter - parameter supply the beanGUID
      glossaryTermGUIDs - list of unique identifiers of the glossary terms
      glossaryTermGUIDsParameter - parameter supplying the list of GlossaryTermGUIDs
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship (null for all time)
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - the guid properties are invalid
      UserNotAuthorizedException - user not authorized to issue this request
      PropertyServerException - problem accessing the property server

    • saveSemanticAssignment

      public void saveSemanticAssignment(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String glossaryTermGUID, String glossaryTermGUIDParameter, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Create a simple relationship between a glossary term and a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software capability entity that represented the external source - null for local
      externalSourceName - name of the software capability entity that represented the external source - null for local
      beanGUID - unique identifier of the asset that is being described
      beanGUIDParameter - parameter supply the beanGUID
      glossaryTermGUID - unique identifier of the glossary term
      glossaryTermGUIDParameter - parameter supplying the list of GlossaryTermGUID
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship (null for all time)
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - the guid properties are invalid
      UserNotAuthorizedException - user not authorized to issue this request
      PropertyServerException - problem accessing the property server

    • saveSemanticAssignment

      public void saveSemanticAssignment(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String glossaryTermGUID, String glossaryTermGUIDParameter, String description, String expression, int statusOrdinal, int confidence, String createdBy, String steward, String source, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Create a simple relationship between a glossary term and a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software capability entity that represented the external source - null for local
      externalSourceName - name of the software capability entity that represented the external source - null for local
      beanGUID - unique identifier of the element that is being described
      beanGUIDParameter - parameter supply the beanGUID
      glossaryTermGUID - unique identifier of the glossary term
      glossaryTermGUIDParameter - parameter supplying the list of GlossaryTermGUID
      description - description of the assignment
      expression - expression used to determine the assignment
      statusOrdinal - the status of the assignment
      confidence - how confident is the assignment - no confidence = 0 to complete confidence = 100
      createdBy - who/what created the assignment
      steward - which steward is responsible for assignment
      source - where was the source of the assignment
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship (null for all time)
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - the guid properties are invalid
      UserNotAuthorizedException - user not authorized to issue this request
      PropertyServerException - problem accessing the property server

    • removeSemanticAssignment

      public void removeSemanticAssignment(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String glossaryTermGUID, String glossaryTermGUIDParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the relationship between a glossary term and a referenceable (typically a field in the schema).
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software capability entity that represented the external source - null for local
      externalSourceName - name of the software capability entity that represented the external source
      beanGUID - unique identifier of the element that is being described
      beanGUIDParameter - parameter supply the beanGUID
      glossaryTermGUID - unique identifier of the glossary term
      glossaryTermGUIDParameter - parameter supplying the list of GlossaryTermGUID
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is null or invalid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getMeanings

      public List<B> getMeanings(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of glossary terms that are linked to provide a semantic definition of a data item.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getSemanticAssignments

      public List<B> getSemanticAssignments(String userId, String startingGUID, String startingGUIDParameterName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are linked to a glossary term that is providing a semantic definition.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • saveResourceListMember

      public void saveResourceListMember(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String memberGUID, String memberGUIDParameter, String resourceUse, String resourceUseDescription, Map<String,String> resourceUseProperties, boolean watchResource, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Create a relationship between a referenceable and a resource it uses.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software capability entity that represented the external source - null for local
      externalSourceName - name of the software capability entity that represented the external source - null for local
      beanGUID - unique identifier of the starting element
      beanGUIDParameter - parameter supplying the beanGUID
      memberGUID - unique identifier of the element to link
      memberGUIDParameter - parameter supplying the memberGUID
      resourceUse - string description (use ResourceUse enum from GAF)
      resourceUseDescription - description of how the resource is used
      resourceUseProperties - additional properties associated with the resource
      watchResource - should changes in the members result in notifications
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship (null for all time)
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - the guid properties are invalid
      UserNotAuthorizedException - user not authorized to issue this request
      PropertyServerException - problem accessing the property server

    • removeResourceListMember

      public void removeResourceListMember(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String memberGUID, String memberGUIDParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the relationship between a referenceable and a resource it uses.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software capability entity that represented the external source - null for local
      externalSourceName - name of the software capability entity that represented the external source
      beanGUID - unique identifier of the referenceable
      beanGUIDParameter - parameter supplying beanGUID
      memberGUID - unique identifier of the glossary term
      memberGUIDParameter - parameter supplying memberGUID
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is null or invalid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getResourceList

      public List<B> getResourceList(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are linked to provide resources to the starting element (for example, a community provides people to a governance domain).
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getSupportedByResource

      public List<B> getSupportedByResource(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • saveCatalogTemplate

      public void saveCatalogTemplate(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String memberGUID, String memberGUIDParameter, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Create a relationship between a referenceable and a resource it uses.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software capability entity that represented the external source - null for local
      externalSourceName - name of the software capability entity that represented the external source - null for local
      beanGUID - unique identifier of the starting element
      beanGUIDParameter - parameter supplying the beanGUID
      memberGUID - unique identifier of the element to link
      memberGUIDParameter - parameter supplying the memberGUID
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship (null for all time)
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - the guid properties are invalid
      UserNotAuthorizedException - user not authorized to issue this request
      PropertyServerException - problem accessing the property server

    • removeCatalogTemplate

      public void removeCatalogTemplate(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String memberGUID, String memberGUIDParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the relationship between a referenceable and a template it uses.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software capability entity that represented the external source - null for local
      externalSourceName - name of the software capability entity that represented the external source
      beanGUID - unique identifier of the referenceable
      beanGUIDParameter - parameter supplying beanGUID
      memberGUID - unique identifier of the glossary term
      memberGUIDParameter - parameter supplying memberGUID
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is null or invalid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getCatalogTemplateList

      public List<B> getCatalogTemplateList(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are linked to provide templates to the starting element.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getSupportedByTemplate

      public List<B> getSupportedByTemplate(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Retrieve the list of templates assigned to a resource via the "CatalogTemplate" relationship between two referenceables.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • addAssignmentScope

      public void addAssignmentScope(String userId, String externalSourceGUID, String externalSourceName, String assignedActorGUID, String assignedActorGUIDParameterName, String assignedScopeGUID, String assignedScopeGUIDParameterName, String assignmentType, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a scope to an actor - both referenceables.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      assignedActorGUID - unique identifier of the actor
      assignedActorGUIDParameterName - parameter supplying the assignedActorGUID
      assignedScopeGUID - unique identifier of the scope
      assignedScopeGUIDParameterName - parameter supplying the assignedScopeGUID
      assignmentType - Type of assignment - such as accountable, responsible, observing ...
      description - mode details about the assignment
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeAssignmentScope

      public void removeAssignmentScope(String userId, String externalSourceGUID, String externalSourceName, String assignedActorGUID, String assignedActorGUIDParameterName, String assignedScopeGUID, String assignedScopeGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a scope from an actor - both referenceables.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      assignedActorGUID - unique identifier of the actor
      assignedActorGUIDParameterName - parameter supplying the assignedActorGUID
      assignedScopeGUID - unique identifier of the scope
      assignedScopeGUIDParameterName - parameter supplying the assignedScopeGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAssignmentScope

      public List<B> getAssignmentScope(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are scoping the work of one or more actors/roles.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getAssignedActors

      public List<B> getAssignedActors(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of actors/roles that assigned to a specific scope.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • addStakeholder

      public void addStakeholder(String userId, String externalSourceGUID, String externalSourceName, String commissionedGUID, String commissionedGUIDParameterName, String stakeholderGUID, String stakeholderGUIDParameterName, String stakeholderRole, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a commissioning stakeholder to a project/team/community etc.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      commissionedGUID - unique identifier of the project etc
      commissionedGUIDParameterName - parameter supplying the commissionedGUID
      stakeholderGUID - unique identifier of the stakeholder - may be a person, team, role, ...
      stakeholderGUIDParameterName - parameter supplying the stakeholderGUID
      stakeholderRole - what are the responsibilities of a stakeholder?
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeStakeholder

      public void removeStakeholder(String userId, String externalSourceGUID, String externalSourceName, String commissionedGUID, String commissionedGUIDParameterName, String stakeholderGUID, String stakeholderGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a commissioning stakeholder from a project/team/community etc.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      commissionedGUID - unique identifier of the project etc
      commissionedGUIDParameterName - parameter supplying the commissionedGUID
      stakeholderGUID - unique identifier of the stakeholder
      stakeholderGUIDParameterName - parameter supplying the stakeholderGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • getStakeholders

      public List<B> getStakeholders(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list one or more actors/roles are stakeholders for the starting element.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getCommissionedByStakeholder

      public List<B> getCommissionedByStakeholder(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that one or more actors/roles are stakeholders for.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getSourceElements

      public List<B> getSourceElements(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were used to create the requested element. Typically only one element is returned.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • getElementsSourceFrom

      public List<B> getElementsSourceFrom(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were created using the requested element as a template.
      Parameters:
      userId - String userId of user making request.
      startingGUID - String unique id for element.
      startingGUIDParameterName - name of parameter supplying the GUID
      suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • addGovernedBy

      public void addGovernedBy(String userId, String externalSourceGUID, String externalSourceName, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String referenceableGUID, String referenceableGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a governedBy relationship between a governance definition and a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      governanceDefinitionGUID - unique identifier of the governance definition
      governanceDefinitionGUIDParameterName - parameter supplying the governanceDefinitionGUID
      referenceableGUID - unique identifier of the referenceable being governed
      referenceableGUIDParameterName - parameter supplying the referenceableGUID
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeGovernedBy

      public void removeGovernedBy(String userId, String externalSourceGUID, String externalSourceName, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String referenceableGUID, String referenceableGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a governedBy relationship between a governance definition and a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      governanceDefinitionGUID - unique identifier of the governance definition
      governanceDefinitionGUIDParameterName - parameter supplying the governanceDefinitionGUID
      referenceableGUID - unique identifier of the referenceable being governed
      referenceableGUIDParameterName - parameter supplying the referenceableGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGovernedElements

      public List<B> getGovernedElements(String userId, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of elements that are governed by a governance definition.
      Parameters:
      userId - String userId of user making request.
      governanceDefinitionGUID - String unique id for element.
      governanceDefinitionGUIDParameterName - name of parameter supplying the GUID
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • addGovernanceDefinitionScope

      public void addGovernanceDefinitionScope(String userId, String externalSourceGUID, String externalSourceName, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String referenceableGUID, String referenceableGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a governedBy relationship between a governance definition and a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      governanceDefinitionGUID - unique identifier of the governance definition
      governanceDefinitionGUIDParameterName - parameter supplying the governanceDefinitionGUID
      referenceableGUID - unique identifier of the referenceable being governed
      referenceableGUIDParameterName - parameter supplying the referenceableGUID
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeGovernanceDefinitionScope

      public void removeGovernanceDefinitionScope(String userId, String externalSourceGUID, String externalSourceName, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String referenceableGUID, String referenceableGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a governedBy relationship between a governance definition and a referenceable.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      governanceDefinitionGUID - unique identifier of the governance definition
      governanceDefinitionGUIDParameterName - parameter supplying the governanceDefinitionGUID
      referenceableGUID - unique identifier of the referenceable being governed
      referenceableGUIDParameterName - parameter supplying the referenceableGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGovernanceDefinitionScope

      public List<B> getGovernanceDefinitionScope(String userId, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Returns the list of one or more referenceables that define the scope of a governance definition.
      Parameters:
      userId - String userId of user making request.
      governanceDefinitionGUID - String unique id for element.
      governanceDefinitionGUIDParameterName - name of parameter supplying the GUID
      suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable
      startFrom - int starting position for fist returned element.
      pageSize - int maximum number of elements to return on the call.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - String calling method
      Returns:
      a list of assets or
      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.

    • addImplementedBy

      public void addImplementedBy(String userId, String externalSourceGUID, String externalSourceName, String designArtifactGUID, String designArtifactGUIDParameterName, String implementationGUID, String implementationGUIDParameterName, String designStep, String role, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a link between a design artifact and its implementation.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      designArtifactGUID - unique identifier of the project
      designArtifactGUIDParameterName - parameter supplying the designArtifactGUID
      implementationGUID - unique identifier of the element that is being added to the project
      implementationGUIDParameterName - parameter supplying the implementationGUID
      designStep - match to design process
      role - describe role performing from design
      description - additional description
      effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
      effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeImplementedBy

      public void removeImplementedBy(String userId, String externalSourceGUID, String externalSourceName, String designArtifactGUID, String designArtifactGUIDParameterName, String implementationGUID, String implementationGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a link between a design artifact and its implementation.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of the software capability that owns this project
      externalSourceName - unique name of the software capability that owns this project
      designArtifactGUID - unique identifier of the project
      designArtifactGUIDParameterName - parameter supplying the designArtifactGUID
      implementationGUID - unique identifier of the element that is being added to the project
      implementationGUIDParameterName - parameter supplying the implementationGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • getCollectionMembers

      public List<B> getCollectionMembers(String userId, String collectionGUID, String collectionGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the list of elements associated with a collection.
      Parameters:
      userId - calling user
      collectionGUID - unique identifier of the collection to query
      collectionGUIDParameterName - name of the parameter supplying collectionGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Returns:
      list of metadata elements describing the definitions associated with the requested definition
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • linkElementsAsPeerDuplicates

      public void linkElementsAsPeerDuplicates(String userId, String element1GUID, String element1GUIDParameter, String element2GUID, String element2GUIDParameter, boolean setKnownDuplicate, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, List<String> serviceSupportedZones, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a simple relationship between two elements in an Asset description (typically the asset itself or attributes in their schema).
      Parameters:
      userId - calling user
      element1GUID - unique identifier of first element
      element1GUIDParameter - name of parameter supplying element1GUID
      element2GUID - unique identifier of second element
      element2GUIDParameter - name of parameter supplying element2GUID
      setKnownDuplicate - should the KnownDuplicate classification be set on the elements?
      statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)
      steward - identifier of the steward
      stewardTypeName - type of element used to identify the steward
      stewardPropertyName - property name used to identify steward
      source - source of the duplicate detection processing
      notes - notes for the steward
      serviceSupportedZones - list of supported zones for this service
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is null or invalid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • unlinkElementsAsPeerDuplicates

      public void unlinkElementsAsPeerDuplicates(String userId, String element1GUID, String element1GUIDParameter, String element2GUID, String element2GUIDParameter, List<String> serviceSupportedZones, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the relationship between two elements that marks them as duplicates.
      Parameters:
      userId - calling user
      element1GUID - unique identifier of first element
      element1GUIDParameter - name of parameter supplying element1GUID
      element2GUID - unique identifier of second element
      element2GUIDParameter - name of parameter supplying element2GUID
      serviceSupportedZones - list of supported zones for this service
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is null or invalid or the elements are not linked as duplicates
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • linkConsolidatedDuplicate

      public void linkConsolidatedDuplicate(String userId, String consolidatedElementGUID, String consolidatedElementGUIDParameter, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, List<String> sourceElementGUIDs, String sourceElementGUIDsParameterName, List<String> serviceSupportedZones, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Identify an element that acts as a consolidated version for a set of duplicate elements. (The consolidated element is created using createMetadataElement.) Creates a simple relationship between the elements. If the ConsolidatedDuplicate classification already exists, the properties are updated.
      Parameters:
      userId - calling user
      consolidatedElementGUID - unique identifier of the metadata element
      consolidatedElementGUIDParameter - parameter name to use for the requested GUID
      statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)
      steward - identifier of the steward
      stewardTypeName - type of element used to identify the steward
      stewardPropertyName - property name used to identify steward
      source - source of the duplicate detection processing
      notes - notes for the steward
      sourceElementGUIDs - List of the source elements that must be linked to the consolidated element. It is assumed that they already have the KnownDuplicateClassification.
      sourceElementGUIDsParameterName - parameter name for the source GUIDs
      serviceSupportedZones - list of supported zones for this service
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is null or invalid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • setVendorProperties

      public void setVendorProperties(String userId, String referenceableGUID, Map<String,String> vendorProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create the property facet for the vendor properties.
      Parameters:
      userId - calling user
      referenceableGUID - unique identifier of the software capability
      vendorProperties - properties for the vendor
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is null or invalid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem

    • getVendorProperties

      public Map<String,String> getVendorProperties(String userId, String referenceableGUID, String referenceableGUIDParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the property facet for the vendor properties. It uses the supportedZones supplied with the service.
      Parameters:
      userId - calling user
      referenceableGUID - unique identifier of the metadata element
      referenceableGUIDParameter - parameter name for referenceableGUID
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - calling method
      Returns:
      map of properties
      Throws:
      InvalidParameterException - one of the parameters is null or invalid
      PropertyServerException - problem accessing property server
      UserNotAuthorizedException - security access problem