org.odpi.openmetadata.accessservices.subjectarea.client

Class SubjectAreaProjectImpl

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaProjectImpl

All Implemented Interfaces:

SubjectAreaProject

public class SubjectAreaProjectImpl
extends SubjectAreaBaseImpl
implements SubjectAreaProject

SubjectAreaImpl is the OMAS client library implementation of the SubjectAreaImpl OMAS. This interface provides project authoring interface for subject area experts.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

omasServerURL, serverName

Constructor Summary

Constructors

Constructor and Description
SubjectAreaProjectImpl(String omasServerURL, String serverName) Default Constructor used once a connector is created.

Method Summary

Modifier and Type	Method and Description
Project	createProject(String userId, Project suppliedProject) Create a Project.
Project	deleteProject(String userId, String guid) Delete a Project instance The deletion of a project is only allowed if there is no project content (i.e.
List<Project>	findProject(String userId, String searchCriteria, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Project
Project	getProjectByGuid(String userId, String guid) Get a project by guid.
List<Line>	getProjectRelationships(String userId, String guid, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Project relationships
List<Term>	getProjectTerms(String userId, String guid, Date asOfTime) Get the terms in this project.
void	purgeProject(String userId, String guid) Purge a Project instance The purge of a project is only allowed if there is no project content (i.e.
Project	replaceProject(String userId, String guid, Project suppliedProject) Replace a Project.
Project	restoreProject(String userId, String guid) Restore a Project Restore allows the deleted Project to be made active again.
Project	updateProject(String userId, String guid, Project suppliedProject) Update a Project.

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

encodeQueryProperty, getRelationships

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaProjectImpl

public SubjectAreaProjectImpl(String omasServerURL,
                              String serverName)

Default Constructor used once a connector is created.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

omasServerURL - unique id for the connector instance

Method Detail

createProject

public Project createProject(String userId,
                             Project suppliedProject)
                      throws MetadataServerUncontactableException,
                             InvalidParameterException,
                             UserNotAuthorizedException,
                             UnrecognizedGUIDException,
                             ClassificationException,
                             FunctionNotSupportedException,
                             UnexpectedResponseException

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.

Specified by:

createProject in interface SubjectAreaProject

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.

UnrecognizedGUIDException - the supplied guid was not recognised

ClassificationException - Error processing a classification

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getProjectByGuid

public Project getProjectByGuid(String userId,
                                String guid)
                         throws MetadataServerUncontactableException,
                                UnrecognizedGUIDException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                FunctionNotSupportedException,
                                UnexpectedResponseException

Get a project by guid.

Specified by:

getProjectByGuid in interface SubjectAreaProject

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.

UnrecognizedGUIDException - the supplied guid was not recognised

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getProjectRelationships

public List<Line> getProjectRelationships(String userId,
                                          String guid,
                                          Date asOfTime,
                                          int offset,
                                          int pageSize,
                                          SequencingOrder sequencingOrder,
                                          String sequencingProperty)
                                   throws UserNotAuthorizedException,
                                          InvalidParameterException,
                                          FunctionNotSupportedException,
                                          UnexpectedResponseException,
                                          MetadataServerUncontactableException

Get Project relationships

Specified by:

getProjectRelationships in interface SubjectAreaProject

Parameters:

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

guid - guid of the project to get

guid - guid of the project to get

asOfTime - the relationships 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 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 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.

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getProjectTerms

public List<Term> getProjectTerms(String userId,
                                  String guid,
                                  Date asOfTime)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  FunctionNotSupportedException,
                                  UnexpectedResponseException,
                                  MetadataServerUncontactableException

Get the terms in this project.

Specified by:

getProjectTerms in interface SubjectAreaProject

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.

Returns:

the terms that are in 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.

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

findProject

public List<Project> findProject(String userId,
                                 String searchCriteria,
                                 Date asOfTime,
                                 int offset,
                                 int pageSize,
                                 SequencingOrder sequencingOrder,
                                 String sequencingProperty)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 FunctionNotSupportedException,
                                 UnexpectedResponseException

Find Project

Specified by:

findProject in interface SubjectAreaProject

Parameters:

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

searchCriteria - String expression matching Project properties. 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 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.

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

replaceProject

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

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

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.

Specified by:

replaceProject in interface SubjectAreaProject

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. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

updateProject

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

Update a Project. This means to update the project with any non-null attributes from the supplied 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.

Specified by:

updateProject in interface SubjectAreaProject

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. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

deleteProject

public Project deleteProject(String userId,
                             String guid)
                      throws InvalidParameterException,
                             MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             UnrecognizedGUIDException,
                             FunctionNotSupportedException,
                             UnexpectedResponseException,
                             EntityNotDeletedException

Delete a Project instance The deletion of a project is only allowed if there is no project content (i.e. no terms or categories). 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.

Specified by:

deleteProject in interface SubjectAreaProject

Parameters:

userId - userId under which the request is performed

guid - guid of the project to be deleted.

Returns:

the deleted project

Throws:

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.

EntityNotDeletedException - a delete was issued but the project was not deleted. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

purgeProject

public void purgeProject(String userId,
                         String guid)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         MetadataServerUncontactableException,
                         UnrecognizedGUIDException,
                         GUIDNotPurgedException,
                         UnexpectedResponseException,
                         FunctionNotSupportedException

Purge a Project instance The purge of a project is only allowed if there is no project content (i.e. no terms or categories). A purge means that the project will not exist after the operation.

Specified by:

purgeProject in interface SubjectAreaProject

Parameters:

userId - userId under which the request is performed

guid - guid of the project to be deleted.

Throws:

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.

GUIDNotPurgedException - a hard delete was issued but the project was not purged Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

FunctionNotSupportedException - Function not supported Client library Exceptions

restoreProject

public Project restoreProject(String userId,
                              String guid)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              MetadataServerUncontactableException,
                              UnrecognizedGUIDException,
                              FunctionNotSupportedException,
                              UnexpectedResponseException

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.

Specified by:

restoreProject in interface SubjectAreaProject

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:

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.

FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server