Class GlossaryAuthorViewSubjectAreaDefinitionCategoryClient
- java.lang.Object
-
- org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.subjectAreaDefinitionCategory.GlossaryAuthorViewSubjectAreaDefinitionCategoryClient
-
- All Implemented Interfaces:
ResponseParameterization<SubjectAreaDefinition>,GlossaryAuthorViewSubjectAreaDefinitionCategory
public class GlossaryAuthorViewSubjectAreaDefinitionCategoryClient extends Object implements GlossaryAuthorViewSubjectAreaDefinitionCategory, ResponseParameterization<SubjectAreaDefinition>
The class acts as a wrapper class for calling the REST services for Glossary Author SubjectAreaDefinition related services.
-
-
Field Summary
Fields Modifier and Type Field Description protected GlossaryAuthorViewRestClientclient
-
Constructor Summary
Constructors Constructor Description GlossaryAuthorViewSubjectAreaDefinitionCategoryClient(GlossaryAuthorViewRestClient client)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubjectAreaDefinitioncreate(String userId, SubjectAreaDefinition subjectAreaDefinition)Create a subjectAreaDefinition.<T> TcreateRel(String userId, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)SynonymcreateSynonym(String userId, Synonym synonym)voiddelete(String userId, String guid)Delete a SubjectAreaDefinition.<T> voiddeleteRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)List<SubjectAreaDefinition>find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)Extract children within a SubjectAreaDefinitionList<SubjectAreaDefinition>findAll(String userId)Find CategorySubjectAreaDefinitiongetByGUID(String userId, String guid)Get a SubjectAreaDefinition.List<Category>getCategories(String userId, String termGuid, FindRequest findRequest)Extract categories for a SubjectAreaDefinitionList<Category>getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)Extract children within a CategoryOMAGServerConfiggetConfig(String userId)Get config for serverViewServiceConfiggetGlossaryAuthViewServiceConfig(String userId)Get service config for a particular view Serviceprotected StringgetMethodInfo(String methodName)<T> TgetRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)SynonymgetSynonym(String userId, String guid)List<ViewServiceConfig>getViewServiceConfigs(String userId)Get list of view service config on the server<T> TreplaceRel(String userId, String guid, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType, boolean isReplace)Class<? extends GenericResponse>responseType()SubjectAreaDefinitionrestore(String userId, String guid)Restore a soft-deleted SubjectAreaDefinition.<T> TrestoreRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)SubjectAreaDefinitionupdate(String userId, String guid, SubjectAreaDefinition subjectAreaDefinition, boolean isReplace)Update a SubjectAreaDefinition.<T> TupdateRel(String userId, String guid, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType, boolean isReplace)SynonymupdateSynonym(String userId, String guid, Synonym updateSynonym, boolean isReplace)-
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.commonservices.ffdc.rest.ResponseParameterization
getParameterizedType, resultType
-
-
-
-
Field Detail
-
client
protected final GlossaryAuthorViewRestClient client
-
-
Constructor Detail
-
GlossaryAuthorViewSubjectAreaDefinitionCategoryClient
public GlossaryAuthorViewSubjectAreaDefinitionCategoryClient(GlossaryAuthorViewRestClient client)
-
-
Method Detail
-
create
public SubjectAreaDefinition create(String userId, SubjectAreaDefinition subjectAreaDefinition) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryCreate a subjectAreaDefinition.The result is the subjectAreaDefinition object
- Specified by:
createin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- userId under which the request is performedsubjectAreaDefinition- SubjectAreaDefinition object to be created- Returns:
- The SubjectAreaDefinition
- Throws:
PropertyServerException- something went wrong with the REST call stack.InvalidParameterException- one of the parameters is null or invalidUserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
update
public SubjectAreaDefinition update(String userId, String guid, SubjectAreaDefinition subjectAreaDefinition, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryUpdate a SubjectAreaDefinition.The result is the updated Glossary object
- Specified by:
updatein interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- userId under which the request is performedguid- guid of Glossary object to be updatedsubjectAreaDefinition- Glossary object with updated valuesisReplace- If the object is to be replaced- Returns:
- The updated SubjectAreaDefinition
- Throws:
PropertyServerException- something went wrong with the REST call stack.InvalidParameterException- one of the parameters is null or invalidUserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
delete
public void delete(String userId, String guid) throws PropertyServerException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryDelete a SubjectAreaDefinition.The result Void object
- Specified by:
deletein interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- userId under which the request is performedguid- guid of SubjectAreaDefinition object to be retrieved- Throws:
PropertyServerException- something went wrong with the REST call stack.
-
restore
public SubjectAreaDefinition restore(String userId, String guid) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryRestore a soft-deleted SubjectAreaDefinition.The result is the restored SubjectAreaDefinition object
- Specified by:
restorein interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- userId under which the request is performedguid- guid of SubjectAreaDefinition object to be restored- Returns:
- The restored SubjectAreaDefinition
- Throws:
PropertyServerException- something went wrong with the REST call stack.InvalidParameterException- one of the parameters is null or invalidUserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getCategoryChildren
public List<Category> getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryExtract children within a Category- Specified by:
getCategoryChildrenin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- calling userparentGuid- Category GUIDfindRequest- information object for find calls. This include pageSize to limit the number of elements returned.exactValue- exactValue - when false values with trailing characters will match.ignoreCase- ignore the case when matching.- Returns:
- list of Categories
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
findAll
public List<SubjectAreaDefinition> findAll(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryFind Category- Specified by:
findAllin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- calling user- Returns:
- Categories belonging to Userid
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getByGUID
public SubjectAreaDefinition getByGUID(String userId, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryGet a SubjectAreaDefinition.The result is the requested SubjectAreaDefinition object
- Specified by:
getByGUIDin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- userId under which the request is performedguid- guid of SubjectAreaDefinition object to be retrieved- Returns:
- The requested SubjectAreaDefinition
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
find
public List<SubjectAreaDefinition> find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryExtract children within a SubjectAreaDefinition- Specified by:
findin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- calling userfindRequest- information object for find calls. This include pageSize to limit the number of elements returned.exactValue- exactValue - when false values with trailing characters will match.ignoreCase- ignore the case when matching.- Returns:
- list of Categories
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getCategories
public List<Category> getCategories(String userId, String termGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryExtract categories for a SubjectAreaDefinition- Specified by:
getCategoriesin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- calling usertermGuid- RelationShip GUIDfindRequest- information object for find calls. This include pageSize to limit the number of elements returned.- Returns:
- list of Categories
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getConfig
public OMAGServerConfig getConfig(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryGet config for server- Specified by:
getConfigin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- calling user- Returns:
- Config for view server
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getGlossaryAuthViewServiceConfig
public ViewServiceConfig getGlossaryAuthViewServiceConfig(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryGet service config for a particular view Service- Specified by:
getGlossaryAuthViewServiceConfigin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- calling user- Returns:
- Config for view server
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getViewServiceConfigs
public List<ViewServiceConfig> getViewServiceConfigs(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewSubjectAreaDefinitionCategoryGet list of view service config on the server- Specified by:
getViewServiceConfigsin interfaceGlossaryAuthorViewSubjectAreaDefinitionCategory- Parameters:
userId- calling user- Returns:
- Config for view server
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
responseType
public Class<? extends GenericResponse> responseType()
- Specified by:
responseTypein interfaceResponseParameterization<SubjectAreaDefinition>
-
createSynonym
public Synonym createSynonym(String userId, Synonym synonym) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
-
getSynonym
public Synonym getSynonym(String userId, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
-
updateSynonym
public Synonym updateSynonym(String userId, String guid, Synonym updateSynonym, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
-
createRel
public <T> T createRel(String userId, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
-
getRel
public <T> T getRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
-
updateRel
public <T> T updateRel(String userId, String guid, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
-
replaceRel
public <T> T replaceRel(String userId, String guid, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
-
deleteRel
public <T> void deleteRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType) throws PropertyServerException
- Throws:
PropertyServerException
-
restoreRel
public <T> T restoreRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
-
-