Package org.odpi.openmetadata.integrationservices.catalog.connector

Class StewardshipExchangeService

java.lang.Object

org.odpi.openmetadata.integrationservices.catalog.connector.StewardshipExchangeService

public class StewardshipExchangeService
extends Object

StewardshipExchangeService is the context for managing classifications and exceptions and other actions of stewards.

Method Summary

Modifier and Type	Method	Description
void	addAssetOrigin(String assetGUID, String externalIdentifier, AssetOriginProperties properties, Date effectiveTime)	Add or replace the origin classification for an asset.
void	addElementToSubjectArea(String elementGUID, String externalIdentifier, SubjectAreaClassificationProperties properties, Date effectiveTime)	Classify the element to assert that the definitions it represents are part of a subject area definition.
void	addGovernanceDefinitionToElement(String definitionGUID, String elementGUID, Date effectiveTime)	Link a governance definition to an element using the GovernedBy relationship.
void	addOwnership(String elementGUID, String externalIdentifier, OwnerProperties properties, Date effectiveTime)	Add or replace the ownership classification for an element.
void	addSecurityTags(String elementGUID, String externalIdentifier, SecurityTagsProperties properties, Date effectiveTime)	Add or replace the security tags for an element.
void	clearAssetOrigin(String assetGUID, String externalIdentifier, Date effectiveTime)	Remove the origin classification from an asset.
void	clearConfidenceClassification(String elementGUID, String externalIdentifier, Date effectiveTime)	Remove the confidence classification from the element.
void	clearConfidentialityClassification(String elementGUID, String externalIdentifier, Date effectiveTime)	Remove the confidence classification from the element.
void	clearCriticalityClassification(String elementGUID, String externalIdentifier, Date effectiveTime)	Remove the criticality classification from the element.
void	clearOwnership(String elementGUID, String externalIdentifier, Date effectiveTime)	Remove the ownership classification from an element.
void	clearRetentionClassification(String elementGUID, String externalIdentifier, Date effectiveTime)	Remove the retention classification from the element.
void	clearSecurityTags(String elementGUID, String externalIdentifier, Date effectiveTime)	Remove the security tags classification from an element.
void	clearSemanticAssignment(String elementGUID, String glossaryTermGUID, Date effectiveTime)	Remove a semantic assignment relationship between an element and its glossary term.
List<MetadataElementSummary>	findElementsByPropertyValue(FindPropertyNamesProperties findProperties, int startFrom, int pageSize)	Retrieve elements by a value found in one of the properties specified.
List<AssetElement>	getAssetsByOrigin(FindAssetOriginProperties properties, int startFrom, int pageSize, Date effectiveTime)	Return information about the assets from a specific origin.
List<MetadataElementSummary>	getConfidenceClassifiedElements(boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime)	Return information about the elements classified with the confidence classification.
List<MetadataElementSummary>	getConfidentialityClassifiedElements(boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime)	Return information about the elements classified with the confidentiality classification.
List<MetadataElementSummary>	getCriticalityClassifiedElements(boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize, Date effectiveTime)	Return information about the elements classified with the criticality classification.
List<MetadataElementSummary>	getElements(FindProperties findProperties, int startFrom, int pageSize)	Retrieve elements of the requested type name.
List<MetadataElementSummary>	getElementsByPropertyValue(FindPropertyNamesProperties findProperties, int startFrom, int pageSize)	Retrieve elements by a value found in one of the properties specified.
List<RelatedMetadataElementSummary>	getElementsSourceFrom(String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Retrieve the elements linked via a "SourceFrom" relationship to the requested element.
List<GovernanceDefinitionElement>	getGovernedByDefinitions(String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
List<RelatedMetadataElementSummary>	getGovernedElements(String governanceDefinitionGUID, int startFrom, int pageSize, Date effectiveTime)	Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
List<GlossaryTermElement>	getMeanings(String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
List<MetadataElementSummary>	getMembersOfSubjectArea(String subjectAreaName, int startFrom, int pageSize, Date effectiveTime)	Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
List<MetadataElementSummary>	getOwnersElements(String owner, int startFrom, int pageSize, Date effectiveTime)	Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
List<MetadataElementSummary>	getRetentionClassifiedElements(boolean returnSpecificBasisIdentifier, int basisIdentifier, int startFrom, int pageSize, Date effectiveTime)	Return information about the elements classified with the retention classification.
List<MetadataElementSummary>	getSecurityTaggedElements(int startFrom, int pageSize, Date effectiveTime)	Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
List<RelatedMetadataElementSummary>	getSemanticAssignees(String glossaryTermGUID, int startFrom, int pageSize, Date effectiveTime)	Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.
List<RelatedMetadataElementSummary>	getSourceElements(String elementGUID, int startFrom, int pageSize, Date effectiveTime)	Retrieve the elements linked via a "SourceFrom" relationship to the requested element.
boolean	isForDuplicateProcessing()	Return whether retrieval requests from this service are to avoid merging duplicates or not.
boolean	isForLineage()	Return whether retrieval requests from this service are to include elements with the Memento classification attached or not.
void	removeElementFromSubjectArea(String elementGUID, String externalIdentifier, Date effectiveTime)	Remove the subject area designation from the identified element.
void	removeGovernanceDefinitionFromElement(String definitionGUID, String elementGUID, Date effectiveTime)	Remove the GovernedBy relationship between a governance definition and an element.
void	setConfidenceClassification(String elementGUID, String externalIdentifier, GovernanceClassificationProperties properties, Date effectiveTime)	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 elementGUID, String externalIdentifier, GovernanceClassificationProperties properties, Date effectiveTime)	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 elementGUID, GovernanceClassificationProperties properties, String externalIdentifier, Date effectiveTime)	Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization.
void	setForDuplicateProcessing(boolean forDuplicateProcessing)	Set up whether retrieval requests from this service are to avoid merging duplicates or not.
void	setForLineage(boolean forLineage)	Set up whether retrieval requests from this service are to include elements with the Memento classification attached or not.
void	setRetentionClassification(String elementGUID, String externalIdentifier, RetentionClassificationProperties properties, Date effectiveTime)	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 elementGUID, String glossaryTermGUID, SemanticAssignmentProperties properties, Date effectiveTime)	Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset).

Methods inherited from class java.lang.Object

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

Method Details

isForLineage

public boolean isForLineage()

Return whether retrieval requests from this service are to include elements with the Memento classification attached or not.

Returns:

boolean flag

setForLineage

public void setForLineage(boolean forLineage)

Set up whether retrieval requests from this service are to include elements with the Memento classification attached or not.

Parameters:

forLineage - boolean flag

isForDuplicateProcessing

public boolean isForDuplicateProcessing()

Return whether retrieval requests from this service are to avoid merging duplicates or not.

Returns:

boolean flag

setForDuplicateProcessing

public void setForDuplicateProcessing(boolean forDuplicateProcessing)

Set up whether retrieval requests from this service are to avoid merging duplicates or not.

Parameters:

forDuplicateProcessing - boolean flag

setConfidenceClassification

public void setConfidenceClassification(String elementGUID,
 String externalIdentifier,
 GovernanceClassificationProperties properties,
 Date effectiveTime)
                                 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:

elementGUID - unique identifier of the metadata element to classify

externalIdentifier - unique identifier of the element in the external asset manager

properties - details of the classification

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearConfidenceClassification

public void clearConfidenceClassification(String elementGUID,
 String externalIdentifier,
 Date effectiveTime)
                                   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:

elementGUID - unique identifier of the metadata element to unclassify

externalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getConfidenceClassifiedElements

public List<MetadataElementSummary> getConfidenceClassifiedElements(boolean returnSpecificLevel,
 int levelIdentifier,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the confidence classification.

Parameters:

returnSpecificLevel - should the results be filtered by levelIdentifier?

levelIdentifier - the identifier to filter by (if returnSpecificLevel=true)

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setCriticalityClassification

public void setCriticalityClassification(String elementGUID,
 GovernanceClassificationProperties properties,
 String externalIdentifier,
 Date effectiveTime)
                                  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:

elementGUID - unique identifier of the metadata element to classify

externalIdentifier - unique identifier of the element in the external asset manager

properties - details of the classification

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearCriticalityClassification

public void clearCriticalityClassification(String elementGUID,
 String externalIdentifier,
 Date effectiveTime)
                                    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:

elementGUID - unique identifier of the metadata element to unclassify

externalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getCriticalityClassifiedElements

public List<MetadataElementSummary> getCriticalityClassifiedElements(boolean returnSpecificLevel,
 int levelIdentifier,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the criticality classification.

Parameters:

returnSpecificLevel - should the results be filtered by levelIdentifier?

levelIdentifier - the identifier to filter by (if returnSpecificLevel=true)

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setConfidentialityClassification

public void setConfidentialityClassification(String elementGUID,
 String externalIdentifier,
 GovernanceClassificationProperties properties,
 Date effectiveTime)
                                      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:

elementGUID - unique identifier of the metadata element to classify

externalIdentifier - unique identifier of the element in the external asset manager

properties - details of the classification

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearConfidentialityClassification

public void clearConfidentialityClassification(String elementGUID,
 String externalIdentifier,
 Date effectiveTime)
                                        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:

elementGUID - unique identifier of the metadata element to unclassify

externalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getConfidentialityClassifiedElements

public List<MetadataElementSummary> getConfidentialityClassifiedElements(boolean returnSpecificLevel,
 int levelIdentifier,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the confidentiality classification.

Parameters:

returnSpecificLevel - should the results be filtered by levelIdentifier?

levelIdentifier - the identifier to filter by (if returnSpecificLevel=true)

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setRetentionClassification

public void setRetentionClassification(String elementGUID,
 String externalIdentifier,
 RetentionClassificationProperties properties,
 Date effectiveTime)
                                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:

elementGUID - unique identifier of the metadata element to classify

externalIdentifier - unique identifier of the element in the external asset manager

properties - details of the classification

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearRetentionClassification

public void clearRetentionClassification(String elementGUID,
 String externalIdentifier,
 Date effectiveTime)
                                  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:

elementGUID - unique identifier of the metadata element to unclassify

externalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getRetentionClassifiedElements

public List<MetadataElementSummary> getRetentionClassifiedElements(boolean returnSpecificBasisIdentifier,
 int basisIdentifier,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the retention classification.

Parameters:

returnSpecificBasisIdentifier - should the results be filtered by basisIdentifier?

basisIdentifier - the identifier to filter by (if returnSpecificBasisIdentifier=true)

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSecurityTags

public void addSecurityTags(String elementGUID,
 String externalIdentifier,
 SecurityTagsProperties properties,
 Date effectiveTime)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add or replace the security tags for an element.

Parameters:

elementGUID - element to link it to - its type must inherit from Referenceable.

externalIdentifier - unique identifier of the element in the external asset manager

properties - details of the security tags

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

clearSecurityTags

public void clearSecurityTags(String elementGUID,
 String externalIdentifier,
 Date effectiveTime)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the security tags classification from an element.

Parameters:

elementGUID - element where the security tags need to be removed.

externalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSecurityTaggedElements

public List<MetadataElementSummary> getSecurityTaggedElements(int startFrom,
 int pageSize,
 Date effectiveTime)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.

Parameters:

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addOwnership

public void addOwnership(String elementGUID,
 String externalIdentifier,
 OwnerProperties properties,
 Date effectiveTime)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add or replace the ownership classification for an element.

Parameters:

elementGUID - element to link it to - its type must inherit from Referenceable.

externalIdentifier - unique identifier of the element in the external asset manager

properties - details of the ownership

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

clearOwnership

public void clearOwnership(String elementGUID,
 String externalIdentifier,
 Date effectiveTime)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the ownership classification from an element.

Parameters:

elementGUID - element where the classification needs to be removed.

externalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getOwnersElements

public List<MetadataElementSummary> getOwnersElements(String owner,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.

Parameters:

owner - unique identifier for the owner

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addAssetOrigin

public void addAssetOrigin(String assetGUID,
 String externalIdentifier,
 AssetOriginProperties properties,
 Date effectiveTime)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add or replace the origin classification for an asset.

Parameters:

assetGUID - element to link it to - its type must inherit from Asset.

externalIdentifier - unique identifier of the element in the external asset manager

properties - details of the origin

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

clearAssetOrigin

public void clearAssetOrigin(String assetGUID,
 String externalIdentifier,
 Date effectiveTime)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the origin classification from an asset.

Parameters:

assetGUID - element where the classification needs to be removed

externalIdentifier - optional matching identifier from an external system

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getAssetsByOrigin

public List<AssetElement> getAssetsByOrigin(FindAssetOriginProperties properties,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the assets from a specific origin.

Parameters:

properties - values to search on - null means any value

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

Returns:

list of the assets

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addElementToSubjectArea

public void addElementToSubjectArea(String elementGUID,
 String externalIdentifier,
 SubjectAreaClassificationProperties properties,
 Date effectiveTime)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Classify the element to assert that the definitions it represents are part of a subject area definition.

Parameters:

elementGUID - unique identifier of the metadata element to update

externalIdentifier - unique identifier of the element in the external asset manager

properties - qualified name of subject area

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeElementFromSubjectArea

public void removeElementFromSubjectArea(String elementGUID,
 String externalIdentifier,
 Date effectiveTime)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the subject area designation from the identified element.

Parameters:

elementGUID - unique identifier of the metadata element to update

externalIdentifier - unique identifier of the equivalent element in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getMembersOfSubjectArea

public List<MetadataElementSummary> getMembersOfSubjectArea(String subjectAreaName,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.

Parameters:

subjectAreaName - unique identifier for the subject area

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setupSemanticAssignment

public void setupSemanticAssignment(String elementGUID,
 String glossaryTermGUID,
 SemanticAssignmentProperties properties,
 Date effectiveTime)
                             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:

elementGUID - unique identifier of the element that is being assigned to the glossary term

glossaryTermGUID - unique identifier of the glossary term that provides the meaning

properties - properties for the relationship

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearSemanticAssignment

public void clearSemanticAssignment(String elementGUID,
 String glossaryTermGUID,
 Date effectiveTime)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a semantic assignment relationship between an element and its glossary term.

Parameters:

elementGUID - unique identifier of the element that is being assigned to the glossary term

glossaryTermGUID - unique identifier of the glossary term that provides the meaning

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getMeanings

public List<GlossaryTermElement> getMeanings(String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.

Parameters:

elementGUID - unique identifier of the element

startFrom - 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 for

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSemanticAssignees

public List<RelatedMetadataElementSummary> getSemanticAssignees(String glossaryTermGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.

Parameters:

glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to

startFrom - 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 for

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

addGovernanceDefinitionToElement

public void addGovernanceDefinitionToElement(String definitionGUID,
 String elementGUID,
 Date effectiveTime)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link a governance definition to an element using the GovernedBy relationship.

Parameters:

definitionGUID - identifier of the governance definition to link

elementGUID - unique identifier of the metadata element to link

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGovernanceDefinitionFromElement

public void removeGovernanceDefinitionFromElement(String definitionGUID,
 String elementGUID,
 Date effectiveTime)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the GovernedBy relationship between a governance definition and an element.

Parameters:

definitionGUID - identifier of the governance definition to link

elementGUID - unique identifier of the metadata element to update

effectiveTime - the time that the retrieved elements must be effective for

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernedByDefinitions

public List<GovernanceDefinitionElement> getGovernedByDefinitions(String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.

Parameters:

elementGUID - unique identifier of the element

startFrom - 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 for

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernedElements

public List<RelatedMetadataElementSummary> getGovernedElements(String governanceDefinitionGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.

Parameters:

governanceDefinitionGUID - unique identifier of the glossary term that the returned elements are linked to

startFrom - 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 for

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSourceElements

public List<RelatedMetadataElementSummary> getSourceElements(String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                      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:

elementGUID - unique identifier of the glossary term that the returned elements are linked to

startFrom - 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 for

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getElementsSourceFrom

public List<RelatedMetadataElementSummary> getElementsSourceFrom(String elementGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                          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:

elementGUID - unique identifier of the glossary term that the returned elements are linked to

startFrom - 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 for

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getElements

public List<MetadataElementSummary> getElements(FindProperties findProperties,
 int startFrom,
 int pageSize)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve elements of the requested type name.

Parameters:

findProperties - open metadata type to search on

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getElementsByPropertyValue

public List<MetadataElementSummary> getElementsByPropertyValue(FindPropertyNamesProperties findProperties,
 int startFrom,
 int pageSize)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve elements by a value found in one of the properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the results.

Parameters:

findProperties - properties and optional open metadata type to search on

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findElementsByPropertyValue

public List<MetadataElementSummary> findElementsByPropertyValue(FindPropertyNamesProperties findProperties,
 int startFrom,
 int pageSize)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve elements by a value found in one of the properties specified. The value must be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.

Parameters:

findProperties - properties and optional open metadata type to search on

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)