org.odpi.openmetadata.viewservices.glossaryauthor.handlers

Class ProjectHandler

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.handlers.ProjectHandler

public class ProjectHandler
extends Object

The project handler is initialised with a SubjectAreaProject, that contains the server the call should be sent to. The handler exposes methods for project functionality for the glossary author view

Constructor Summary

Constructors

Constructor and Description
ProjectHandler(SubjectAreaProject subjectAreaProject) Constructor for the ProjectHandler

Method Summary

Modifier and Type	Method and Description
Project	createProject(String userId, Project suppliedProject) Create a Project.
void	deleteProject(String userId, String guid) Delete a Project instance
List<Project>	findProject(String userId, FindRequest findRequest) Find Project
Project	getProjectByGuid(String userId, String guid) Get a Project by guid.
List<Line>	getProjectRelationships(String userId, String guid, FindRequest findRequest) Get Project relationships
void	purgeProject(String userId, String guid) Purge a Project instance
Project	replaceProject(String userId, String guid, Project suppliedProject) Replace a Project.
Project	restoreProject(String userId, String guid) Restore a Project
Project	updateProject(String userId, String guid, Project suppliedProject) Update a Project.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectHandler

public ProjectHandler(SubjectAreaProject subjectAreaProject)

Constructor for the ProjectHandler

Parameters:

subjectAreaProject - The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for projects. This is the same as the The SubjectAreaDefinition Open Metadata View Service (OMVS) API for projects.

Method Detail

createProject

public Project createProject(String userId,
                             Project suppliedProject)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Create a Project.

Projects with the same name can be confusing. Best practise is to create projects 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.

Projects that are created using this call will be GlossaryProjects.

Parameters:

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

suppliedProject - Project to create

Returns:

the created Project.

Exceptions returned by the server

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

getProjectByGuid

public Project getProjectByGuid(String userId,
                                String guid)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Get a Project by guid.

Parameters:

userId - userId under which the request is performed

guid - guid of the Project to get

Returns:

the requested Project.

Exceptions returned by the server

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

getProjectRelationships

public List<Line> getProjectRelationships(String userId,
                                          String guid,
                                          FindRequest findRequest)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Get Project relationships

Parameters:

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

guid - guid of the Project to get

findRequest - FindRequest

Returns:

the relationships associated with the requested Project guid

Exceptions returned by the server

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

findProject

public List<Project> findProject(String userId,
                                 FindRequest findRequest)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Find Project

Parameters:

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

findRequest - FindRequest

Returns:

A list of Projects meeting the search Criteria

Exceptions returned by the server

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

replaceProject

public Project replaceProject(String userId,
                              String guid,
                              Project suppliedProject)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Replace a Project. This means to override all the existing attributes with the supplied attributes.

Status is not updated using this call.

Parameters:

userId - userId under which the request is performed

guid - guid of the Project to update

suppliedProject - Project to be updated

Returns:

replaced Project

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

updateProject

public Project updateProject(String userId,
                             String guid,
                             Project suppliedProject)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update a Project. This means to update the Project with any non-null attributes from the supplied Project.

Status is not updated using this call.

Parameters:

userId - userId under which the request is performed

guid - guid of the Project to update

suppliedProject - Project to be updated

Returns:

a response which when successful contains the updated Project when not successful the following Exceptions can occur

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

deleteProject

public void deleteProject(String userId,
                          String guid)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Delete a Project instance

The deletion of a Project is only allowed if there is no Project content

A delete (also known as 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.

Parameters:

userId - userId under which the request is performed

guid - guid of the Project to be deleted.

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

purgeProject

public void purgeProject(String userId,
                         String guid)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Purge a Project instance

The purge of a Project is only allowed if there is no Project content.

A purge means that the Project will not exist after the operation.

Parameters:

userId - userId under which the request is performed

guid - guid of the Project to be deleted.

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - Property Server Exception

restoreProject

public Project restoreProject(String userId,
                              String guid)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

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:

the restored Project

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception