DetectUtils (Subject Area OMAS Client 1.2 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.utils.DetectUtils

```
public class DetectUtils
extends Object
```
Utility methods take a response and look for a particular type of response. For Exception response there are some detect and throw methods that throw, which look for a particular Exception and if it is found throws it.

Constructor Summary

Constructors
Constructor and Description

DetectUtils()

Constructors
Constructor and Description
`DetectUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Antonym`	`detectAndReturnAntonym(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static List<Category>`	`detectAndReturnCategories(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static Category`	`detectAndReturnCategory(String methodName, SubjectAreaOMASAPIResponse restResponse)` Detect and return a Category object from the supplied response.
`static CategoryAnchorRelationship`	`detectAndReturnCategoryAnchorRelationship(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static List<Glossary>`	`detectAndReturnGlossaries(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static Glossary`	`detectAndReturnGlossary(String methodName, SubjectAreaOMASAPIResponse restResponse)` Detect and return a Glossary object from the supplied response.
`static Graph`	`detectAndReturnGraph(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static ISARelationship`	`detectAndReturnISARelationship(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static List<Line>`	`detectAndReturnLines(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static PreferredTerm`	`detectAndReturnPreferredTerm(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static Project`	`detectAndReturnProject(String methodName, SubjectAreaOMASAPIResponse restResponse)` Detect and return a Project object from the supplied response.
`static List<Project>`	`detectAndReturnProjects(String methodName, SubjectAreaOMASAPIResponse restResponse)` Detect and return a List of Project objects from the supplied response.
`static ProjectScopeRelationship`	`detectAndReturnProjectScope(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static RelatedTerm`	`detectAndReturnRelatedTerm(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static ReplacementTerm`	`detectAndReturnReplacementTerm(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static SemanticAssignment`	`detectAndReturnSemanticAssignmentRelationship(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static SubjectAreaDefinition`	`detectAndReturnSubjectAreaDefinition(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static Synonym`	`detectAndReturnSynonym(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static Term`	`detectAndReturnTerm(String methodName, SubjectAreaOMASAPIResponse restResponse)` Detect and return a Term object from the supplied response.
`static TermAnchorRelationship`	`detectAndReturnTermAnchorRelationship(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static TermCategorizationRelationship`	`detectAndReturnTermCategorizationRelationship(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static TermHASARelationship`	`detectAndReturnTermHASARelationship(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static TermISATypeOFRelationship`	`detectAndReturnTermISATypeOFRelationship(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static List<Term>`	`detectAndReturnTerms(String methodName, SubjectAreaOMASAPIResponse restResponse)` Detect and return a List of Terms from the supplied response.
`static TermTYPEDBYRelationship`	`detectAndReturnTermTYPEDBYRelationship(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static Translation`	`detectAndReturnTranslation(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static UsedInContext`	`detectAndReturnUsedInContext(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static ValidValue`	`detectAndReturnValidValue(String methodName, SubjectAreaOMASAPIResponse restResponse)`
`static void`	`detectAndThrowClassificationException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an ClassificationException if it is encoded in the REST response.
`static void`	`detectAndThrowEntityNotDeletedException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an EntityNotDeletedException if it is encoded in the REST response.
`static void`	`detectAndThrowFunctionNotSupportedException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an FunctionNotSupportedException if it is encoded in the REST response.
`static void`	`detectAndThrowGUIDNotPurgedException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an GUIDNotPurgedException if it is encoded in the REST response.
`static void`	`detectAndThrowInvalidParameterException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an InvalidParameterException if it is encoded in the REST response.
`static void`	`detectAndThrowRelationshipNotDeletedException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an RelationshipNotDeletedException if it is encoded in the REST response.
`static void`	`detectAndThrowStatusNotSupportedException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an StatusNotSupportedException if it is encoded in the REST response.
`static void`	`detectAndThrowUnrecognizedGUIDException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an UnrecognizedGUIDException if it is encoded in the REST response.
`static void`	`detectAndThrowUserNotAuthorizedException(String methodName, SubjectAreaOMASAPIResponse restResponse)` Throw an UserNotAuthorizedException if it is encoded in the REST response.
`static void`	`detectVoid(String methodName, SubjectAreaOMASAPIResponse restResponse)` Detect Void return.
`static SubjectAreaOMASAPIResponse`	`getResponseFromException(SubjectAreaCheckedExceptionBase e)` Convert a subject area a checked exception to a response

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DetectUtils
```
public DetectUtils()
```

Method Detail

detectAndThrowInvalidParameterException

public static void detectAndThrowInvalidParameterException(String methodName,
                                                           SubjectAreaOMASAPIResponse restResponse)
                                                    throws InvalidParameterException

Throw an InvalidParameterException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: InvalidParameterException - - encoded exception from the handlers

detectAndThrowUnrecognizedGUIDException

public static void detectAndThrowUnrecognizedGUIDException(String methodName,
                                                           SubjectAreaOMASAPIResponse restResponse)
                                                    throws UnrecognizedGUIDException

Throw an UnrecognizedGUIDException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: UnrecognizedGUIDException - - encoded exception from the handlers

detectAndThrowClassificationException

public static void detectAndThrowClassificationException(String methodName,
                                                         SubjectAreaOMASAPIResponse restResponse)
                                                  throws ClassificationException

Throw an ClassificationException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: ClassificationException - - encoded exception from the handlers

detectAndThrowEntityNotDeletedException

public static void detectAndThrowEntityNotDeletedException(String methodName,
                                                           SubjectAreaOMASAPIResponse restResponse)
                                                    throws EntityNotDeletedException

Throw an EntityNotDeletedException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: EntityNotDeletedException - - encoded exception from the handlers

detectAndThrowFunctionNotSupportedException

public static void detectAndThrowFunctionNotSupportedException(String methodName,
                                                               SubjectAreaOMASAPIResponse restResponse)
                                                        throws FunctionNotSupportedException

Throw an FunctionNotSupportedException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: FunctionNotSupportedException - - encoded exception from the handlers

detectAndThrowGUIDNotPurgedException

public static void detectAndThrowGUIDNotPurgedException(String methodName,
                                                        SubjectAreaOMASAPIResponse restResponse)
                                                 throws GUIDNotPurgedException

Throw an GUIDNotPurgedException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: GUIDNotPurgedException - - encoded exception from the handlers

detectAndThrowRelationshipNotDeletedException

public static void detectAndThrowRelationshipNotDeletedException(String methodName,
                                                                 SubjectAreaOMASAPIResponse restResponse)
                                                          throws RelationshipNotDeletedException

Throw an RelationshipNotDeletedException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: RelationshipNotDeletedException - - encoded exception from the handlers

detectAndThrowStatusNotSupportedException

public static void detectAndThrowStatusNotSupportedException(String methodName,
                                                             SubjectAreaOMASAPIResponse restResponse)
                                                      throws StatusNotSupportedException

Throw an StatusNotSupportedException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: StatusNotSupportedException - - encoded exception from the handlers

detectAndThrowUserNotAuthorizedException

public static void detectAndThrowUserNotAuthorizedException(String methodName,
                                                            SubjectAreaOMASAPIResponse restResponse)
                                                     throws UserNotAuthorizedException

Throw an UserNotAuthorizedException if it is encoded in the REST response.

Parameters:: methodName - - name of the method called; restResponse - - response from the rest call. This generated in the remote handlers.
Throws:: UserNotAuthorizedException - - encoded exception from the handlers

detectVoid
```
public static void detectVoid(String methodName,
                              SubjectAreaOMASAPIResponse restResponse)
                       throws UnexpectedResponseException
```
Detect Void return. If we do not find one then throw an Exception

Parameters:

methodName - - name of the method called

restResponse - - response from the rest call. This generated in the remote handlers.

Throws:

UnexpectedResponseException - - if the response is not a glossary then throw this exception

detectAndReturnGlossary
```
public static Glossary detectAndReturnGlossary(String methodName,
                                               SubjectAreaOMASAPIResponse restResponse)
                                        throws UnexpectedResponseException
```
Detect and return a Glossary object from the supplied response. If we do not find one then throw an Exception

Parameters:

methodName - - name of the method called

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Glossary if the supplied response is a glossary response

Throws:

UnexpectedResponseException - - if the response is not a glossary then throw this exception

detectAndReturnGlossaries

public static List<Glossary> detectAndReturnGlossaries(String methodName,
                                                       SubjectAreaOMASAPIResponse restResponse)
                                                throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnProject
```
public static Project detectAndReturnProject(String methodName,
                                             SubjectAreaOMASAPIResponse restResponse)
                                      throws UnexpectedResponseException
```
Detect and return a Project object from the supplied response. If we do not find one then throw an Exception

Parameters:

methodName - - name of the method called

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Project if the supplied response is a project response

Throws:

UnexpectedResponseException - - if the response is not a project then throw this exception

detectAndReturnProjects
```
public static List<Project> detectAndReturnProjects(String methodName,
                                                    SubjectAreaOMASAPIResponse restResponse)
                                             throws UnexpectedResponseException
```
Detect and return a List of Project objects from the supplied response. If we do not find one then throw an Exception

Parameters:

methodName - - name of the method called

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Projects if the supplied response is a project response

Throws:

UnexpectedResponseException - - if the response is not a project then throw this exception

detectAndReturnTerm
```
public static Term detectAndReturnTerm(String methodName,
                                       SubjectAreaOMASAPIResponse restResponse)
                                throws UnexpectedResponseException
```
Detect and return a Term object from the supplied response. If we do not find one then throw an Exception

Parameters:

methodName - - name of the method called

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Term if the supplied response is a term response

Throws:

UnexpectedResponseException - - if the response is not a Term then throw this exception

detectAndReturnTerms
```
public static List<Term> detectAndReturnTerms(String methodName,
                                              SubjectAreaOMASAPIResponse restResponse)
                                       throws UnexpectedResponseException
```
Detect and return a List of Terms from the supplied response. If we do not find one then throw an Exception

Parameters:

methodName - - name of the method called

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

List of Terms if the supplied response is a terms response

Throws:

UnexpectedResponseException - - if the response is not a Terms then throw this exception

detectAndReturnGraph

public static Graph detectAndReturnGraph(String methodName,
                                         SubjectAreaOMASAPIResponse restResponse)
                                  throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnLines

public static List<Line> detectAndReturnLines(String methodName,
                                              SubjectAreaOMASAPIResponse restResponse)
                                       throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnCategory
```
public static Category detectAndReturnCategory(String methodName,
                                               SubjectAreaOMASAPIResponse restResponse)
                                        throws UnexpectedResponseException
```
Detect and return a Category object from the supplied response. If we do not find one then throw an Exception

Parameters:

methodName - - name of the method called

restResponse - - response from the rest call. This generated in the remote handlers.

Returns:

Category if the supplied response is a category response

Throws:

UnexpectedResponseException - - if the response is not a Category then throw this exception

detectAndReturnCategories

public static List<Category> detectAndReturnCategories(String methodName,
                                                       SubjectAreaOMASAPIResponse restResponse)
                                                throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnSubjectAreaDefinition

public static SubjectAreaDefinition detectAndReturnSubjectAreaDefinition(String methodName,
                                                                         SubjectAreaOMASAPIResponse restResponse)
                                                                  throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnTermHASARelationship

public static TermHASARelationship detectAndReturnTermHASARelationship(String methodName,
                                                                       SubjectAreaOMASAPIResponse restResponse)
                                                                throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnRelatedTerm

public static RelatedTerm detectAndReturnRelatedTerm(String methodName,
                                                     SubjectAreaOMASAPIResponse restResponse)
                                              throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnSynonym

public static Synonym detectAndReturnSynonym(String methodName,
                                             SubjectAreaOMASAPIResponse restResponse)
                                      throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnAntonym

public static Antonym detectAndReturnAntonym(String methodName,
                                             SubjectAreaOMASAPIResponse restResponse)
                                      throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnTranslation

public static Translation detectAndReturnTranslation(String methodName,
                                                     SubjectAreaOMASAPIResponse restResponse)
                                              throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnUsedInContext

public static UsedInContext detectAndReturnUsedInContext(String methodName,
                                                         SubjectAreaOMASAPIResponse restResponse)
                                                  throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnPreferredTerm

public static PreferredTerm detectAndReturnPreferredTerm(String methodName,
                                                         SubjectAreaOMASAPIResponse restResponse)
                                                  throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnValidValue

public static ValidValue detectAndReturnValidValue(String methodName,
                                                   SubjectAreaOMASAPIResponse restResponse)
                                            throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnReplacementTerm

public static ReplacementTerm detectAndReturnReplacementTerm(String methodName,
                                                             SubjectAreaOMASAPIResponse restResponse)
                                                      throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnTermTYPEDBYRelationship

public static TermTYPEDBYRelationship detectAndReturnTermTYPEDBYRelationship(String methodName,
                                                                             SubjectAreaOMASAPIResponse restResponse)
                                                                      throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnISARelationship

public static ISARelationship detectAndReturnISARelationship(String methodName,
                                                             SubjectAreaOMASAPIResponse restResponse)
                                                      throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnTermISATypeOFRelationship

public static TermISATypeOFRelationship detectAndReturnTermISATypeOFRelationship(String methodName,
                                                                                 SubjectAreaOMASAPIResponse restResponse)
                                                                          throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnSemanticAssignmentRelationship

public static SemanticAssignment detectAndReturnSemanticAssignmentRelationship(String methodName,
                                                                               SubjectAreaOMASAPIResponse restResponse)
                                                                        throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnTermCategorizationRelationship

public static TermCategorizationRelationship detectAndReturnTermCategorizationRelationship(String methodName,
                                                                                           SubjectAreaOMASAPIResponse restResponse)
                                                                                    throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnTermAnchorRelationship

public static TermAnchorRelationship detectAndReturnTermAnchorRelationship(String methodName,
                                                                           SubjectAreaOMASAPIResponse restResponse)
                                                                    throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnCategoryAnchorRelationship

public static CategoryAnchorRelationship detectAndReturnCategoryAnchorRelationship(String methodName,
                                                                                   SubjectAreaOMASAPIResponse restResponse)
                                                                            throws UnexpectedResponseException

Throws:: UnexpectedResponseException

detectAndReturnProjectScope

public static ProjectScopeRelationship detectAndReturnProjectScope(String methodName,
                                                                   SubjectAreaOMASAPIResponse restResponse)
                                                            throws UnexpectedResponseException

Throws:: UnexpectedResponseException

getResponseFromException
```
public static SubjectAreaOMASAPIResponse getResponseFromException(SubjectAreaCheckedExceptionBase e)
```
Convert a subject area a checked exception to a response

Parameters:

e - Exception to comnvert

Returns:

the relevant exception response

Class DetectUtils

Constructor Summary