com.ibm.jarm.api.core

Interface RMContentElement



  • public interface RMContentElement
    Represents a single document content binary or reference type that can be contained by a ContentItem.

    Being a dependent type of ContentItem, a RMContentElement is only be retrieved as a member of the collection returned by the ContentItem.getContentElements method.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getBinaryContentRetrievalName()
      Typically provides a file system path string representing a binary content element's original location, if available.
      java.lang.Double getBinaryContentSize()
      Returns the size of binary content data, in bytes, if available.
      java.io.InputStream getBinaryContentStream()
      Provides an InputStream to the binary data for a binary content element.
      java.lang.String getContentType()
      Provides an indicator of the type of content that this content element represents.
      java.lang.String getReferenceContentLocation()
      Provides a location reference to some content (typically a URL string).
      boolean isAContentReference()
      Indicates whether this content element represents a reference to some external content (for example, URL) or actual content binary data.
    • Method Detail

      • isAContentReference

        boolean isAContentReference()
        Indicates whether this content element represents a reference to some external content (for example, URL) or actual content binary data.
        Returns:
        true if this content element represents a content reference, false if this content element represents content binary data.
      • getContentType

        java.lang.String getContentType()
        Provides an indicator of the type of content that this content element represents. This is typically a MIME type string.
        Returns:
        A String content type indicator.
      • getReferenceContentLocation

        java.lang.String getReferenceContentLocation()
        Provides a location reference to some content (typically a URL string). Only applicable to reference type content elements.
        Returns:
        A String value or null if not applicable to this content element.
      • getBinaryContentSize

        java.lang.Double getBinaryContentSize()
        Returns the size of binary content data, in bytes, if available.
        Returns:
        a Double value. This entry can be null if either the size data is not available or this content element represents a content reference.
      • getBinaryContentRetrievalName

        java.lang.String getBinaryContentRetrievalName()
        Typically provides a file system path string representing a binary content element's original location, if available.
        Returns:
        A String. This entry can be null.
      • getBinaryContentStream

        java.io.InputStream getBinaryContentStream()
        Provides an InputStream to the binary data for a binary content element. Important: It is the responsibility of the caller of this method to close the stream once all read operations have finished.
        Returns:
        An InputStream instance. This entry can be null.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.