Package org.odpi.openmetadata.viewservices.glossaryauthor.services

Class GlossaryAuthorViewTermRESTServices

  • public class GlossaryAuthorViewTermRESTServices
extends BaseGlossaryAuthorView
    The GlossaryAuthorViewTermRESTServices provides the org.odpi.openmetadata.viewservices.glossaryauthor.services implementation of the Glossary Author Open Metadata View Service (OMVS). This interface provides view term authoring interfaces for subject area experts to author terms.

    • Constructor Detail

      • GlossaryAuthorViewTermRESTServices

        public GlossaryAuthorViewTermRESTServices()
        Default constructor

    • Method Detail

      • createTerm

        public SubjectAreaOMASAPIResponse<Term> createTerm​(String serverName,
                                                   String userId,
                                                   Term suppliedTerm)
        Create a Term
        Parameters:
        serverName - name of the local view server.
        userId - userId under which the request is performed
        suppliedTerm - Term to create
        Returns:
        the created term.
        • UserNotAuthorizedException the requesting user is not authorized to issue this request.
        • InvalidParameterException one of the parameters is null or invalid.
        • PropertyServerException Property server exception.

      • getTerm

        public SubjectAreaOMASAPIResponse<Term> getTerm​(String serverName,
                                                String userId,
                                                String guid)
        Get a term. The server has a maximum page size defined, the number of categories (a field of Term) returned is limited by that maximum page size.
        Parameters:
        serverName - name of the local view server.
        userId - user identifier
        guid - guid of the term to get
        Returns:
        response which when successful contains the term with the requested guid when not successful the following Exception responses can occur
        • UserNotAuthorizedException the requesting user is not authorized to issue this request.
        • InvalidParameterException one of the parameters is null or invalid.
        • PropertyServerException Property server exception.

      • findTerm

        public SubjectAreaOMASAPIResponse<Term> findTerm​(String serverName,
                                                 String userId,
                                                 Date asOfTime,
                                                 String searchCriteria,
                                                 boolean exactValue,
                                                 boolean ignoreCase,
                                                 Integer startingFrom,
                                                 Integer pageSize,
                                                 SequencingOrder sequencingOrder,
                                                 String sequencingProperty)
        Find Term
        Parameters:
        serverName - name of the local view server.
        userId - user identifier
        searchCriteria - String expression matching Term property values .
        exactValue - a boolean, which when set means that only exact matches will be returned, otherwise matches that start with the search criteria will be returned.
        ignoreCase - a boolean, which when set means that case will be ignored, if not set that case will be respected
        asOfTime - the glossaries returned as they were at this time. null indicates at the current time.
        startingFrom - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.
        pageSize - the maximum number of elements that can be returned on this request.
        sequencingOrder - the sequencing order for the results.
        sequencingProperty - the name of the property that should be used to sequence the results.
        Returns:
        A list of glossaries meeting the search Criteria
        • UserNotAuthorizedException the requesting user is not authorized to issue this request.
        • InvalidParameterException one of the parameters is null or invalid.
        • PropertyServerException Property server exception.

      • getTermRelationships

        public SubjectAreaOMASAPIResponse<Relationship> getTermRelationships​(String serverName,
                                                                     String userId,
                                                                     String guid,
                                                                     Date asOfTime,
                                                                     Integer startingFrom,
                                                                     Integer pageSize,
                                                                     SequencingOrder sequencingOrder,
                                                                     String sequencingProperty)
        Get Term relationships
        Parameters:
        serverName - name of the local view server.
        userId - user identifier
        guid - guid of the term to get
        asOfTime - the relationships returned as they were at this time. null indicates at the current time. If specified, the date is in milliseconds since 1970-01-01 00:00:00.
        startingFrom - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.
        pageSize - the maximum number of elements that can be returned on this request.
        sequencingOrder - the sequencing order for the results.
        sequencingProperty - the name of the property that should be used to sequence the results.
        Returns:
        a response which when successful contains the term relationships when not successful the following Exception responses can occur
        • UserNotAuthorizedException the requesting user is not authorized to issue this request.
        • InvalidParameterException one of the parameters is null or invalid.
        • PropertyServerException Property server exception.

      • updateTerm

        public SubjectAreaOMASAPIResponse<Term> updateTerm​(String serverName,
                                                   String userId,
                                                   String guid,
                                                   Term term,
                                                   boolean isReplace)
        Update a Term

        Status is not updated using this call.

        Parameters:
        serverName - name of the local view server.
        userId - user identifier
        guid - guid of the term to update
        term - term to update
        isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
        Returns:
        a response which when successful contains the updated term when not successful the following Exception responses can occur
        • UserNotAuthorizedException the requesting user is not authorized to issue this request.
        • InvalidParameterException one of the parameters is null or invalid.
        • PropertyServerException Property server exception.

      • deleteTerm

        public SubjectAreaOMASAPIResponse<Term> deleteTerm​(String serverName,
                                                   String userId,
                                                   String guid)
        Delete a Term instance

        The deletion of a term is only allowed if there is no term content (i.e. no terms or categories).

        There are 2 types of deletion, a soft delete and a hard delete (also known as a purge). All repositories support hard deletes. Soft deletes support is optional.

        A soft delete means that the term instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete. A hard delete means that the term will not exist after the operation. when not successful the following Exceptions can occur

        Parameters:
        serverName - name of the local view server.
        userId - user identifier
        guid - guid of the term to be deleted.
        Returns:
        a void response when not successful the following Exception responses can occur
        • UserNotAuthorizedException the requesting user is not authorized to issue this request.
        • InvalidParameterException one of the parameters is null or invalid.
        • PropertyServerException Property server exception.

      • restoreTerm

        public SubjectAreaOMASAPIResponse<Term> restoreTerm​(String serverName,
                                                    String userId,
                                                    String guid)
        Restore a Term

        Restore allows the deleted Term to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

        Parameters:
        serverName - name of the local view server.
        userId - user identifier
        guid - guid of the term to restore
        Returns:
        response which when successful contains the restored term when not successful the following Exception responses can occur
        • UserNotAuthorizedException the requesting user is not authorized to issue this request.
        • InvalidParameterException one of the parameters is null or invalid.
        • PropertyServerException Property server exception.