Liferay 6.2.0

com.liferay.portal.kernel.search
Interface Document

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

public interface Document
extends Cloneable, Serializable


Method Summary
abstract  void add(Field field)
           
abstract  void addDate(String name, Date value)
           
abstract  void addDate(String name, Date[] values)
           
abstract  void addDateSortable(String name, Date value)
           
abstract  void addDateSortable(String name, Date[] values)
           
abstract  void addFile(String name, byte[] bytes, String fileExt)
           
abstract  void addFile(String name, File file, String fileExt)
           
abstract  void addFile(String name, InputStream is, String fileExt)
           
abstract  void addFile(String name, InputStream is, String fileExt, int maxStringLength)
           
abstract  void addKeyword(String name, boolean value)
           
abstract  void addKeyword(String name, Boolean value)
           
abstract  void addKeyword(String name, boolean[] values)
           
abstract  void addKeyword(String name, Boolean[] values)
           
abstract  void addKeyword(String name, double value)
           
abstract  void addKeyword(String name, Double value)
           
abstract  void addKeyword(String name, double[] values)
           
abstract  void addKeyword(String name, Double[] values)
           
abstract  void addKeyword(String name, float value)
           
abstract  void addKeyword(String name, Float value)
           
abstract  void addKeyword(String name, float[] values)
           
abstract  void addKeyword(String name, Float[] values)
           
abstract  void addKeyword(String name, int value)
           
abstract  void addKeyword(String name, int[] values)
           
abstract  void addKeyword(String name, Integer value)
           
abstract  void addKeyword(String name, Integer[] values)
           
abstract  void addKeyword(String name, long value)
           
abstract  void addKeyword(String name, Long value)
           
abstract  void addKeyword(String name, long[] values)
           
abstract  void addKeyword(String name, Long[] values)
           
abstract  void addKeyword(String name, short value)
           
abstract  void addKeyword(String name, Short value)
           
abstract  void addKeyword(String name, short[] values)
           
abstract  void addKeyword(String name, Short[] values)
           
abstract  void addKeyword(String name, String value)
           
abstract  void addKeyword(String name, String[] values)
           
abstract  void addKeyword(String name, String value, boolean lowerCase)
           
abstract  void addKeywordSortable(String name, Boolean value)
           
abstract  void addKeywordSortable(String name, Boolean[] values)
           
abstract  void addKeywordSortable(String name, String value)
           
abstract  void addKeywordSortable(String name, String[] values)
           
abstract  void addLocalizedKeyword(String name, Map<Locale,String> values)
           
abstract  void addLocalizedKeyword(String name, Map<Locale,String> values, boolean lowerCase)
           
abstract  void addLocalizedKeyword(String name, Map<Locale,String> values, boolean lowerCase, boolean sortable)
           
abstract  void addLocalizedText(String name, Map<Locale,String> values)
           
abstract  void addModifiedDate()
          Deprecated. As of 6.1.0
abstract  void addModifiedDate(Date modifiedDate)
          Deprecated. As of 6.1.0
abstract  void addNumber(String name, double value)
           
abstract  void addNumber(String name, Double value)
           
abstract  void addNumber(String name, double[] values)
           
abstract  void addNumber(String name, Double[] values)
           
abstract  void addNumber(String name, float value)
           
abstract  void addNumber(String name, Float value)
           
abstract  void addNumber(String name, float[] values)
           
abstract  void addNumber(String name, Float[] values)
           
abstract  void addNumber(String name, int value)
           
abstract  void addNumber(String name, int[] values)
           
abstract  void addNumber(String name, Integer value)
           
abstract  void addNumber(String name, Integer[] values)
           
abstract  void addNumber(String name, long value)
           
abstract  void addNumber(String name, Long value)
           
abstract  void addNumber(String name, long[] values)
           
abstract  void addNumber(String name, Long[] values)
           
abstract  void addNumber(String name, String value)
           
abstract  void addNumber(String name, String[] values)
           
abstract  void addNumberSortable(String name, Double value)
           
abstract  void addNumberSortable(String name, Double[] values)
           
abstract  void addNumberSortable(String name, Float value)
           
abstract  void addNumberSortable(String name, Float[] values)
           
abstract  void addNumberSortable(String name, Integer value)
           
abstract  void addNumberSortable(String name, Integer[] values)
           
abstract  void addNumberSortable(String name, Long value)
           
abstract  void addNumberSortable(String name, Long[] values)
           
abstract  void addText(String name, String value)
           
abstract  void addText(String name, String[] values)
           
abstract  void addTextSortable(String name, String value)
           
abstract  void addTextSortable(String name, String[] values)
           
abstract  void addUID(String portletId, long field1)
           
abstract  void addUID(String portletId, Long field1)
           
abstract  void addUID(String portletId, long field1, String field2)
           
abstract  void addUID(String portletId, Long field1, String field2)
           
abstract  void addUID(String portletId, String field1)
           
abstract  void addUID(String portletId, String field1, String field2)
           
abstract  void addUID(String portletId, String field1, String field2, String field3)
           
abstract  void addUID(String portletId, String field1, String field2, String field3, String field4)
           
abstract  Object clone()
           
abstract  String get(Locale locale, String name)
           
abstract  String get(Locale locale, String name, String defaultName)
           
abstract  String get(String name)
           
abstract  String get(String name, String defaultName)
           
abstract  Date getDate(String name)
           
abstract  Field getField(String name)
           
abstract  Map<String,Field> getFields()
           
abstract  String getPortletId()
           
abstract  String getUID()
           
abstract  String[] getValues(String name)
           
abstract  boolean hasField(String name)
           
abstract  boolean isDocumentSortableTextField(String name)
           
abstract  void remove(String name)
           
abstract  void setSortableTextFields(String[] sortableTextFields)
           
 

Method Detail

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

void addFile(String name,
             byte[] bytes,
             String fileExt)
             throws IOException
Throws:
IOException

addFile

void addFile(String name,
             File file,
             String fileExt)
             throws IOException
Throws:
IOException

addFile

void addFile(String name,
             InputStream is,
             String fileExt)
             throws IOException
Throws:
IOException

addFile

void addFile(String name,
             InputStream is,
             String fileExt,
             int maxStringLength)
             throws IOException
Throws:
IOException

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)

addModifiedDate

void addModifiedDate()
Deprecated. As of 6.1.0


addModifiedDate

void addModifiedDate(Date modifiedDate)
Deprecated. As of 6.1.0


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,
                       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)

Liferay 6.2.0