Interface StewardshipManagementInterface
- All Known Implementing Classes:
StewardshipManagementClient
public interface StewardshipManagementInterface
The StewardshipManagementInterface supports the exchange of relationships (such as SemanticAssignment)
and classifications that are added by stewards (or automated stewardship processes) such as Confidentiality.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAssetOrigin
(String userId, String assetGUID, AssetOriginProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Add or replace the origin classification for an asset.void
addElementToSubjectArea
(String userId, String elementGUID, SubjectAreaMemberProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Classify the element to assert that it is part of a subject area definition.void
addGovernanceDefinitionToElement
(String userId, String definitionGUID, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Link a governance definition to an element using the GovernedBy relationship.void
addOwnership
(String userId, String elementGUID, OwnerProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Add or replace the ownership classification for an element.void
addSecurityTags
(String userId, String elementGUID, SecurityTagsProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Add or replace the security tags for an element.void
clearAssetOrigin
(String userId, String assetGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the origin classification from an asset.void
clearConfidenceClassification
(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the confidence classification from the element.void
clearConfidentialityClassification
(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the confidence classification from the element.void
clearCriticalityClassification
(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the criticality classification from the element.void
clearElementAsDataField
(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the data field designation from the element.void
clearOwnership
(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the ownership classification from an element.void
clearRetentionClassification
(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the retention classification from the element.void
clearSecurityTags
(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the security tags classification from an element.void
clearSemanticAssignment
(String userId, String elementGUID, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove a semantic assignment relationship between an element and its glossary term.getAssetsByOrigin
(String userId, FindAssetOriginProperties properties, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the assets from a specific origin.getConfidenceClassifiedElements
(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the elements classified with the confidence classification.getConfidentialityClassifiedElements
(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the elements classified with the confidentiality classification.getCriticalityClassifiedElements
(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the elements classified with the criticality classification.getDataFieldClassifiedElements
(String userId, DataFieldQueryProperties properties, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the elements classified with the DataField classification.getElementsSourceFrom
(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Retrieve the elements linked via a "SourceFrom" relationship to the requested element.getGovernedByDefinitions
(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.getGovernedElements
(String userId, String governanceDefinitionGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.getMeanings
(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.getMembersOfSubjectArea
(String userId, String subjectAreaName, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.getOwnersElements
(String userId, String owner, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.getRetentionClassifiedElements
(String userId, boolean returnSpecificBasisIdentifier, int basisIdentifier, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the elements classified with the retention classification.getSecurityTaggedElements
(String userId, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.getSemanticAssignees
(String userId, String glossaryTermGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.getSourceElements
(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Retrieve the elements linked via a "SourceFrom" relationship to the requested element.void
removeElementFromSubjectArea
(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the subject area designation from the identified element.void
removeGovernanceDefinitionFromElement
(String userId, String definitionGUID, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Remove the GovernedBy relationship between a governance definition and an element.void
setConfidenceClassification
(String userId, String elementGUID, GovernanceClassificationProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Classify/reclassify the element (typically an asset) to indicate the level of confidence that the organization has that the data is complete, accurate and up-to-date.void
setConfidentialityClassification
(String userId, String elementGUID, GovernanceClassificationProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Classify/reclassify the element (typically a data field, schema attribute or glossary term) to indicate the level of confidentiality that any data associated with the element should be given.void
setCriticalityClassification
(String userId, String elementGUID, GovernanceClassificationProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization.void
setElementAsDataField
(String userId, String elementGUID, DataFieldValuesProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Classify the element to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.void
setRetentionClassification
(String userId, String elementGUID, RetentionClassificationProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Classify/reclassify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization.void
setupSemanticAssignment
(String userId, String elementGUID, String glossaryTermGUID, SemanticAssignmentProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset).
-
Method Details
-
setElementAsDataField
void setElementAsDataField(String userId, String elementGUID, DataFieldValuesProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify the element to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to updateproperties
- descriptive properties for the data fieldeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
clearElementAsDataField
void clearElementAsDataField(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the data field designation from the element.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to updateeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getDataFieldClassifiedElements
List<ElementStub> getDataFieldClassifiedElements(String userId, DataFieldQueryProperties properties, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the elements classified with the DataField classification.- Parameters:
userId
- calling userproperties
- values to match onstartFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of element stubs
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
setConfidenceClassification
void setConfidenceClassification(String userId, String elementGUID, GovernanceClassificationProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify/reclassify the element (typically an asset) to indicate the level of confidence that the organization has that the data is complete, accurate and up-to-date. The level of confidence is expressed by the levelIdentifier property.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to classifyproperties
- details of the classificationeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
clearConfidenceClassification
void clearConfidenceClassification(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidence to assign to the element.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to unclassifyeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getConfidenceClassifiedElements
List<ElementStub> getConfidenceClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the elements classified with the confidence classification.- Parameters:
userId
- calling userreturnSpecificLevel
- should the results be filtered by levelIdentifier?levelIdentifier
- the identifier to filter by (if returnSpecificLevel=true)startFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of element stubs
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
setCriticalityClassification
void setCriticalityClassification(String userId, String elementGUID, GovernanceClassificationProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization. The level of criticality is expressed by the levelIdentifier property.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to classifyproperties
- details of the classificationeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
clearCriticalityClassification
void clearCriticalityClassification(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the criticality classification from the element. This normally occurs when the organization has lost track of the level of criticality to assign to the element.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to unclassifyeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getCriticalityClassifiedElements
List<ElementStub> getCriticalityClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the elements classified with the criticality classification.- Parameters:
userId
- calling userreturnSpecificLevel
- should the results be filtered by levelIdentifier?levelIdentifier
- the identifier to filter by (if returnSpecificLevel=true)startFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of element stubs
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
setConfidentialityClassification
void setConfidentialityClassification(String userId, String elementGUID, GovernanceClassificationProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify/reclassify the element (typically a data field, schema attribute or glossary term) to indicate the level of confidentiality that any data associated with the element should be given. If the classification is attached to a glossary term, the level of confidentiality is a suggestion for any element linked to the glossary term via the SemanticAssignment classification. The level of confidence is expressed by the levelIdentifier property.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to classifyproperties
- details of the classificationeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
clearConfidentialityClassification
void clearConfidentialityClassification(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidentiality to assign to the element.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to unclassifyeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getConfidentialityClassifiedElements
List<ElementStub> getConfidentialityClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the elements classified with the confidentiality classification.- Parameters:
userId
- calling userreturnSpecificLevel
- should the results be filtered by levelIdentifier?levelIdentifier
- the identifier to filter by (if returnSpecificLevel=true)startFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of element stubs
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
setRetentionClassification
void setRetentionClassification(String userId, String elementGUID, RetentionClassificationProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify/reclassify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization. The policy to apply to the element/resource is captured by the retentionBasis property. The dates after which the element/resource is archived and then deleted are specified in the archiveAfter and deleteAfter properties respectively.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to classifyproperties
- details of the classificationeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
clearRetentionClassification
void clearRetentionClassification(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the retention classification from the element. This normally occurs when the organization has lost track of, or no longer needs to track the retention period to assign to the element.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to unclassifyeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getRetentionClassifiedElements
List<ElementStub> getRetentionClassifiedElements(String userId, boolean returnSpecificBasisIdentifier, int basisIdentifier, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the elements classified with the retention classification.- Parameters:
userId
- calling userreturnSpecificBasisIdentifier
- should the results be filtered by basisIdentifier?basisIdentifier
- the identifier to filter by (if returnSpecificBasisIdentifier=true)startFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of element stubs
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addSecurityTags
void addSecurityTags(String userId, String elementGUID, SecurityTagsProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Add or replace the security tags for an element.- Parameters:
userId
- calling userelementGUID
- element to link it to - its type must inherit from Referenceable.properties
- details of the security tagseffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Throws:
InvalidParameterException
- element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
clearSecurityTags
void clearSecurityTags(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the security tags classification from an element.- Parameters:
userId
- calling userelementGUID
- element where the security tags need to be removed.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getSecurityTaggedElements
List<ElementStub> getSecurityTaggedElements(String userId, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.- Parameters:
userId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of element stubs
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addOwnership
void addOwnership(String userId, String elementGUID, OwnerProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Add or replace the ownership classification for an element.- Parameters:
userId
- calling userelementGUID
- element to link it to - its type must inherit from Referenceable.properties
- details of the ownershipeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Throws:
InvalidParameterException
- element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
clearOwnership
void clearOwnership(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the ownership classification from an element.- Parameters:
userId
- calling userelementGUID
- element where the classification needs to be removed.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getOwnersElements
List<ElementStub> getOwnersElements(String userId, String owner, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.- Parameters:
userId
- calling userowner
- unique identifier for the ownerstartFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of element stubs
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addAssetOrigin
void addAssetOrigin(String userId, String assetGUID, AssetOriginProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Add or replace the origin classification for an asset.- Parameters:
userId
- calling userassetGUID
- element to link it to - its type must inherit from Asset.properties
- details of the origineffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Throws:
InvalidParameterException
- element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
clearAssetOrigin
void clearAssetOrigin(String userId, String assetGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the origin classification from an asset.- Parameters:
userId
- calling userassetGUID
- element where the classification needs to be removed.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getAssetsByOrigin
List<AssetElement> getAssetsByOrigin(String userId, FindAssetOriginProperties properties, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the assets from a specific origin.- Parameters:
userId
- calling userproperties
- values to search on - null means any valuestartFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of the assets
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addElementToSubjectArea
void addElementToSubjectArea(String userId, String elementGUID, SubjectAreaMemberProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify the element to assert that it is part of a subject area definition.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to updateproperties
- qualified name of subject areaeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
removeElementFromSubjectArea
void removeElementFromSubjectArea(String userId, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the subject area designation from the identified element.- Parameters:
userId
- calling userelementGUID
- unique identifier of the metadata element to updateeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getMembersOfSubjectArea
List<ElementStub> getMembersOfSubjectArea(String userId, String subjectAreaName, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.- Parameters:
userId
- calling usersubjectAreaName
- unique identifier for the subject areastartFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of element stubs
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
setupSemanticAssignment
void setupSemanticAssignment(String userId, String elementGUID, String glossaryTermGUID, SemanticAssignmentProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset). This relationship indicates that the data associated with the element meaning matches the description in the glossary term.- Parameters:
userId
- calling userelementGUID
- unique identifier of the element that is being assigned to the glossary termglossaryTermGUID
- unique identifier of the glossary term that provides the meaningproperties
- properties for relationshipeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
clearSemanticAssignment
void clearSemanticAssignment(String userId, String elementGUID, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove a semantic assignment relationship between an element and its glossary term.- Parameters:
userId
- calling userelementGUID
- unique identifier of the element that is being assigned to the glossary termglossaryTermGUID
- unique identifier of the glossary term that provides the meaningeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getMeanings
List<GlossaryTermElement> getMeanings(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.- Parameters:
userId
- calling userelementGUID
- unique identifier of the elementstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of related elements
- 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)
-
getSemanticAssignees
List<RelatedElement> getSemanticAssignees(String userId, String glossaryTermGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.- Parameters:
userId
- calling userglossaryTermGUID
- unique identifier of the glossary term that the returned elements are linked tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of related elements
- 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)
-
addGovernanceDefinitionToElement
void addGovernanceDefinitionToElement(String userId, String definitionGUID, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Link a governance definition to an element using the GovernedBy relationship.- Parameters:
userId
- calling userdefinitionGUID
- identifier of the governance definition to linkelementGUID
- unique identifier of the metadata element to linkeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
removeGovernanceDefinitionFromElement
void removeGovernanceDefinitionFromElement(String userId, String definitionGUID, String elementGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the GovernedBy relationship between a governance definition and an element.- Parameters:
userId
- calling userdefinitionGUID
- identifier of the governance definition to linkelementGUID
- unique identifier of the metadata element to updateeffectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getGovernedByDefinitions
List<GovernanceDefinitionElement> getGovernedByDefinitions(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.- Parameters:
userId
- calling userelementGUID
- unique identifier of the elementstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of related elements
- 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
List<RelatedElement> getGovernedElements(String userId, String governanceDefinitionGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.- Parameters:
userId
- calling usergovernanceDefinitionGUID
- unique identifier of the governance definition that the returned elements are linked tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of related elements
- 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)
-
getSourceElements
List<RelatedElement> getSourceElements(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException 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
- calling userelementGUID
- unique identifier of the elementstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of related elements
- 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)
-
getElementsSourceFrom
List<RelatedElement> getElementsSourceFrom(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException 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
- calling userelementGUID
- unique identifier of the element that the returned elements are linked tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.effectiveTime
- the time that the retrieved elements must be effective forforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of related elements
- 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)
-