org.odpi.openmetadata.accessservices.subjectarea.handlers

Class SubjectAreaProjectHandler

java.lang.Object

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

org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaProjectHandler

public class SubjectAreaProjectHandler
extends SubjectAreaHandler

SubjectAreaProjectHandler manages Project objects from the property server. It runs server-side in the subject Area OMAS and retrieves entities and relationships through the OMRSRepositoryConnector.

Field Summary

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

oMRSAPIHelper

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	createProject(String userId, Project suppliedProject) Create a Project.
SubjectAreaOMASAPIResponse	deleteProject(String userId, String guid, Boolean isPurge) Delete a Project instance
SubjectAreaOMASAPIResponse	findProject(String userId, String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Project
SubjectAreaOMASAPIResponse	getProjectByGuid(String userId, String guid) Get a project by guid.
SubjectAreaOMASAPIResponse	getProjectRelationships(String userId, String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Project relationships
SubjectAreaOMASAPIResponse	getProjectTerms(SubjectAreaGraphHandler subjectAreaGraphHandler, String userId, String guid, Date asOfTime) Get the terms in this project.
protected SubjectAreaOMASAPIResponse	getResponse(SubjectAreaOMASAPIResponse response) Take an entityDetail response and map it to the appropriate Project orientated response
SubjectAreaOMASAPIResponse	restoreProject(String userId, String guid) Restore a Project
SubjectAreaOMASAPIResponse	updateProject(String userId, String guid, Project suppliedProject, boolean isReplace) Update a Project

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

SubjectAreaProjectHandler

public SubjectAreaProjectHandler(OMRSAPIHelper oMRSAPIHelper)

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

Parameters:

oMRSAPIHelper - OMRS API helper

Method Detail

getResponse

protected SubjectAreaOMASAPIResponse getResponse(SubjectAreaOMASAPIResponse response)

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.

createProject

public SubjectAreaOMASAPIResponse createProject(String userId,
                                                Project suppliedProject)

Create a Project. There are specializations of projects that can also be created using this operation. To create a specialization, you should specify a nodeType other than Project in the supplied project.

Projects with the same name can be confusing. Best practise is to createProjects that have unique names. This Create call does not police that project names are unique. So it is possible to create Projects with the same name as each other.

Valid nodeTypes for this request are:

• Taxonomy to create a Taxonomy
• CanonicalProject to create a canonical project
• TaxonomyAndCanonicalProject to create a project that is both a taxonomy and a canonical project
• Project to create a project that is not a taxonomy or a canonical project

Parameters:

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

suppliedProject - Project to create

Returns:

response, when successful contains the created project. 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.

getProjectByGuid

public SubjectAreaOMASAPIResponse getProjectByGuid(String userId,
                                                   String guid)

Get a project by guid.

Parameters:

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

guid - guid of the project to get

Returns:

response which when successful contains the project 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

findProject

public SubjectAreaOMASAPIResponse findProject(String userId,
                                              String searchCriteria,
                                              Date asOfTime,
                                              Integer offset,
                                              Integer pageSize,
                                              SequencingOrder sequencingOrder,
                                              String sequencingProperty)

Find Project

Parameters:

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

searchCriteria - String expression matching Project property values. If not specified then all projects are returned.

asOfTime - the projects returned as they were at this time. null indicates at the current time.

offset - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

pageSize - the maximum number of elements that can be returned on this request. 0 means there is no limit to the page size

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

Returns:

A list of Projects meeting the search Criteria

• 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.
• FunctionNotSupportedException Function not supported this indicates that a find was issued but the repository does not implement find functionality in some way.

getProjectRelationships

public SubjectAreaOMASAPIResponse getProjectRelationships(String userId,
                                                          String guid,
                                                          Date asOfTime,
                                                          Integer offset,
                                                          Integer pageSize,
                                                          SequencingOrder sequencingOrder,
                                                          String sequencingProperty)

Get Project relationships

Parameters:

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

guid - guid of the project to get

asOfTime - the relationships returned as they were at this time. null indicates at the current time. If specified, the date is in milliseconds since 1970-01-01 00:00:00.

offset - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

pageSize - the maximum number of elements that can be returned on this request. 0 means there is not limit to the page size

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

Returns:

the relationships associated with the requested Project userId

when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• FunctionNotSupportedException Function not supported.

updateProject

public SubjectAreaOMASAPIResponse updateProject(String userId,
                                                String guid,
                                                Project suppliedProject,
                                                boolean isReplace)

Update a Project

If the caller has chosen to incorporate the project name in their Project Terms or Categories qualified name, renaming the project will cause those qualified names to mismatch the Project name. If the caller has chosen to incorporate the project qualifiedName in their Project Terms or Categories qualified name, changing the qualified name of the project will cause those qualified names to mismatch the Project name. Status is not updated using this call.

Parameters:

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

guid - guid of the project to update

suppliedProject - project to be updated

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

Returns:

a response which when successful contains the updated project 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.

deleteProject

public SubjectAreaOMASAPIResponse deleteProject(String userId,
                                                String guid,
                                                Boolean isPurge)

Delete a Project instance

The deletion of a project is only allowed if there is no project content (i.e. no terms or categories).

There are 2 types of deletion, a soft delete and a hard delete (also known as a purge). All repositories support hard deletes. Soft deletes support is optional. Soft delete is the default.

A soft delete means that the project instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete. A hard delete means that the project will not exist after the operation. when not successful the following Exceptions can occur

Parameters:

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

guid - guid of the project to be deleted.

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

Returns:

a void response 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 project was not deleted.
• EntityNotPurgedException a hard delete was issued but the project was not purged

restoreProject

public SubjectAreaOMASAPIResponse restoreProject(String userId,
                                                 String guid)

Restore a Project

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

Parameters:

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

guid - guid of the project to restore

Returns:

response which when successful contains the restored project 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 this indicates that a soft delete was issued but the repository does not support it.
• 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.

getProjectTerms

public SubjectAreaOMASAPIResponse getProjectTerms(SubjectAreaGraphHandler subjectAreaGraphHandler,
                                                  String userId,
                                                  String guid,
                                                  Date asOfTime)

Get the terms in this project.

Parameters:

subjectAreaGraphHandler - graph handler

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

guid - guid of the Project to get

asOfTime - the relationships returned as they were at this time. null indicates at the current time. If specified, the date is in milliseconds since 1970-01-01 00:00:00.

Returns:

a response which when successful contains the Project terms 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.
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.