Interface Document

All Superinterfaces:
Cloneable, Serializable
All Known Implementing Classes:
DocumentImpl

@ProviderType public interface Document extends Cloneable, Serializable
Author:
Brian Wing Shun Chan, Bruno Farache
  • Method Details

    • add

      void add(Field field)
    • addDate

      void addDate(String name, Date value)
    • addDate

      void addDate(String name, Date[] values)
    • addDateSortable

      void addDateSortable(String name, Date value)
    • addDateSortable

      void addDateSortable(String name, Date[] values)
    • addFile

      @Deprecated void addFile(String name, byte[] bytes, String fileExt) throws IOException
      Deprecated.
      As of Cavanaugh (7.4.x), with no direct replacement
      Throws:
      IOException
    • addFile

      @Deprecated void addFile(String name, File file, String fileExt) throws IOException
      Deprecated.
      As of Cavanaugh (7.4.x), with no direct replacement
      Throws:
      IOException
    • addFile

      @Deprecated void addFile(String name, InputStream inputStream, String fileExt) throws IOException
      Deprecated.
      As of Cavanaugh (7.4.x), with no direct replacement
      Throws:
      IOException
    • addFile

      @Deprecated void addFile(String name, InputStream inputStream, String fileExt, int maxStringLength) throws IOException
      Deprecated.
      As of Cavanaugh (7.4.x), with no direct replacement
      Throws:
      IOException
    • addGeoLocation

      void addGeoLocation(double latitude, double longitude)
    • addGeoLocation

      void addGeoLocation(String name, double latitude, double longitude)
    • addKeyword

      void addKeyword(String name, boolean value)
    • addKeyword

      void addKeyword(String name, Boolean value)
    • addKeyword

      void addKeyword(String name, boolean[] values)
    • addKeyword

      void addKeyword(String name, Boolean[] values)
    • addKeyword

      void addKeyword(String name, double value)
    • addKeyword

      void addKeyword(String name, Double value)
    • addKeyword

      void addKeyword(String name, double[] values)
    • addKeyword

      void addKeyword(String name, Double[] values)
    • addKeyword

      void addKeyword(String name, float value)
    • addKeyword

      void addKeyword(String name, Float value)
    • addKeyword

      void addKeyword(String name, float[] values)
    • addKeyword

      void addKeyword(String name, Float[] values)
    • addKeyword

      void addKeyword(String name, int value)
    • addKeyword

      void addKeyword(String name, int[] values)
    • addKeyword

      void addKeyword(String name, Integer value)
    • addKeyword

      void addKeyword(String name, Integer[] values)
    • addKeyword

      void addKeyword(String name, long value)
    • addKeyword

      void addKeyword(String name, Long value)
    • addKeyword

      void addKeyword(String name, long[] values)
    • addKeyword

      void addKeyword(String name, Long[] values)
    • addKeyword

      void addKeyword(String name, short value)
    • addKeyword

      void addKeyword(String name, Short value)
    • addKeyword

      void addKeyword(String name, short[] values)
    • addKeyword

      void addKeyword(String name, Short[] values)
    • addKeyword

      void addKeyword(String name, String value)
    • addKeyword

      void addKeyword(String name, String value, boolean lowerCase)
    • addKeyword

      void addKeyword(String name, String[] values)
    • addKeywordSortable

      void addKeywordSortable(String name, Boolean value)
    • addKeywordSortable

      void addKeywordSortable(String name, Boolean[] values)
    • addKeywordSortable

      void addKeywordSortable(String name, String value)
    • addKeywordSortable

      void addKeywordSortable(String name, String[] values)
    • addLocalizedKeyword

      void addLocalizedKeyword(String name, Map<Locale,String> values)
    • addLocalizedKeyword

      void addLocalizedKeyword(String name, Map<Locale,String> values, boolean lowerCase)
    • addLocalizedKeyword

      void addLocalizedKeyword(String name, Map<Locale,String> values, boolean lowerCase, boolean sortable)
    • addLocalizedText

      void addLocalizedText(String name, Map<Locale,String> values)
    • addLocalizedText

      void addLocalizedText(String name, Map<Locale,String> values, boolean sortable)
    • addNumber

      void addNumber(String name, BigDecimal value)
    • addNumber

      void addNumber(String name, BigDecimal[] values)
    • addNumber

      void addNumber(String name, double value)
    • addNumber

      void addNumber(String name, Double value)
    • addNumber

      void addNumber(String name, double[] values)
    • addNumber

      void addNumber(String name, Double[] values)
    • addNumber

      void addNumber(String name, float value)
    • addNumber

      void addNumber(String name, Float value)
    • addNumber

      void addNumber(String name, float[] values)
    • addNumber

      void addNumber(String name, Float[] values)
    • addNumber

      void addNumber(String name, int value)
    • addNumber

      void addNumber(String name, int[] values)
    • addNumber

      void addNumber(String name, Integer value)
    • addNumber

      void addNumber(String name, Integer[] values)
    • addNumber

      void addNumber(String name, long value)
    • addNumber

      void addNumber(String name, Long value)
    • addNumber

      void addNumber(String name, long[] values)
    • addNumber

      void addNumber(String name, Long[] values)
    • addNumber

      void addNumber(String name, String value)
    • addNumber

      void addNumber(String name, String[] values)
    • addNumberSortable

      void addNumberSortable(String name, BigDecimal value)
    • addNumberSortable

      void addNumberSortable(String name, BigDecimal[] values)
    • addNumberSortable

      void addNumberSortable(String name, Double value)
    • addNumberSortable

      void addNumberSortable(String name, Double[] values)
    • addNumberSortable

      void addNumberSortable(String name, Float value)
    • addNumberSortable

      void addNumberSortable(String name, Float[] values)
    • addNumberSortable

      void addNumberSortable(String name, Integer value)
    • addNumberSortable

      void addNumberSortable(String name, Integer[] values)
    • addNumberSortable

      void addNumberSortable(String name, Long value)
    • addNumberSortable

      void addNumberSortable(String name, Long[] values)
    • addText

      void addText(String name, String value)
    • addText

      void addText(String name, String[] values)
    • addTextSortable

      void addTextSortable(String name, String value)
    • addTextSortable

      void addTextSortable(String name, String[] values)
    • addUID

      void addUID(String portletId, long field1)
    • addUID

      void addUID(String portletId, long field1, String field2)
    • addUID

      void addUID(String portletId, Long field1)
    • addUID

      void addUID(String portletId, Long field1, String field2)
    • addUID

      void addUID(String portletId, String field1)
    • addUID

      void addUID(String portletId, String field1, String field2)
    • addUID

      void addUID(String portletId, String field1, String field2, String field3)
    • addUID

      void addUID(String portletId, String field1, String field2, String field3, String field4)
    • clone

      Object clone()
    • get

      String get(Locale locale, String name)
    • get

      String get(Locale locale, String name, String defaultName)
    • get

      String get(String name)
    • get

      String get(String name, String defaultName)
    • getDate

      Date getDate(String name) throws ParseException
      Throws:
      ParseException
    • getField

      Field getField(String name)
    • getFields

      Map<String,Field> getFields()
    • getPortletId

      String getPortletId()
    • getUID

      String getUID()
    • getValues

      String[] getValues(String name)
    • hasField

      boolean hasField(String name)
    • isDocumentSortableTextField

      boolean isDocumentSortableTextField(String name)
    • remove

      void remove(String name)
    • setSortableTextFields

      void setSortableTextFields(String[] sortableTextFields)