org.odpi.openmetadata.accessservices.subjectarea.client

Class AbstractSubjectArea<T>

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.client.AbstractSubjectArea<T>

All Implemented Interfaces:

Parametrization<T>, SubjectAreaClient<T>

Direct Known Subclasses:

AbstractSubjectAreaNode, AbstractSubjectAreaRelationship

public abstract class AbstractSubjectArea<T>
extends Object
implements SubjectAreaClient<T>, Parametrization<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_RELATIONSHIPS_URL
protected String	BASE_URL
protected SubjectAreaRestClient	client
static String	SUBJECT_AREA_BASE_URL

Fields inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaClient

EMPTY_FIND_REQUEST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSubjectArea(SubjectAreaRestClient client, String baseUrl)

Method Summary

Modifier and Type	Method and Description
T	create(String userId, T supplied) Create 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.
T	getByGUID(String userId, String guid) Get Glossary Artifact by guid
protected String	getMethodInfo(String methodName)
T	restore(String userId, String guid) Restore of a soft deleted Glossary Artifact.
T	update(String userId, String guid, T supplied, boolean isReplace) Update or replace a Glossary Artifact.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaClient

delete, findAll, purge, replace, update

Methods inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.Parametrization

getParametrizedType, type

Field Detail

SUBJECT_AREA_BASE_URL

public static final String SUBJECT_AREA_BASE_URL

See Also:

Constant Field Values

BASE_RELATIONSHIPS_URL

public static final String BASE_RELATIONSHIPS_URL

See Also:

Constant Field Values

BASE_URL

protected final String BASE_URL

client

protected final SubjectAreaRestClient client

Constructor Detail

AbstractSubjectArea

protected AbstractSubjectArea(SubjectAreaRestClient client,
                              String baseUrl)

Method Detail

getByGUID

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

Description copied from interface: SubjectAreaClient

Get Glossary Artifact by guid

Specified by:

getByGUID in interface SubjectAreaClient<T>

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:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - something went wrong with the REST call stack.

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

create

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

Description copied from interface: SubjectAreaClient

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

Specified by:

create in interface SubjectAreaClient<T>

Parameters:

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

supplied - Glossary Artifact to create.

Returns:

created Glossary Artifact.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - something went wrong with the REST call stack.

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

find

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

Description copied from interface: SubjectAreaClient

Request to find Glossary Artifacts of the type T.

Specified by:

find in interface SubjectAreaClient<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:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - something went wrong with the REST call stack.

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

update

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

Description copied from interface: SubjectAreaClient

Update or replace a Glossary Artifact.

Specified by:

update in interface SubjectAreaClient<T>

Parameters:

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

guid - unique identifier of the Glossary Artifact.

supplied - Glossary Artifact to be updated or replaced.

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

Returns:

updated Glossary Artifact.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - something went wrong with the REST call stack.

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

delete

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

Description copied from interface: SubjectAreaClient

Delete a Glossary Artifact.

Specified by:

delete in interface SubjectAreaClient<T>

Parameters:

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

guid - unique identifier of the Glossary Artifact.

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

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - something went wrong with the REST call stack.

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

restore

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

Description copied from interface: SubjectAreaClient

Restore of a soft deleted Glossary Artifact.

Specified by:

restore in interface SubjectAreaClient<T>

Parameters:

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

guid - unique identifier of the Glossary Artifact.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - something went wrong with the REST call stack.

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

getMethodInfo

protected String getMethodInfo(String methodName)