Package org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetReviewInterface

All Known Implementing Classes:

AssetOwner, AvroFileAssetOwner, CSVFileAssetOwner, FileSystemAssetOwner, ValidValuesAssetOwner

public interface AssetReviewInterface

The AssetReviewInterface is used by the asset owner to review the state of the asset including any quality and usage metrics associated with the asset.

Method Summary

Modifier and Type	Method	Description
List<AssetElement>	findAssets(String userId, String searchString, int startFrom, int pageSize)	Return a list of assets with the requested search string in their name, qualified name or description.
AssetUniverse	getAssetProperties(String userId, String assetGUID)	Return everything that is known about the asset
RelationshipElement	getAssetRelationship(String userId, String relationshipTypeName, String fromAssetGUID, String toAssetGUID)	Retrieve the relationship between two elements.
List<AssetElement>	getAssetsByName(String userId, String name, int startFrom, int pageSize)	Return a list of assets with the requested name.
List<AssetElement>	getAssetsByOrigin(String userId, FindAssetOriginProperties properties, int startFrom, int pageSize)	Return information about the assets from a specific origin.
AssetElement	getAssetSummary(String userId, String assetGUID)	Return the basic attributes of an asset.
List<ElementStub>	getConfidenceClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize)	Return information about the elements classified with the confidence classification.
List<ElementStub>	getConfidentialityClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize)	Return information about the elements classified with the confidentiality classification.
Connector	getConnectorToAsset(String userId, String assetGUID)	Return a connector for the asset to enable the calling user to access the content.
List<ElementStub>	getCriticalityClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize)	Return information about the elements classified with the criticality classification.
List<ElementStub>	getDataFieldClassifiedElements(String userId, DataFieldQueryProperties properties, int startFrom, int pageSize)	Return information about the elements classified with the DataField classification.
List<RelatedElement>	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.
List<Annotation>	getExtendedAnnotations(String userId, String annotationGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults)	Return any annotations attached to this annotation.
List<GovernanceDefinitionElement>	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.
List<RelatedElement>	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.
List<GlossaryTermElement>	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.
List<ElementStub>	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.
List<ElementStub>	getOwnersElements(String userId, String owner, int startFrom, int pageSize)	Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
List<RelationshipElement>	getRelatedAssetsAtEnd1(String userId, String relationshipTypeName, String toAssetGUID, int startFrom, int pageSize)	Retrieve the relationships linked from a specific element at end 2 of the relationship.
List<RelationshipElement>	getRelatedAssetsAtEnd2(String userId, String relationshipTypeName, String fromAssetGUID, int startFrom, int pageSize)	Retrieve the requested relationships linked from a specific element at end 2.
List<ElementStub>	getRetentionClassifiedElements(String userId, boolean returnSpecificBasisIdentifier, int basisIdentifier, int startFrom, int pageSize)	Return information about the elements classified with the retention classification.
List<ElementStub>	getSecurityTaggedElements(String userId, int startFrom, int pageSize)	Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
List<RelatedElement>	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.
List<RelatedElement>	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.
List<Annotation>	getSurveyReportAnnotations(String userId, String surveyReportGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults)	Return the annotations linked directly to the report.
List<SurveyReport>	getSurveyReports(String userId, String assetGUID, int startingFrom, int maximumResults)	Return the survey reports about the asset.
List<String>	getTypesOfAnnotation(String userId)	Return the annotation subtype names.
Map<String,String>	getTypesOfAnnotationWithDescriptions(String userId)	Return the annotation subtype names mapped to their descriptions.

Method Details

getAssetsByName

List<AssetElement> getAssetsByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return a list of assets with the requested name.

Parameters:

userId - calling user

name - name to search for

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of unique identifiers of assets with matching name.

Throws:

InvalidParameterException - the name is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

findAssets

List<AssetElement> findAssets(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return a list of assets with the requested search string in their name, qualified name or description.

Parameters:

userId - calling user

searchString - string to search for in text

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of assets that match the search string.

Throws:

InvalidParameterException - the searchString is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

getAssetSummary

AssetElement getAssetSummary(String userId,
 String assetGUID)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the basic attributes of an asset.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

Returns:

basic asset properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getAssetProperties

AssetUniverse getAssetProperties(String userId,
 String assetGUID)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return everything that is known about the asset

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

Returns:

asset properties with links to other attached content

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getAssetRelationship

RelationshipElement getAssetRelationship(String userId,
 String relationshipTypeName,
 String fromAssetGUID,
 String toAssetGUID)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the relationship between two elements.

Parameters:

userId - calling user

relationshipTypeName - type name of relationship to create

fromAssetGUID - unique identifier of the asset at end 1 of the relationship

toAssetGUID - unique identifier of the asset at end 2 of the relationship

Returns:

unique identifier and properties of the relationship

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)

getRelatedAssetsAtEnd2

List<RelationshipElement> getRelatedAssetsAtEnd2(String userId,
 String relationshipTypeName,
 String fromAssetGUID,
 int startFrom,
 int pageSize)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the requested relationships linked from a specific element at end 2.

Parameters:

userId - calling user

relationshipTypeName - type name of relationship to delete

fromAssetGUID - unique identifier of the asset at end 1 of the relationship

startFrom - start position for results

pageSize - maximum number of results

Returns:

unique identifier and properties of the relationship

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)

getRelatedAssetsAtEnd1

List<RelationshipElement> getRelatedAssetsAtEnd1(String userId,
 String relationshipTypeName,
 String toAssetGUID,
 int startFrom,
 int pageSize)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the relationships linked from a specific element at end 2 of the relationship.

Parameters:

userId - calling user

relationshipTypeName - type name of relationship to delete

toAssetGUID - unique identifier of the asset at end 2 of the relationship

startFrom - start position for results

pageSize - maximum number of results

Returns:

unique identifier and properties of the relationship

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)

getConnectorToAsset

Connector getConnectorToAsset(String userId,
 String assetGUID)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return a connector for the asset to enable the calling user to access the content.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

Returns:

connector object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getSurveyReports

List<SurveyReport> getSurveyReports(String userId,
 String assetGUID,
 int startingFrom,
 int maximumResults)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the survey reports about the asset.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

startingFrom - position in the list (used when there are so many reports that paging is needed

maximumResults - maximum number of elements to return an this call

Returns:

list of survey reports

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getTypesOfAnnotation

List<String> getTypesOfAnnotation(String userId)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the annotation subtype names.

Parameters:

userId - calling user

Returns:

list of type names that are subtypes of annotation

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getTypesOfAnnotationWithDescriptions

Map<String,String> getTypesOfAnnotationWithDescriptions(String userId)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the annotation subtype names mapped to their descriptions.

Parameters:

userId - calling user

Returns:

map of type names that are subtypes of annotation to their descriptions

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSurveyReportAnnotations

List<Annotation> getSurveyReportAnnotations(String userId,
 String surveyReportGUID,
 AnnotationStatus annotationStatus,
 int startingFrom,
 int maximumResults)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the annotations linked directly to the report.

Parameters:

userId - identifier of calling user

surveyReportGUID - identifier of the survey report.

annotationStatus - status of the desired annotations - null means all statuses.

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

Returns:

list of annotations

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getExtendedAnnotations

List<Annotation> getExtendedAnnotations(String userId,
 String annotationGUID,
 AnnotationStatus annotationStatus,
 int startingFrom,
 int maximumResults)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return any annotations attached to this annotation.

Parameters:

userId - identifier of calling user

annotationGUID - anchor annotation

annotationStatus - status of the desired annotations - null means all statuses.

startingFrom - starting position in the list

maximumResults - maximum number of annotations that can be returned.

Returns:

list of Annotation objects

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getDataFieldClassifiedElements

List<ElementStub> getDataFieldClassifiedElements(String userId,
 DataFieldQueryProperties properties,
 int startFrom,
 int pageSize)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the DataField classification.

Parameters:

userId - calling user

properties - values to match on

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getConfidenceClassifiedElements

List<ElementStub> getConfidenceClassifiedElements(String userId,
 boolean returnSpecificLevel,
 int levelIdentifier,
 int startFrom,
 int pageSize)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the confidence classification.

Parameters:

userId - calling user

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

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCriticalityClassifiedElements

List<ElementStub> getCriticalityClassifiedElements(String userId,
 boolean returnSpecificLevel,
 int levelIdentifier,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the criticality classification.

Parameters:

userId - calling user

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

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getConfidentialityClassifiedElements

List<ElementStub> getConfidentialityClassifiedElements(String userId,
 boolean returnSpecificLevel,
 int levelIdentifier,
 int startFrom,
 int pageSize)
                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the confidentiality classification.

Parameters:

userId - calling user

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

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getRetentionClassifiedElements

List<ElementStub> getRetentionClassifiedElements(String userId,
 boolean returnSpecificBasisIdentifier,
 int basisIdentifier,
 int startFrom,
 int pageSize)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the elements classified with the retention classification.

Parameters:

userId - calling user

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

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSecurityTaggedElements

List<ElementStub> getSecurityTaggedElements(String userId,
 int startFrom,
 int pageSize)
                                     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 user

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getOwnersElements

List<ElementStub> getOwnersElements(String userId,
 String owner,
 int startFrom,
 int pageSize)
                             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 user

owner - unique identifier for the owner - could be role, profile, userId

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of element stubs

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getAssetsByOrigin

List<AssetElement> getAssetsByOrigin(String userId,
 FindAssetOriginProperties properties,
 int startFrom,
 int pageSize)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the assets from a specific origin.

Parameters:

userId - calling user

properties - values to search on - null means any value

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of the assets

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

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 user

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

forLineage - 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 null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

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 user

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

forLineage - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 user

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

forLineage - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 user

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

forLineage - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 user

governanceDefinitionGUID - unique identifier of the governance definition 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

forLineage - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 user

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

forLineage - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 user

elementGUID - unique identifier of the element 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

forLineage - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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