Package org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.glossarys

Interface GlossaryAuthorViewGlossary

All Known Implementing Classes:

GlossaryAuthorViewGlossaryClient

public interface GlossaryAuthorViewGlossary

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary	create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary)	Create a Glossary.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>	createTerms(String userId, String glossaryGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term[] termArray)	Create multiple terms within a glossary
void	delete(String userId, String guid)	Delete a Glossary.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship>	getAllRelationships(String userId, String guid)	Get a Glossary's relationships
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary	getByGUID(String userId, String guid)	Get a Glossary.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>	getCategories(String userId, String glossaryGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)	Get the Categories owned by this glossary.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>	getCategories(String userId, String glossaryGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean onlyTop)	Get the Categories owned by this glossary.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>	getTerms(String userId, String glossaryGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)	Extract terms within a glossary
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary	restore(String userId, String guid)	Restore a soft-deleted Glossary.
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary	update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary, boolean action)	Update a Glossary.

Method Details

create

org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary create(String userId,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary)
                                                                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Create a Glossary.

The result is the Glossary object

Parameters:

userId - userId under which the request is performed

glossary - Glossary object to be created

Returns:

The Glossary

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

update

org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary update(String userId,
 String guid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary,
 boolean action)
                                                                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Update a Glossary.

The result is the updated Glossary object

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

glossary - Glossary object with updated values

action - To replace existing Glossary or not

Returns:

The updated Glossary

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

getByGUID

org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary getByGUID(String userId,
 String guid)
                                                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Get a Glossary.

The result is the requested Glossary object

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be retrieved

Returns:

The requested Glossary

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

delete

void delete(String userId,
 String guid)
     throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Delete a Glossary.

The result Void object

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be retrieved

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

getAllRelationships

List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship> getAllRelationships(String userId,
 String guid)
                                                                                                          throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Get a Glossary's relationships

The result is a list of Relationships

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be retrieved

Returns:

The list of Glossary relationships

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

restore

org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary restore(String userId,
 String guid)
                                                                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Restore a soft-deleted Glossary.

The result is the restored Glossary object

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be restored

Returns:

The restored Glossary

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

getCategories

List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategories(String userId,
 String glossaryGuid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
                                                                                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Get the Categories owned by this glossary.

Parameters:

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

glossaryGuid - unique identifier of the object to which the found objects should relate.

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

Returns:

list of Categories

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.

getCategories

List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategories(String userId,
 String glossaryGuid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
 boolean onlyTop)
                                                                                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Get the Categories owned by this glossary.

Parameters:

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

glossaryGuid - unique identifier of the object to which the found objects should relate.

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

onlyTop - when only the top categories (those categories without parents) are returned.

Returns:

list of Categories

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.

getTerms

List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term> getTerms(String userId,
 String glossaryGuid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
                                                                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Extract terms within a glossary

Parameters:

userId - calling user

glossaryGuid - glossary GUID

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

Returns:

list of terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

createTerms

List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term> createTerms(String userId,
 String glossaryGuid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term[] termArray)
                                                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Create multiple terms within a glossary

Parameters:

userId - calling user

glossaryGuid - glossary GUID

termArray - array of glossary objects that are to be created.

Returns:

list of terms created

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid