org.odpi.openmetadata.accessservices.subjectarea

Interface SubjectAreaProject

All Known Implementing Classes:

SubjectAreaProjectImpl

public interface SubjectAreaProject

The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for projects.

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
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
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.

Method Detail

createProject

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

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.

UnrecognizedGUIDException - the supplied guid was not recognised

ClassificationException - Error processing a classification

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getProjectByGuid

Project getProjectByGuid(String userId,
                         String guid)
                  throws MetadataServerUncontactableException,
                         UnrecognizedGUIDException,
                         UserNotAuthorizedException,
                         InvalidParameterException,
                         FunctionNotSupportedException,
                         UnexpectedResponseException,
                         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.

UnrecognizedGUIDException - the supplied guid was not recognised

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getProjectRelationships

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

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.

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

PropertyServerException - Property Server Exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getProjectTerms

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

Get the terms in this project.

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

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

findProject

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

Find Project

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

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

replaceProject

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

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.

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.

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

updateProject

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

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.

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.

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

deleteProject

Project deleteProject(String userId,
                      String guid)
               throws InvalidParameterException,
                      MetadataServerUncontactableException,
                      UserNotAuthorizedException,
                      UnrecognizedGUIDException,
                      FunctionNotSupportedException,
                      UnexpectedResponseException,
                      EntityNotDeletedException,
                      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.

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.

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

purgeProject

void purgeProject(String userId,
                  String guid)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  MetadataServerUncontactableException,
                  UnrecognizedGUIDException,
                  EntityNotPurgedException,
                  UnexpectedResponseException,
                  FunctionNotSupportedException,
                  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:

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.

EntityNotPurgedException - a hard delete was issued but the Project was not purged

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

restoreProject

Project restoreProject(String userId,
                       String guid)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       MetadataServerUncontactableException,
                       UnrecognizedGUIDException,
                       FunctionNotSupportedException,
                       UnexpectedResponseException,
                       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:

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 restore was issued but the repository does not support it.

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server