Interface GlossaryAuthorViewGlossary
- All Known Implementing Classes:
GlossaryAuthorViewGlossaryClient
public interface GlossaryAuthorViewGlossary
-
Method Summary
Modifier and TypeMethodDescriptionCreate a Glossary.createTerms
(String userId, String glossaryGuid, Term[] termArray) Create multiple terms within a glossaryvoid
Delete a Glossary.getAllRelationships
(String userId, String guid) Get a Glossary's relationshipsGet a Glossary.getCategories
(String userId, String glossaryGuid, FindRequest findRequest) Get the Categories owned by this glossary.getCategories
(String userId, String glossaryGuid, FindRequest findRequest, boolean onlyTop) Get the Categories owned by this glossary.getTerms
(String userId, String glossaryGuid, FindRequest findRequest) Extract terms within a glossaryRestore a soft-deleted Glossary.Update a Glossary.
-
Method Details
-
create
Glossary create(String userId, Glossary glossary) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Create a Glossary.The result is the Glossary object
- Parameters:
userId
- userId under which the request is performedglossary
- Glossary object to be created- Returns:
- The Glossary
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
update
Glossary update(String userId, String guid, Glossary glossary, boolean action) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException Update a Glossary.The result is the updated Glossary object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be updatedglossary
- Glossary object with updated valuesaction
- To replace existing Glossary or not- Returns:
- The updated Glossary
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
getByGUID
Glossary getByGUID(String userId, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Get a Glossary.The result is the requested Glossary object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be retrieved- Returns:
- The requested Glossary
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
delete
Delete a Glossary.The result Void object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be retrieved- Throws:
PropertyServerException
- something went wrong with the REST call stack.
-
getAllRelationships
List<Relationship> getAllRelationships(String userId, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Get a Glossary's relationshipsThe result is a list of Relationships
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be retrieved- Returns:
- The list of Glossary relationships
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
restore
Glossary restore(String userId, String guid) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException Restore a soft-deleted Glossary.The result is the restored Glossary object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be restored- Returns:
- The restored Glossary
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
getCategories
List<Category> getCategories(String userId, String glossaryGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, 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:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid.
-
getCategories
List<Category> getCategories(String userId, String glossaryGuid, FindRequest findRequest, boolean onlyTop) throws InvalidParameterException, PropertyServerException, 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:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid.
-
getTerms
List<Term> getTerms(String userId, String glossaryGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Extract terms within a glossary- Parameters:
userId
- calling userglossaryGuid
- glossary GUIDfindRequest
- information object for find calls. This include pageSize to limit the number of elements returned.- Returns:
- list of terms
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
createTerms
List<Term> createTerms(String userId, String glossaryGuid, Term[] termArray) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException Create multiple terms within a glossary- Parameters:
userId
- calling userglossaryGuid
- glossary GUIDtermArray
- array of glossary objects that are to be created.- Returns:
- list of terms created
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-