org.odpi.openmetadata.accessservices.subjectarea.client

Interface SubjectAreaClient<T>

Type Parameters:

T - Glossary Artifact type for supplied and return. Interface describing common methods to client working with Subject area resources. This is the Subject Area client API, for use by the subject area expert. This API exposes SCRUD (search, create, read ,update, delete) operations that can be performed on a Glossary Artifact.

All Known Subinterfaces:

SubjectAreaNodeClient<E>, SubjectAreaRelationshipClient<L>

All Known Implementing Classes:

AbstractSubjectArea, AbstractSubjectAreaNode, AbstractSubjectAreaRelationship, SubjectAreaCategoryClient, SubjectAreaGlossaryClient, SubjectAreaProjectClient, SubjectAreaTermClient

public interface SubjectAreaClient<T>

Field Summary

Fields

Modifier and Type	Field and Description
static FindRequest	EMPTY_FIND_REQUEST

Method Summary

Modifier and Type	Method and Description
T	create(String userId, T supplied) Create a Glossary Artifact.
default void	delete(String userId, String guid) Soft delete a Glossary Artifact.
void	delete(String userId, String guid, boolean isPurge) Delete a Glossary Artifact.
List<T>	find(String userId, FindRequest findRequest) Request to find Glossary Artifacts of the type T.
List<T>	find(String userId, FindRequest findRequest, Integer maximumPageSizeOnRestCall) Request to find Glossary Artifacts of the type T.
default List<T>	findAll(String userId) Request to find all Glossary Artifacts of the type T.
default List<T>	findAll(String userId, Integer maximumPageSizeOnRestCall) Request to find all Glossary Artifacts of the type T.
T	getByGUID(String userId, String guid) Get Glossary Artifact by guid
default void	purge(String userId, String guid) Purge a Glossary Artifact.
default T	replace(String userId, String guid, T supplied) Replace a Glossary Artifact.
T	restore(String userId, String guid) Restore of a soft deleted Glossary Artifact.
default T	update(String userId, String guid, T supplied) Update a Glossary Artifact.
T	update(String userId, String guid, T supplied, boolean isReplace) Update or replace a Glossary Artifact.

Field Detail

EMPTY_FIND_REQUEST

static final FindRequest EMPTY_FIND_REQUEST

Method Detail

getByGUID

T getByGUID(String userId,
            String guid)
     throws InvalidParameterException,
            PropertyServerException,
            UserNotAuthorizedException

Get Glossary Artifact by guid

Parameters:

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

guid - unique identifier of the Glossary Artifact.

Returns:

found Glossary Artifact of the T type.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

create

T create(String userId,
         T supplied)
  throws InvalidParameterException,
         PropertyServerException,
         UserNotAuthorizedException

Create a Glossary Artifact. To create, you must pass the created object and specify a unique user identifier.

Parameters:

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

supplied - Glossary Artifact to create.

Returns:

created Glossary Artifact.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

findAll

default List<T> findAll(String userId)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Request to find all Glossary Artifacts of the type T. Be aware that getting all objects may incur a big performance hit when there are many objects.

Parameters:

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

Returns:

list all Glossary Artifacts of the T type.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

findAll

default List<T> findAll(String userId,
                        Integer maximumPageSizeOnRestCall)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Request to find all Glossary Artifacts of the type T. Be aware that getting all objects may incur a big performance hit when there are many objects.

Parameters:

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

maximumPageSizeOnRestCall - maximum page size that can be used on rest calls, null and 0 mean no limit set.

Returns:

list all Glossary Artifacts of the T type.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

find

List<T> find(String userId,
             FindRequest findRequest)
      throws InvalidParameterException,
             PropertyServerException,
             UserNotAuthorizedException

Request to find Glossary Artifacts of the type T.

Parameters:

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

findRequest - information Glossary Artifact for find calls.

Returns:

list Glossary Artifacts of the T type relevant in the findRequest information.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

find

List<T> find(String userId,
             FindRequest findRequest,
             Integer maximumPageSizeOnRestCall)
      throws InvalidParameterException,
             PropertyServerException,
             UserNotAuthorizedException

Request to find Glossary Artifacts of the type T. The downstream server is likely to have a maximum Page Size is will accept, the client can interrogate this value and include it on the maximumPageSizeOnRestCall parameter. This API will ensure will issue multiple rest calls if required to ensure requests only request the supported max page size.

Parameters:

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

findRequest - information Glossary Artifact for find calls.

maximumPageSizeOnRestCall - maximum page size that can be used on rest calls, null and 0 mean no limit set.

Returns:

list Glossary Artifacts of the T type relevant in the findRequest information.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

update

T update(String userId,
         String guid,
         T supplied,
         boolean isReplace)
  throws InvalidParameterException,
         PropertyServerException,
         UserNotAuthorizedException

Update or replace a Glossary Artifact.

Parameters:

guid - unique identifier of the Glossary Artifact.

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

supplied - Glossary Artifact to be updated or replaced.

isReplace - flag to indicate that this update is a replace.

Returns:

updated Glossary Artifact.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

replace

default T replace(String userId,
                  String guid,
                  T supplied)
           throws InvalidParameterException,
                  PropertyServerException,
                  UserNotAuthorizedException

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

Parameters:

guid - unique identifier of the Glossary Artifact.

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

supplied - Glossary Artifact to be replaced.

Returns:

replaced Glossary Artifact.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

update

default T update(String userId,
                 String guid,
                 T supplied)
          throws InvalidParameterException,
                 PropertyServerException,
                 UserNotAuthorizedException

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

Parameters:

guid - unique identifier of the Glossary Artifact.

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

supplied - Glossary Artifact to be updated.

Returns:

updated Glossary Artifact.

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

delete

void delete(String userId,
            String guid,
            boolean isPurge)
     throws InvalidParameterException,
            PropertyServerException,
            UserNotAuthorizedException

Delete a Glossary Artifact.

Parameters:

guid - unique identifier of the Glossary Artifact.

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

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

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

purge

default void purge(String userId,
                   String guid)
            throws InvalidParameterException,
                   PropertyServerException,
                   UserNotAuthorizedException

Purge a Glossary Artifact.

Parameters:

guid - unique identifier of the Glossary Artifact.

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

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

delete

default void delete(String userId,
                    String guid)
             throws InvalidParameterException,
                    PropertyServerException,
                    UserNotAuthorizedException

Soft delete a Glossary Artifact.

Parameters:

guid - unique identifier of the Glossary Artifact.

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

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.

restore

T restore(String userId,
          String guid)
   throws InvalidParameterException,
          PropertyServerException,
          UserNotAuthorizedException

Restore of a soft deleted Glossary Artifact.

Parameters:

guid - unique identifier of the Glossary Artifact.

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

Returns:

restored glossary Artifact

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid.