SubjectAreaRelationship (Subject Area OMAS Client 2.8 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.client.relationships.SubjectAreaRelationship

All Implemented Interfaces:

SubjectAreaRelationshipClients
```
public class SubjectAreaRelationship
extends Object
implements SubjectAreaRelationshipClients
```
The OMAS client library implementation of the Subject Area OMAS. This interface provides relationship Relationship authoring interface for subject area experts.

Constructor Summary

Constructors
Constructor and Description
`SubjectAreaRelationship(SubjectAreaRestClient subjectAreaRestClient)` The constructor uses the current package to scan "org.odpi.openmetadata.accessservices.subjectarea.client.relationships" to search for classes placed by annotation `SubjectAreaRelationshipClient`.
`SubjectAreaRelationship(SubjectAreaRestClient subjectAreaRestClient, String... packagesToScan)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubjectAreaRelationshipClient`	`antonym()`
`SubjectAreaRelationshipClient`	`categoryAnchor()`
`SubjectAreaClient<CategoryHierarchyLink>`	`categoryHierarchyLink()`
`<T extends Relationship> SubjectAreaRelationshipClient`	`getClient(Class<T> clazz)`
`SubjectAreaRelationshipClient`	`hasA()`
`SubjectAreaRelationshipClient`	`isA()`
`SubjectAreaRelationshipClient`	`isaTypeOf()`
`SubjectAreaRelationshipClient`	`preferredTerm()`
`SubjectAreaRelationshipClient`	`projectScope()`
`SubjectAreaRelationshipClient`	`relatedTerm()`
`SubjectAreaRelationshipClient`	`replacementTerm()`
`SubjectAreaRelationshipClient`	`semanticAssignment()`
`SubjectAreaRelationshipClient`	`synonym()`
`SubjectAreaRelationshipClient`	`termAnchor()`
`SubjectAreaRelationshipClient`	`termCategorization()`
`SubjectAreaRelationshipClient`	`translation()`
`SubjectAreaRelationshipClient`	`typedBy()`
`SubjectAreaRelationshipClient`	`usedInContext()`
`SubjectAreaRelationshipClient`	`validValue()`

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

- Constructor Detail
  - SubjectAreaRelationship
```
public SubjectAreaRelationship(SubjectAreaRestClient subjectAreaRestClient,
                               String... packagesToScan)
```
    Parameters:
    
    packagesToScan - - search packages for finding classes placed by annotation SubjectAreaRelationshipClient
    
    subjectAreaRestClient - - rest client for Subject Area OMAS REST APIs
  - SubjectAreaRelationship
```
public SubjectAreaRelationship(SubjectAreaRestClient subjectAreaRestClient)
```
    The constructor uses the current package to scan "org.odpi.openmetadata.accessservices.subjectarea.client.relationships" to search for classes placed by annotation SubjectAreaRelationshipClient.
    
    Parameters:
    
    subjectAreaRestClient - - rest client for Subject Area OMAS REST APIs
- Method Detail
  - hasA
```
public SubjectAreaRelationshipClient hasA()
```
    Specified by:
    
    hasA in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with HasA objects
  - relatedTerm
```
public SubjectAreaRelationshipClient relatedTerm()
```
    Specified by:
    
    relatedTerm in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with RelatedTerm objects
  - termAnchor
```
public SubjectAreaRelationshipClient termAnchor()
```
    Specified by:
    
    termAnchor in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with TermAnchor objects
  - projectScope
```
public SubjectAreaRelationshipClient projectScope()
```
    Specified by:
    
    projectScope in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with ProjectScope objects
  - synonym
```
public SubjectAreaRelationshipClient synonym()
```
    Specified by:
    
    synonym in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with Synonym objects
  - antonym
```
public SubjectAreaRelationshipClient antonym()
```
    Specified by:
    
    antonym in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with Antonym objects
  - translation
```
public SubjectAreaRelationshipClient translation()
```
    Specified by:
    
    translation in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with Translation objects
  - usedInContext
```
public SubjectAreaRelationshipClient usedInContext()
```
    Specified by:
    
    usedInContext in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with UsedInContext objects
  - preferredTerm
```
public SubjectAreaRelationshipClient preferredTerm()
```
    Specified by:
    
    preferredTerm in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with PreferredTerm objects
  - validValue
```
public SubjectAreaRelationshipClient validValue()
```
    Specified by:
    
    validValue in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with ValidValue objects
  - replacementTerm
```
public SubjectAreaRelationshipClient replacementTerm()
```
    Specified by:
    
    replacementTerm in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with ReplacementTerm objects
  - typedBy
```
public SubjectAreaRelationshipClient typedBy()
```
    Specified by:
    
    typedBy in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with TypedBy objects
  - isA
```
public SubjectAreaRelationshipClient isA()
```
    Specified by:
    
    isA in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with IsA objects
  - isaTypeOf
```
public SubjectAreaRelationshipClient isaTypeOf()
```
    Specified by:
    
    isaTypeOf in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with IsaTypeOf objects
  - termCategorization
```
public SubjectAreaRelationshipClient termCategorization()
```
    Specified by:
    
    termCategorization in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with Categorization objects
  - semanticAssignment
```
public SubjectAreaRelationshipClient semanticAssignment()
```
    Specified by:
    
    semanticAssignment in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with SemanticAssignment objects
  - categoryHierarchyLink
```
public SubjectAreaClient<CategoryHierarchyLink> categoryHierarchyLink()
```
    Specified by:
    
    categoryHierarchyLink in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with CategoryHierarchyLink objects
  - categoryAnchor
```
public SubjectAreaRelationshipClient categoryAnchor()
```
    Specified by:
    
    categoryAnchor in interface SubjectAreaRelationshipClients
    
    Returns:
    
    SubjectAreaRelationshipClient for client calls(described in SubjectAreaClient) when working with CategoryAnchor objects
  - getClient
```
public <T extends Relationship> SubjectAreaRelationshipClient getClient(Class<T> clazz)
```
    Type Parameters:
    
    T - - Relationship type of object
    
    Parameters:
    
    clazz - - the class for which you want to get the client from cache
    
    Returns:
    
    SubjectAreaRelationshipClient or null if this client is not present

Class SubjectAreaRelationship

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubjectAreaRelationship

SubjectAreaRelationship

Method Detail

hasA

relatedTerm

termAnchor

projectScope

synonym

antonym

translation

usedInContext

preferredTerm

validValue

replacementTerm

typedBy

isA

isaTypeOf

termCategorization

semanticAssignment

categoryHierarchyLink

categoryAnchor

getClient