org.odpi.openmetadata.accessservices.subjectarea.handlers

Class SubjectAreaRelationshipHandler

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler

org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaRelationshipHandler

public class SubjectAreaRelationshipHandler
extends SubjectAreaHandler

TheSubjectAreaTermRESTServices provides the server-side implementation of the SubjectArea Open Metadata Access Service (OMAS) for Terms. This interface provides relationship authoring interfaces for subject area experts.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler

oMRSAPIHelper

Constructor Summary

Constructors

Constructor and Description
SubjectAreaRelationshipHandler(OMRSAPIHelper oMRSAPIHelper) Construct the Subject Area Relationship Handler needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	createLine(String restAPIName, String userId, String className, Line line) Create a Line (relationship), which is a link between two Nodes.
SubjectAreaOMASAPIResponse	deleteLine(String restAPIName, String userId, String className, String guid, Boolean isPurge) Delete a Line (relationship)
SubjectAreaOMASAPIResponse	getLine(String restAPIName, String userId, String className, String guid) Get a Line (relationship)
protected SubjectAreaOMASAPIResponse	getResponse(SubjectAreaOMASAPIResponse response) Take an entityDetail response and map it to the appropriate Project orientated response
SubjectAreaOMASAPIResponse	restoreLine(String restAPIName, String userId, String className, String guid) Restore a Line (relationship).
SubjectAreaOMASAPIResponse	updateLine(String restAPIName, String userId, String guid, String className, Line line, boolean isReplace) Update a relationship.

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler

getRelationshipsFromGuid, validateGlossarySummaryDuringCreation

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaRelationshipHandler

public SubjectAreaRelationshipHandler(OMRSAPIHelper oMRSAPIHelper)

Construct the Subject Area Relationship Handler needed to operate within a single server instance.

Parameters:

oMRSAPIHelper - omrs API helper

Method Detail

getResponse

protected SubjectAreaOMASAPIResponse getResponse(SubjectAreaOMASAPIResponse response)

Description copied from class: SubjectAreaHandler

Take an entityDetail response and map it to the appropriate Project orientated response

Specified by:

getResponse in class SubjectAreaHandler

Parameters:

response - entityDetailResponse

Returns:

Project response containing the appropriate Project object.

createLine

public SubjectAreaOMASAPIResponse createLine(String restAPIName,
                                             String userId,
                                             String className,
                                             Line line)

Create a Line (relationship), which is a link between two Nodes.

Parameters:

restAPIName - rest API name

userId - userId under which the request is performed

className - class name

line - line to create

Returns:

response, when successful contains the created line when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised
• ClassificationException Error processing a classification.
• StatusNotSupportedException A status value is not supported.
• FunctionNotSupportedException Function is not supported.

getLine

public SubjectAreaOMASAPIResponse getLine(String restAPIName,
                                          String userId,
                                          String className,
                                          String guid)

Get a Line (relationship)

Parameters:

restAPIName - rest API name

userId - unique identifier for requesting user, under which the request is performed

className - class name

guid - guid of the relationship to get

Returns:

response which when successful contains the relationship with the requested guid when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised

updateLine

public SubjectAreaOMASAPIResponse updateLine(String restAPIName,
                                             String userId,
                                             String guid,
                                             String className,
                                             Line line,
                                             boolean isReplace)

Update a relationship.

Parameters:

restAPIName - rest API name

userId - userId under which the request is performed

guid - unique identifier of the Line

className - class name

line - the relationship to update

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the updated Line when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised
• ClassificationException Error processing a classification.
• StatusNotSupportedException A status value is not supported.
• FunctionNotSupportedException Function not supported.

deleteLine

public SubjectAreaOMASAPIResponse deleteLine(String restAPIName,
                                             String userId,
                                             String className,
                                             String guid,
                                             Boolean isPurge)

Delete a Line (relationship)

Parameters:

restAPIName - rest API name

userId - unique identifier for requesting user, under which the request is performed

className - class name

guid - guid of the HAS A relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete, the response contains the deleted relationship when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported.
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
• EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
• EntityNotPurgedException a hard delete was issued but the relationship was not purged

restoreLine

public SubjectAreaOMASAPIResponse restoreLine(String restAPIName,
                                              String userId,
                                              String className,
                                              String guid)

Restore a Line (relationship).

Restore allows the deleted relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

Parameters:

restAPIName - rest API name

userId - unique identifier for requesting user, under which the request is performed

className - class name

guid - guid of the relationship to restore

Returns:

response which when successful contains the restored relationship when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported.
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
• EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
• EntityNotPurgedException a hard delete was issued but the relationship was not purged