Package com.iknowbase.api.contentservices.query.content.model

Interface ContentLinkBuilder

  • public interface ContentLinkBuilder
    A builder that helps generate complete EditActions.

    The builder is acquired from ContentQueryRow

    • Method Detail

      • build

        Optional<ContentQueryAction> build()
        Returns an optional content link action built from parameters set on this builder. The returned Optional will be empty if the document doesn't have a content.
        Returns:
        an Optional built from parameters set on this builder

      • attributeGuid

        ContentLinkBuilder attributeGuid​(String attributeGuid)
        Specify an attribute guid to be used in the content link.
        Parameters:
        attributeGuid - the guid of the document_attribute
        Returns:
        this ContentLinkBuilder

      • fingerprint

        ContentLinkBuilder fingerprint​(boolean fingerprint)
        Specify whether a fingerprint (cache key) should be used in the content link or not. By default, a fingerprint is included.
        Parameters:
        fingerprint - if true, a fingerprint will be included in the content link
        Returns:
        this ContentLinkBuilder

      • transformationLookup

        ContentLinkBuilder transformationLookup​(String externalKey)
        Specify a registered transformation to be used in the content link. If the transformation is not configured for this document (by extension or media type), the builder will return an empty Optional.

        The resulting link will use the registered extension (if not overridden), but will otherwise not change the transformation key to the actual mapped transformation operation.

        Registered transformations are stored in iKnowBase and map transformation operations to extensions and media types.

        Parameters:
        externalKey - of the transformation
        Returns:
        this ContentLinkBuilder

      • transformationOperation

        ContentLinkBuilder transformationOperation​(String operation)
        Specify a transformation operation to be used in the content link. The transformation operation is not verified for correctness or suitability.
        Parameters:
        operation - the transformation
        Returns:
        this ContentLinkBuilder

      • extension

        ContentLinkBuilder extension​(String extension)
        Specify the extension to use on the link filename
        Parameters:
        extension -
        Returns:
        this ContentLinkBuilder