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
ReferenceableHandler manages methods on generic referenceables.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
OpenMetadataAPIGenericHandler.AnchorIdentifiers
-
Field Summary
Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler
assetActionDescription, auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, qualifiedNamePropertyNamesList, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones
-
Constructor Summary
ConstructorDescriptionReferenceableHandler
(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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
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) Add a scope to an actor - both referenceables.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) Classify the referenceable to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.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) Add or replace the governance action classification on a referenceable.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) Add a governedBy relationship between a governance definition and a referenceable.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) Add or replace the governance expectations classification to a referenceable.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) Add or replace the governance measurements classification to a referenceable.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) Add a governedBy relationship between a governance definition and a referenceable.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) Add a link between a design artifact and its implementation.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) Add a more information to element.void
addOwner
(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String owner, String ownerTypeName, String ownerPropertyName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Add or replace the ownership for a referenceable.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) Add or replace the governance action classification on a referenceable.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) Add or replace the security tags for a referenceable.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) Add a commissioning stakeholder to a project/team/community etc.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) Add or replace the subject area classification to a referenceable.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) Classify an entity as suitable to be used as a template for cataloguing assets of a similar types.void
clearBusinessSignificant
(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the "BusinessSignificant" designation from the element.findBeanGUIDsByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, int startFrom, int pageSize, Date effectiveTime, String methodName) Return a list of unique identifiers for referenceables with the requested qualified name.findBeansByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, Date effectiveTime, String methodName) Return a list of referenceables with the requested qualified name.findBeansByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, int startFrom, int pageSize, Date effectiveTime, String methodName) Return a list of referenceables with the requested qualified name.getAssignedActors
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of actors/roles that assigned to a specific scope.getAssignmentScope
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are scoping the work of one or more actors/roles.getBeanByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Return the bean with the requested qualified name.getBeanByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) Return the bean with the requested qualified name.getBeanGUIDByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Return the unique identifier of the bean with the requested qualified name.getBeanGUIDByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) Return the bean with the requested qualified name.getBeanGUIDsByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, Date effectiveTime, String methodName) Return a list of unique identifiers for referenceables with the requested qualified name.getBeanGUIDsByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, int startFrom, int pageSize, Date effectiveTime, String methodName) Return a list of unique identifiers for referenceables with the requested qualified name.getBeansByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Return a list of referenceables with the requested qualified name.getBeansByQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Return a list of referenceables with the requested qualified name.getCatalogTemplateList
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are linked to provide templates to the starting element.getCollectionMembers
(String userId, String collectionGUID, String collectionGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Return the list of elements associated with a collection.getCommissionedByStakeholder
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that one or more actors/roles are stakeholders for.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) Returns the list of elements that are classified with a specific set of DataFieldValues properties.getDescriptiveElements
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.getElementsSourceFrom
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the elements linked via a "SourceFrom" relationship to the requested element.getEntityByUniqueQualifiedName
(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Return the entity for a qualified name that is effective at a specific time - if multiple entities have this name, an exception is thrown.getGovernanceActionClassifiedElements
(String userId, String classificationName, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are classified with a specific owner.getGovernanceDefinitionScope
(String userId, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of one or more referenceables that define the scope of a governance definition.getGovernedElements
(String userId, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are governed by a governance definition.getMeanings
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of glossary terms that are linked to provide a semantic definition of a data item.getMoreInformation
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are linked to provide more information.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) Returns the list of elements that are linked to provide more information.getOwnersElements
(String userId, String ownerName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are classified with a specific owner.getReferenceValueAssignees
(String userId, String validValueGUID, String validValueGUIDParameter, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Page through the list of referenceables that have this valid value as a reference value.getResourceList
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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).getRetentionClassifiedElements
(String userId, boolean returnSpecificBasisLevel, int levelIdentifier, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are classified with a specific owner.getSecurityTagsClassifiedElements
(String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of assets that are classified with a specific origin.getSemanticAssignments
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are linked to a glossary term that is providing a semantic definition.getSourceElements
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the elements linked via a "SourceFrom" relationship to the requested element.getStakeholders
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list one or more actors/roles are stakeholders for the starting element.getSubjectAreaMembers
(String userId, String subjectAreaName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are classified with a subject area name.getSubjectAreaMembers
(String userId, String subjectAreaName, List<String> serviceSupportedZones, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Returns the list of elements that are classified with a subject area name.getSupportedByResource
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.getSupportedByTemplate
(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of templates assigned to a resource via the "CatalogTemplate" relationship between two referenceables.getValidValueConsumers
(String userId, String validValueGUID, String validValueGUIDParameter, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Page through the list of consumers for a valid value.getVendorProperties
(String userId, String referenceableGUID, String referenceableGUIDParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the property facet for the vendor properties.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) Identify an element that acts as a consolidated version for a set of duplicate elements.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) Create a simple relationship between two elements in an Asset description (typically the asset itself or attributes in their schema).void
removeAssignmentScope
(String userId, String externalSourceGUID, String externalSourceName, String assignedActorGUID, String assignedActorGUIDParameterName, String assignedScopeGUID, String assignedScopeGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove a scope from an actor - both referenceables.void
removeCatalogTemplate
(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String memberGUID, String memberGUIDParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the relationship between a referenceable and a template it uses.void
removeDataFieldValuesClassification
(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the classification that indicates that this referenceable describeds a data field.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) Remove the governance expectations classification from a referenceable.void
removeGovernanceDefinitionScope
(String userId, String externalSourceGUID, String externalSourceName, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String referenceableGUID, String referenceableGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove a governedBy relationship between a governance definition and a referenceable.void
removeGovernanceExpectationsClassification
(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the governance expectations classification from a referenceable.void
removeGovernanceMeasurementsClassification
(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the governance measurements classification from a referenceable.void
removeGovernedBy
(String userId, String externalSourceGUID, String externalSourceName, String governanceDefinitionGUID, String governanceDefinitionGUIDParameterName, String referenceableGUID, String referenceableGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove a governedBy relationship between a governance definition and a referenceable.void
removeImplementedBy
(String userId, String externalSourceGUID, String externalSourceName, String designArtifactGUID, String designArtifactGUIDParameterName, String implementationGUID, String implementationGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove a link between a design artifact and its implementation.void
removeMoreInformation
(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String elementGUIDParameterName, String moreInformationGUID, String moreInformationGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove more information from an element.void
removeOwner
(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the ownership classification from a referenceable.void
removeResourceListMember
(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String memberGUID, String memberGUIDParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the relationship between a referenceable and a resource it uses.void
removeRetentionClassification
(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the governance expectations classification from a referenceable.void
removeSecurityTags
(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the security tags classification from a referenceable.void
removeSemanticAssignment
(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String glossaryTermGUID, String glossaryTermGUIDParameter, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the relationship between a glossary term and a referenceable (typically a field in the schema).void
removeStakeholder
(String userId, String externalSourceGUID, String externalSourceName, String commissionedGUID, String commissionedGUIDParameterName, String stakeholderGUID, String stakeholderGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove a commissioning stakeholder from a project/team/community etc.void
removeSubjectAreaClassification
(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the subject area classification from a referenceable.void
removeTemplateClassification
(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the classification that indicates that this entity can be used as a template.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) Create a relationship between a referenceable and a resource it uses.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) Create a relationship between a referenceable and a resource it uses.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) Create a simple relationship between a glossary term and a referenceable.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) Create a simple relationship between a glossary term and a referenceable.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) Create relationships between the identified glossary terms and an Asset.void
setBusinessSignificant
(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String description, String scope, String businessCapabilityGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Classify a referenceable as "BusinessSignificant" (this may affect the way that lineage is displayed).void
setVendorProperties
(String userId, String referenceableGUID, Map<String, String> vendorProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Create the property facet for the vendor properties.void
unlinkElementsAsPeerDuplicates
(String userId, String element1GUID, String element1GUIDParameter, String element2GUID, String element2GUIDParameter, List<String> serviceSupportedZones, String methodName) Remove the relationship between two elements that marks them as duplicates.Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler
createBeanFromTemplate, createBeanFromTemplate
Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
addAnchorGUIDToBuilder, addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanInRepository, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, entityMatchSearchCriteria, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, findEntities, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntitiesFromUser, getAttachedEntity, getAttachedEntity, getAttachedEntityFromUser, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getAttachmentsForType, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanHistory, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getDomainName, getDomainName, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getSpecification, getSupplementaryProperties, getUniqueAttachmentLink, getUniqueAttachmentLink, isBeanIsolated, isEntityATypeOf, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, regexSearchCriteria, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, uncheckedLinkElementToElement, undoBeanUpdateInRepository, undoBeanUpdateInRepository, undoBeanUpdateInRepository, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipEffectivityDates, updateRelationshipProperties, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, validateUniqueProperty, verifyExternalSourceIdentity
Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler
getConverter, getElementStub, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getSupportedZones, getTypeDefByName, setSecurityVerifier
-
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 classbeanClass
- name of bean class that is represented by the generic class BserviceName
- name of this serviceserverName
- name of the local serverinvalidParameterHandler
- handler for managing parameter errorsrepositoryHandler
- manages calls to the repository servicesrepositoryHelper
- provides utilities for manipulating the repository services objectslocalServerUserId
- userId for this serversecurityVerifier
- open metadata security services verifiersupportedZones
- 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 usertypeGUID
- 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 fornameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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 usertypeGUID
- 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 fornameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateserviceSupportedZones
- list of supported zones for this serviceeffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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 usertypeGUID
- 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 fornameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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 usertypeGUID
- 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 fornameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateserviceSupportedZones
- list of supported zones for this serviceeffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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.
-
getBeanGUIDsByQualifiedName
public List<String> getBeanGUIDsByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Return a list of unique identifiers for referenceables with the requested qualified name. The match is exact. It uses the supportedZones supplied with the service.- Parameters:
userId
- calling usertypeGUID
- 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 fornameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicatestartFrom
- starting element (used in paging through large result sets)pageSize
- maximum number of results to returneffectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)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.
-
getBeanGUIDsByQualifiedName
public List<String> getBeanGUIDsByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, int startFrom, int pageSize, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Return a list of unique identifiers for referenceables with the requested qualified name. The match is exact.- Parameters:
userId
- calling usertypeGUID
- 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 fornameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateserviceSupportedZones
- list of supported zones for this servicestartFrom
- starting element (used in paging through large result sets)pageSize
- maximum number of results to returneffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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.
-
getBeansByQualifiedName
public List<B> getBeansByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Return a list of referenceables with the requested qualified name. The match is exact. It uses the supportedZones supplied with the service.- Parameters:
userId
- calling usertypeGUID
- 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 fornameParameterName
- property that provided the namestartFrom
- starting element (used in paging through large result sets)pageSize
- maximum number of results to returnforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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.
-
getBeansByQualifiedName
public List<B> getBeansByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Return a list of referenceables with the requested qualified name. The match is exact.- Parameters:
userId
- calling usertypeGUID
- 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 fornameParameterName
- property that provided the nameserviceSupportedZones
- list of supported zones for this servicestartFrom
- starting element (used in paging through large result sets)pageSize
- maximum number of results to returnforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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.
-
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 usertypeGUID
- 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 fornameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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.
-
findBeanGUIDsByQualifiedName
public List<String> findBeanGUIDsByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, int startFrom, int pageSize, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Return a list of unique identifiers for referenceables with the requested qualified name. The match is via a Regular Expression (RegEx).- Parameters:
userId
- calling usertypeGUID
- 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 - this is a regular expression (RegEx)nameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateserviceSupportedZones
- list of supported zones for this servicestartFrom
- starting element (used in paging through large result sets)pageSize
- maximum number of results to returneffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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.
-
findBeansByQualifiedName
public List<B> findBeansByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Return a list of referenceables with the requested qualified name. The match is via a Regular Expression (RegEx). It uses the supportedZones supplied with the service.- Parameters:
userId
- calling usertypeGUID
- 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 - this is a regular expression (RegEx)nameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicatestartFrom
- starting element (used in paging through large result sets)pageSize
- maximum number of results to returneffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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.
-
findBeansByQualifiedName
public List<B> findBeansByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, int startFrom, int pageSize, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Return a list of referenceables with the requested qualified name. The match is via a Regular Expression (RegEx).- Parameters:
userId
- calling usertypeGUID
- 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 - this is a regular expression (RegEx)nameParameterName
- property that provided the nameforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateserviceSupportedZones
- list of supported zones for this servicestartFrom
- starting element (used in paging through large result sets)pageSize
- maximum number of results to returneffectiveTime
- the time that the retrieved elements must be effective formethodName
- 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 userbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beanowner
- name of the ownerownerTypeName
- type of element that owner comes fromownerPropertyName
- name of property used to identify ownerforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of elements or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionList<String>> accessGroups, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Add or replace the security tags for a referenceable.- Parameters:
userId
- calling userbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beansecurityLabels
- list of security labels defining the security characteristics of the elementsecurityProperties
- descriptive labels describing origin of the elementaccessGroups
- map from operation to list of security groupsforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 assets that are classified with a specific origin.- Parameters:
userId
- userId of user making requeststartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of elements or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beanclassificationTypeGUID
- type GUID of governance action classificationclassificationTypeName
- type name of governance action classificationstatusIdentifier
- identifier for the status of the classificationconfidence
- how confident? is this classification right? 0=unknown; 0-100% confidentsteward
- who is responsible for this classificationstewardTypeName
- what type of element is used to identify the stewardstewardPropertyName
- what property name is used to identify the steward? guid, qualifiedName etcsource
- what is the source of the classificationnotes
- any notes from the stewardlevelIdentifier
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveFrom
- 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 formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beanclassificationTypeGUID
- type GUID of governance action classificationclassificationTypeName
- type name of governance action classificationforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 classificationreturnSpecificLevel
- flag indicating whether to filter by levelIdentifierlevelIdentifier
- filter valuestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of elements or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beanstatusIdentifier
- identifier for the status of the classificationconfidence
- how confident? is this classification right? 0=unknown; 0-100% confidentsteward
- who is responsible for this classificationstewardTypeName
- what type of element is used to identify the stewardstewardPropertyName
- what property name is used to identify the steward? guid, qualifiedName etcsource
- what is the source of the classificationnotes
- any notes from the stewardbasisIdentifier
- what level should the classification be set up as?associatedGUID
- unique identifier of policy/rule controlling this retention decisionarchiveAfter
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveFrom
- 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 formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 levelIdentifierlevelIdentifier
- filter valuestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of elements or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionString> values, Map<String, Boolean> flags, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) Add or replace the governance expectations classification to a referenceable.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beancounts
- map of name-value countsvalues
- map of name-value pairsflags
- map of name-value flagsforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveFrom
- 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 formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionString> values, Map<String, Boolean> flags, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) Add or replace the governance measurements classification to a referenceable.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beancounts
- map of name-value countsvalues
- map of name-value pairsflags
- map of name-value flagsforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveFrom
- 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 formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beansubjectAreaName
- name of the subject areaforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveFrom
- 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 formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of elements or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 servicestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of elements or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beandescription
- description of why this is significantscope
- scope of its business significancebusinessCapabilityGUID
- unique identifier of the business capability that rates this as significantforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 userbeanGUID
- unique identifier of entity to updatebeanGUIDParameterName
- name of parameter providing beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, PropertyServerExceptionClassify an entity as suitable to be used as a template for cataloguing assets of a similar types.- Parameters:
userId
- calling userbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beanname
- name of the templateversionIdentifier
- version identifier for the template eg 1.0description
- description of when, where and how to use the templateadditionalProperties
- any additional propertiesforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beandefaultValue
- initial value of a data field valuesampleValues
- list of sample valuesdataPattern
- regular expression describing the values in the data filednamePattern
- regular expression describing the name of the data fieldforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userbeanGUID
- unique identifier of beanbeanGUIDParameterName
- name of parameter supplying the beanGUIDbeanGUIDTypeName
- type of beanforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 requestdefaultValue
- initial value of a data field valuesampleValues
- list of sample valuesdataPattern
- regular expression describing the values in the data filednamePattern
- regular expression describing the name of the data fieldserviceSupportedZones
- supported zones for calling servicestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of elements or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 uservalidValueGUID
- unique identifier of valid value to queryvalidValueGUIDParameter
- parameter name for validValueGUIDstartFrom
- paging starting pointpageSize
- maximum number of return values.forLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- 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 uservalidValueGUID
- unique identifier of valid value to queryvalidValueGUIDParameter
- name of parameter that provides the validValueGUID valuestartFrom
- paging starting pointpageSize
- maximum number of return valuesforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- 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 invalidUserNotAuthorizedException
- the user is not authorized to make this requestPropertyServerException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectelementGUID
- unique identifier of the elementelementGUIDParameterName
- parameter supplying the elementGUIDmoreInformationGUID
- unique identifier of the element that is supplying more informationmoreInformationGUIDParameterName
- parameter supplying the moreInformationGUIDeffectiveFrom
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectelementGUID
- unique identifier of the projectelementGUIDParameterName
- parameter supplying the elementGUIDmoreInformationGUID
- unique identifier of the element that is being added to the projectmoreInformationGUIDParameterName
- parameter supplying the moreInformationGUIDforLineage
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceableserviceSupportedZones
- supported zones for calling servicestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external source - null for localbeanGUID
- unique identifier of the referenceable that is being describedbeanGUIDParameter
- parameter supply the beanGUIDglossaryTermGUIDs
- list of unique identifiers of the glossary termsglossaryTermGUIDsParameter
- parameter supplying the list of GlossaryTermGUIDseffectiveFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- 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 invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external source - null for localbeanGUID
- unique identifier of the asset that is being describedbeanGUIDParameter
- parameter supply the beanGUIDglossaryTermGUID
- unique identifier of the glossary termglossaryTermGUIDParameter
- parameter supplying the list of GlossaryTermGUIDeffectiveFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- the guid properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external source - null for localbeanGUID
- unique identifier of the element that is being describedbeanGUIDParameter
- parameter supply the beanGUIDglossaryTermGUID
- unique identifier of the glossary termglossaryTermGUIDParameter
- parameter supplying the list of GlossaryTermGUIDdescription
- description of the assignmentexpression
- expression used to determine the assignmentstatusOrdinal
- the status of the assignmentconfidence
- how confident is the assignment - no confidence = 0 to complete confidence = 100createdBy
- who/what created the assignmentsteward
- which steward is responsible for assignmentsource
- where was the source of the assignmenteffectiveFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- the guid properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external sourcebeanGUID
- unique identifier of the element that is being describedbeanGUIDParameter
- parameter supply the beanGUIDglossaryTermGUID
- unique identifier of the glossary termglossaryTermGUIDParameter
- parameter supplying the list of GlossaryTermGUIDforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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, UserNotAuthorizedExceptionCreate a relationship between a referenceable and a resource it uses.- Parameters:
userId
- calling userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external source - null for localbeanGUID
- unique identifier of the starting elementbeanGUIDParameter
- parameter supplying the beanGUIDmemberGUID
- unique identifier of the element to linkmemberGUIDParameter
- parameter supplying the memberGUIDresourceUse
- string description (use ResourceUse enum from GAF)resourceUseDescription
- description of how the resource is usedresourceUseProperties
- additional properties associated with the resourcewatchResource
- should changes in the members result in notificationseffectiveFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- the guid properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external sourcebeanGUID
- unique identifier of the referenceablebeanGUIDParameter
- parameter supplying beanGUIDmemberGUID
- unique identifier of the glossary termmemberGUIDParameter
- parameter supplying memberGUIDforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external source - null for localbeanGUID
- unique identifier of the starting elementbeanGUIDParameter
- parameter supplying the beanGUIDmemberGUID
- unique identifier of the element to linkmemberGUIDParameter
- parameter supplying the memberGUIDeffectiveFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- the guid properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external sourcebeanGUID
- unique identifier of the referenceablebeanGUIDParameter
- parameter supplying beanGUIDmemberGUID
- unique identifier of the glossary termmemberGUIDParameter
- parameter supplying memberGUIDforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectassignedActorGUID
- unique identifier of the actorassignedActorGUIDParameterName
- parameter supplying the assignedActorGUIDassignedScopeGUID
- unique identifier of the scopeassignedScopeGUIDParameterName
- parameter supplying the assignedScopeGUIDassignmentType
- Type of assignment - such as accountable, responsible, observing ...description
- mode details about the assignmenteffectiveFrom
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectassignedActorGUID
- unique identifier of the actorassignedActorGUIDParameterName
- parameter supplying the assignedActorGUIDassignedScopeGUID
- unique identifier of the scopeassignedScopeGUIDParameterName
- parameter supplying the assignedScopeGUIDforLineage
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectcommissionedGUID
- unique identifier of the project etccommissionedGUIDParameterName
- parameter supplying the commissionedGUIDstakeholderGUID
- unique identifier of the stakeholder - may be a person, team, role, ...stakeholderGUIDParameterName
- parameter supplying the stakeholderGUIDstakeholderRole
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectcommissionedGUID
- unique identifier of the project etccommissionedGUIDParameterName
- parameter supplying the commissionedGUIDstakeholderGUID
- unique identifier of the stakeholderstakeholderGUIDParameterName
- parameter supplying the stakeholderGUIDforLineage
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 GUIDsuppliedStartingTypeName
- name of the type of object that the search begins with - null means referenceablesuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectgovernanceDefinitionGUID
- unique identifier of the governance definitiongovernanceDefinitionGUIDParameterName
- parameter supplying the governanceDefinitionGUIDreferenceableGUID
- unique identifier of the referenceable being governedreferenceableGUIDParameterName
- parameter supplying the referenceableGUIDeffectiveFrom
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectgovernanceDefinitionGUID
- unique identifier of the governance definitiongovernanceDefinitionGUIDParameterName
- parameter supplying the governanceDefinitionGUIDreferenceableGUID
- unique identifier of the referenceable being governedreferenceableGUIDParameterName
- parameter supplying the referenceableGUIDforLineage
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 GUIDsuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectgovernanceDefinitionGUID
- unique identifier of the governance definitiongovernanceDefinitionGUIDParameterName
- parameter supplying the governanceDefinitionGUIDreferenceableGUID
- unique identifier of the referenceable being governedreferenceableGUIDParameterName
- parameter supplying the referenceableGUIDeffectiveFrom
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectgovernanceDefinitionGUID
- unique identifier of the governance definitiongovernanceDefinitionGUIDParameterName
- parameter supplying the governanceDefinitionGUIDreferenceableGUID
- unique identifier of the referenceable being governedreferenceableGUIDParameterName
- parameter supplying the referenceableGUIDforLineage
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 GUIDsuppliedResultingTypeName
- name of the type of object that the search returns - null mean referenceablestartFrom
- 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 returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- String calling method- Returns:
- a list of assets or
- Throws:
InvalidParameterException
- - the GUID is not recognized or the paging values are invalid orPropertyServerException
- - there is a problem retrieving the asset properties from the property server orUserNotAuthorizedException
- - 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectdesignArtifactGUID
- unique identifier of the projectdesignArtifactGUIDParameterName
- parameter supplying the designArtifactGUIDimplementationGUID
- unique identifier of the element that is being added to the projectimplementationGUIDParameterName
- parameter supplying the implementationGUIDdesignStep
- match to design processrole
- describe role performing from designdescription
- additional descriptioneffectiveFrom
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 userexternalSourceGUID
- unique identifier of the software capability that owns this projectexternalSourceName
- unique name of the software capability that owns this projectdesignArtifactGUID
- unique identifier of the projectdesignArtifactGUIDParameterName
- parameter supplying the designArtifactGUIDimplementationGUID
- unique identifier of the element that is being added to the projectimplementationGUIDParameterName
- parameter supplying the implementationGUIDforLineage
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 usercollectionGUID
- unique identifier of the collection to querycollectionGUIDParameterName
- name of the parameter supplying collectionGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Returns:
- list of metadata elements describing the definitions associated with the requested definition
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 userelement1GUID
- unique identifier of first elementelement1GUIDParameter
- name of parameter supplying element1GUIDelement2GUID
- unique identifier of second elementelement2GUIDParameter
- name of parameter supplying element2GUIDsetKnownDuplicate
- 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 stewardstewardTypeName
- type of element used to identify the stewardstewardPropertyName
- property name used to identify stewardsource
- source of the duplicate detection processingnotes
- notes for the stewardserviceSupportedZones
- list of supported zones for this servicemethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userelement1GUID
- unique identifier of first elementelement1GUIDParameter
- name of parameter supplying element1GUIDelement2GUID
- unique identifier of second elementelement2GUIDParameter
- name of parameter supplying element2GUIDserviceSupportedZones
- list of supported zones for this servicemethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is null or invalid or the elements are not linked as duplicatesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userconsolidatedElementGUID
- unique identifier of the metadata elementconsolidatedElementGUIDParameter
- parameter name to use for the requested GUIDstatusIdentifier
- what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)steward
- identifier of the stewardstewardTypeName
- type of element used to identify the stewardstewardPropertyName
- property name used to identify stewardsource
- source of the duplicate detection processingnotes
- notes for the stewardsourceElementGUIDs
- 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 GUIDsserviceSupportedZones
- list of supported zones for this servicemethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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, PropertyServerExceptionCreate the property facet for the vendor properties.- Parameters:
userId
- calling userreferenceableGUID
- unique identifier of the software capabilityvendorProperties
- properties for the vendorforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userreferenceableGUID
- unique identifier of the metadata elementreferenceableGUIDParameter
- parameter name for referenceableGUIDforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Returns:
- map of properties
- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-