Ir al contenido
Otras versiones

Cargando…

OKMSearch

Conceptos básicos

Sección titulada «Conceptos básicos»

Casi todos los métodos utilizan QueryParams. A continuación se ofrecen algunos consejos sobre cómo utilizarlo.

Variables Tipo Admite comodines Restricciones Descripción
domain long No. Valores disponibles:
- QueryParams.DOCUMENT
- QueryParams.FOLDER
- QueryParams.MAIL
- QueryParams.RECORD
Por defecto, el valor es QueryParams.DOCUMENT.
Para buscar documentos y carpetas, utilice el valor:
<br>(QueryParams.DOCUMENT | QueryParams.FOLDER) <br>		 Restringe la búsqueda a unos tipos de nodo.
author String No. El valor debe ser un userId válido. Filtra por usuario creador.
name String Sí. Filtra por nombre del nodo.
title String Sí. Filtra por título.
keywords Set Sí. Filtra por palabras clave.
categories Set No. Los valores deben ser el UUID de una categoría; no utilice la ruta. Filtra por categorías.
content Sí. Filtra por contenido binario.
mimeType No. El valor debe ser un tipo MIME válido y registrado.
Solo puede aplicarse a nodos de documento.		 Filtra por tipo MIME del documento.
language No. El valor debe ser un idioma válido.
Solo puede aplicarse a nodos de documento.		 Filtra por idioma del documento.
folder No. Si está vacío, se utiliza por defecto el nodo “/okm:root”.
El valor debe ser un UUID válido; no utilice una ruta.		 Filtra por una carpeta.
folderRecursive Boolean No. Solo tiene sentido establecer esta variable a true cuando la variable folder no está vacía. Habilita el filtrado recursivo por una carpeta.
lastModifiedFrom Calendar No. Filtra por nodos creados después de una fecha.
lastModifiedTo Calendar No. Filtra por nodos creados antes de una fecha.
mailSubject String Sí. Solo se aplica a nodos de correo. Filtra por el campo asunto del correo.
mailFrom String Sí. Solo se aplica a nodos de correo. Filtra por el campo remitente del correo.
mailTo Sí. Solo se aplica a nodos de correo. Filtra por el campo destinatario del correo.
notes Sí. Filtra por notas.
properties Map<String, String> Sí en casi todos. En valores de campos de metadatos como “date” no se pueden aplicar comodines.
El mapa de propiedades se compone de pares:
(‘metadata_field_name’,‘metadata_field_value’)
Por ejemplo:
javascript<br>Map<String, String> properties = new HashMap();<br>properties.put("okp:consulting.name", "name value");<br>
Filtrado por rango de fechas:
cs<br>Calendar to = Calendar.getInstance(); // today<br>to.set(0, Calendar.HOUR);<br>to.set(0, Calendar.MINUTE);<br>to.set(0, Calendar.SECOND);<br>to.set(0, Calendar.MILLISECOND);<br>Calendar from = (Calendar) to.clone();<br>from.add(-3, Calendar.DATE); // three days before<br>Map<String,String> properties = new HashMap<>();<br>properties.put("okp:consulting.date", ISO8601.formatBasic(from)+","+ISO8601.formatBasic(to));<br>
Al filtrar por un rango de fechas debe establecer ambos valores (desde y hasta); en caso contrario, OpenKM ignorará el filtro.
Para filtrar por un campo de metadatos de tipo multiple como este:
cs<br><select label="Multiple" name="okp:consulting.multiple" type="multiple"><br> <option label="One" value="one"/><br> <option label="Two" value="two"/><br> <option label="Three" value="three" /><br></select><br>
Debe hacer:
bash<br>properties.put("okp:consulting.multiple", "one;two");<br>
Donde “one” y “two” son valores válidos y el carácter “;” se utiliza como separador.		 Filtra por valores de grupos de metadatos.

Ejemplos de comodines:

Variable Ejemplo Descripción
name test*.html Cualquier documento que empiece por los caracteres “test” y termine con los caracteres “.html”
name test?.html Cualquier documento que empiece por los caracteres “test”, seguidos de un único carácter, y termine con los caracteres “.html”
name ?test* Cualquiera de los documentos en los que el primer carácter no importa, pero va seguido de los caracteres “test”.

Métodos

Sección titulada «Métodos»

find

Sección titulada «find»

Descripción:

Método Valores devueltos Descripción
find(String token, QueryParams params) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");


            for (QueryResult qr : okmSearch.find(null, qParams)) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

find

Sección titulada «find»

Descripción:

Método Valores devueltos Descripción
find(String token, QueryParams params, String propertiesPlugin) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");


            for (QueryResult qr : okmSearch.find(null, qParams, "com.openkm.plugin.properties.SimpleNodeProperties")) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

find

Sección titulada «find»

Descripción:

Método Valores devueltos Descripción
find(String token, QueryParams params, String propertiesPlugin) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");


            for (QueryResult qr : okmSearch.find(null, qParams, "name", true, "com.openkm.plugin.properties.SimpleNodeProperties")) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findPaginated

Sección titulada «findPaginated»

Descripción:

Método Valores devueltos Descripción
findPaginated(String token, QueryParams params, int offset, int limit) ResultSet Devuelve una lista paginada de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            ResultSet rs = okmSearch.findPaginated(null, qParams, 20, 10);
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findPaginated

Sección titulada «findPaginated»

Descripción:

Método Valores devueltos Descripción
findPaginated(String token, QueryParams params, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista paginada de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            ResultSet rs = okmSearch.findPaginated(null, qParams, 20, 10, "com.openkm.plugin.properties.SimpleNodeProperties");
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findPaginated

Sección titulada «findPaginated»

Descripción:

Método Valores devueltos Descripción
findPaginated(String token, QueryParams params, int offset, int limit) ResultSet Devuelve una lista paginada de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            ResultSet rs = okmSearch.findPaginated(null, qParams, "name", true, 20, 10);
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findPaginated

Sección titulada «findPaginated»

Descripción:

Método Valores devueltos Descripción
findPaginated(String token, QueryParams params, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista paginada de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            ResultSet rs = okmSearch.findPaginated(null, qParams, "name", true, 20, 10, "com.openkm.plugin.properties.SimpleNodeProperties");
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMetadata

Sección titulada «findWithMetadata»

Descripción:

Método Valores devueltos Descripción
findWithMetadata(String token, QueryParams params, String propertiesPlugin, List groups) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import java.util.ArrayList;
import java.util.List;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");


            List<String> groups = new ArrayList<>();
            groups.add("okg:tpl");


            for (QueryResult qr : okmSearch.findWithMetadata(null, qParams, "com.openkm.plugin.properties.SimpleNodeProperties",
                    groups)) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMetadata

Sección titulada «findWithMetadata»

Descripción:

Método Valores devueltos Descripción
findWithMetadata(String token, QueryParams params, String sortField, boolean sortReverse, String propertiesPlugin, List groups) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import java.util.ArrayList;
import java.util.List;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");


            List<String> groups = new ArrayList<>();
            groups.add("okg:tpl");


            for (QueryResult qr : okmSearch.findWithMetadata(null, qParams, "name", true, "com.openkm.plugin.properties.SimpleNodeProperties",
                    groups)) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMetadataPaginated

Sección titulada «findWithMetadataPaginated»

Descripción:

Método Valores devueltos Descripción
findWithMetadataPaginated(String token, QueryParams params, int offset, int limit, String propertiesPlugin, List groups) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import java.util.ArrayList;
import java.util.List;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");


            List<String> groups = new ArrayList<>();
            groups.add("okg:tpl");


            ResultSet rs = okmSearch.findWithMetadataPaginated(null, qParams, 0, 10, "com.openkm.plugin.properties.SimpleNodeProperties", groups);
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findWithMetadataPaginated

Sección titulada «findWithMetadataPaginated»

Descripción:

Método Valores devueltos Descripción
findWithMetadataPaginated(String token, QueryParams params, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin, List groups) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import java.util.ArrayList;
import java.util.List;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            String sortField = "okm:";
            boolean sortReverse = false;


            List<String> groups = new ArrayList<>();
            groups.add("okg:tpl");


            ResultSet rs = okmSearch.findWithMetadataPaginated(null, qParams, sortField, sortReverse, 20, 10, "com.openkm.plugin.properties.SimpleNodeProperties", groups);
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findSimpleNodeBasePaginated

Sección titulada «findSimpleNodeBasePaginated»

Descripción:

Método Valores devueltos Descripción
findSimpleNodeBasePaginated(String token, QueryParams params, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados de SimpleNodeBase filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.SimpleNodeBase;
import com.openkm.ws.rest.util.SimpleNodeBaseResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            SimpleNodeBaseResultSet resultSet = okmSearch.findSimpleNodeBasePaginated(null, qParams, "name", true, 0, 10);
            System.out.println("Total results:" + resultSet.getTotal());


            for (SimpleNodeBase simpleNodeBase : resultSet.getResults()) {
                System.out.println(simpleNodeBase);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQuery

Sección titulada «findByQuery»

Descripción:

Método Valores devueltos Descripción
findByName(String token, String words) List Devuelve una lista de resultados filtrados por el valor del parámetro name. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (QueryResult qr : okmSearch.findByQuery(null, "text:grial AND name:o*.pdf")) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQuery

Sección titulada «findByQuery»

Descripción:

Método Valores devueltos Descripción
findByQuery(String token, String query, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por el valor del parámetro query. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (QueryResult qr : okmSearch.findByQuery(null, "text:grial AND name:o*.pdf",
                    "com.openkm.plugin.properties.SimpleNodeProperties")) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQuery

Sección titulada «findByQuery»

Descripción:

Método Valores devueltos Descripción
findByQuery(String token, String query, String sortField, boolean sortReverse, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por el valor del parámetro query. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (QueryResult qr : okmSearch.findByQuery(null, "text:grial AND name:o*.pdf", "name", true, "com.openkm.plugin.properties.SimpleNodeProperties")) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQueryPaginated

Sección titulada «findByQueryPaginated»

Descripción:

Método Valores devueltos Descripción
findSimpleQueryPaginated(String token, String statement, int offset, int limit) ResultSet Devuelve una lista paginada de resultados filtrados por los valores del parámetro statement.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            ResultSet rs = okmSearch.findByQueryPaginated(null, "text:grial AND name:o*.pdf", 10, 10);
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQueryPaginated

Sección titulada «findByQueryPaginated»

Descripción:

Método Valores devueltos Descripción
findPaginated(String token, QueryParams params, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista paginada de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            ResultSet rs = okmSearch.findByQueryPaginated(null, "text:grial AND name:o*.pdf", 0, 10,
                    "com.openkm.plugin.properties.SimpleNodeProperties");
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByQueryPaginated

Sección titulada «findByQueryPaginated»

Descripción:

Método Valores devueltos Descripción
findPaginated(String token, QueryParams params, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista paginada de resultados filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            ResultSet rs = okmSearch.findByQueryPaginated(null, "text:grial AND name:o*.pdf", "name", true, 0, 10,
                    "com.openkm.plugin.properties.SimpleNodeProperties");
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findSimpleNodeBaseByQueryPaginated

Sección titulada «findSimpleNodeBaseByQueryPaginated»

Descripción:

Método Valores devueltos Descripción
findSimpleNodeBaseByQueryPaginated(String token, String query, String sortField, boolean sortReverse, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados de SimpleNodeBase filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.SimpleNodeBase;
import com.openkm.ws.rest.util.SimpleNodeBaseResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");
            SimpleNodeBaseResultSet resultSet = okmSearch.findSimpleNodeBasePaginated(null, qParams, "name", true, 0, 10);
            System.out.println("Total results:" + resultSet.getTotal());


            for (SimpleNodeBase simpleNodeBase : resultSet.getResults()) {
                System.out.println(simpleNodeBase);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

saveSearch

Sección titulada «saveSearch»

Descripción:

Método Valores devueltos Descripción
saveSearch(String token, QueryParams params) Long Guarda los parámetros de una búsqueda. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            QueryParams qParams = new QueryParams();
            qParams.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            qParams.setName("test*");


            // Save the search to be used later
            qParams.setQueryName("sample search");
            okmSearch.saveSearch(null, qParams);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateSearch

Sección titulada «updateSearch»

Descripción:

Método Valores devueltos Descripción
updateSearch(String token, QueryParams params) void Guarda los parámetros de una búsqueda. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (QueryParams qParams : okmSearch.getAllSearches(null)) {
                if (qParams.getQueryName().equals("sample search")) {
                    // Change some value.
                    qParams.setName("admin*.html");
                    okmSearch.updateSearch(null, qParams);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSearch

Sección titulada «getSearch»

Descripción:

Método Valores devueltos Descripción
getSearch(String token, int qpId) QueryParams Obtiene los parámetros de una búsqueda guardada. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            int qpId = 1; // Some valid search id
            QueryParams qParams = okmSearch.getSearch(null, qpId);
            System.out.println(qParams);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllSearches

Sección titulada «getAllSearches»

Descripción:

Método Valores devueltos Descripción
getAllSearchs(String token) List Recupera una lista con los parámetros de todas las búsquedas guardadas. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (QueryParams qParams : okmSearch.getAllSearches(null)) {
                System.out.println(qParams);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteSearch

Sección titulada «deleteSearch»

Descripción:

Método Valores devueltos Descripción
deleteSearch(String token, long qpId) void Elimina los parámetros de una búsqueda guardada. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            int qpId = 1; // Some valid search id
            okmSearch.deleteSearch(null, qpId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getKeywordMap

Sección titulada «getKeywordMap»

Descripción:

Método Valores devueltos Descripción
getKeywordMap(String token, List filter) Map<String, Integer> Devuelve un mapa de palabras clave con su contador, filtrado por otras palabras clave. 
package com.openkm;


import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;


import com.openkm.api.OKMSearch;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            // All keywords without filtering
            System.out.println("Without filtering");
            Map<String, Integer> keywords = okmSearch.getKeywordMap(null, new ArrayList<String>());


            for (String key : keywords.keySet()) {
                System.out.println(key + " is used :" + keywords.get(key));
            }


            // Keywords filtered
            System.out.println("Filtering");
            keywords = okmSearch.getKeywordMap(null, Arrays.asList("test"));


            for (String key : keywords.keySet()) {
                System.out.println(key + " is used :" + keywords.get(key));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getCategorizedDocuments

Sección titulada «getCategorizedDocuments»

Descripción:

Método Valores devueltos Descripción
getCategorizedDocuments(String token, String categoryId) List Recupera una lista de todos los documentos relacionados con una categoría. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Document;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Document doc : okmSearch.getCategorizedDocuments(null, "5cbc35fc-23c0-48f5-a7bc-3cfa1e7be25f")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getCategorizedFolders

Sección titulada «getCategorizedFolders»

Descripción:

Método Valores devueltos Descripción
getCategorizedFolders(String token, String categoryId) List Recupera una lista de todas las carpetas relacionadas con una categoría. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Folder fld : okmSearch.getCategorizedFolders(null, "5cbc35fc-23c0-48f5-a7bc-3cfa1e7be25f")) {
                System.out.println(fld);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getCategorizedMails

Sección titulada «getCategorizedMails»

Descripción:

Método Valores devueltos Descripción
getCategorizedMails(String token, String categoryId) List Recupera una lista de todos los correos relacionados con una categoría. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Mail;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Mail mail : okmSearch.getCategorizedMails(null, "5cbc35fc-23c0-48f5-a7bc-3cfa1e7be25f")) {
                System.out.println(mail);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getCategorizedRecords

Sección titulada «getCategorizedRecords»

Descripción:

Método Valores devueltos Descripción
getCategorizedRecords(String token, String categoryId) List Recupera una lista de todos los registros relacionados con una categoría. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Record;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Record rec : okmSearch.getCategorizedRecords(null, "5cbc35fc-23c0-48f5-a7bc-3cfa1e7be25f")) {
                System.out.println(rec);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getDocumentsByKeyword

Sección titulada «getDocumentsByKeyword»

Descripción:

Método Valores devueltos Descripción
getDocumentsByKeyword(String token, String keyword) List Recupera una lista de todos los documentos relacionados con una palabra clave. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Document;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Document doc : okmSearch.getDocumentsByKeyword(null, "test")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFoldersByKeyword

Sección titulada «getFoldersByKeyword»

Descripción:

Método Valores devueltos Descripción
getFoldersByKeyword(String token, String keyword) List Recupera una lista de todas las carpetas relacionadas con una palabra clave. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Folder fld : okmSearch.getFoldersByKeyword(null, "test")) {
                System.out.println(fld);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMailsByKeyword

Sección titulada «getMailsByKeyword»

Descripción:

Método Valores devueltos Descripción
getMailsByKeyword(String token, String keyword) List Recupera una lista de todos los correos relacionados con una palabra clave. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Mail;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Mail mail : okmSearch.getMailsByKeyword(null, "test")) {
                System.out.println(mail);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordsByKeyword

Sección titulada «getRecordsByKeyword»

Descripción:

Método Valores devueltos Descripción
getRecordsByKeyword(String token, String keyword) List Recupera una lista de todos los registros relacionados con una palabra clave. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Record;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Record rec : okmSearch.getRecordsByKeyword(null, "test")) {
                System.out.println(rec);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getDocumentsByPropertyValue

Sección titulada «getDocumentsByPropertyValue»

Descripción:

Método Valores devueltos Descripción
getDocumentsByPropertyValue(String token, String group, String property, String value List Recupera una lista de todos los documentos relacionados con el valor de un campo de metadatos. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Document;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Document doc : okmSearch.getDocumentsByPropertyValue(null, "okg:consulting", "okp:consulting.name", "value")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFoldersByPropertyValue

Sección titulada «getFoldersByPropertyValue»

Descripción:

Método Valores devueltos Descripción
getFoldersByPropertyValue(String token, String group, String property, String value List Recupera una lista de todas las carpetas relacionadas con el valor de un campo de metadatos. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Folder fld : okmSearch.getFoldersByPropertyValue(null, "okg:consulting", "okp:consulting.name", "value")) {
                System.out.println(fld);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getMailsByPropertyValue

Sección titulada «getMailsByPropertyValue»

Descripción:

Método Valores devueltos Descripción
getMailsByPropertyValue(String token, String group, String property, String value List Recupera una lista de todos los correos relacionados con el valor de un campo de metadatos. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Mail;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Mail mail : okmSearch.getMailsByPropertyValue(null, "okg:consulting", "okp:consulting.name", "value")) {
                System.out.println(mail);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordsByPropertyValue

Sección titulada «getRecordsByPropertyValue»

Descripción:

Método Valores devueltos Descripción
getRecordsByPropertyValue(String token, String group, String property, String value List Recupera una lista de todos los registros relacionados con el valor de un campo de metadatos. 
package com.openkm;


import com.openkm.api.OKMSearch;
import com.openkm.bean.Record;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            for (Record rec : okmSearch.getRecordsByPropertyValue(null, "okg:consulting", "okp:consulting.name", "value")) {
                System.out.println(rec);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findMailPaginated

Sección titulada «findMailPaginated»

Descripción:

Método Valores devueltos Descripción
findMailPaginated(String token, Map<String, String> filter, String sortField, boolean sortReverse, int type,
            int offset, int limit)		 ResultSet Devuelve una lista paginada de resultados de correo filtrados por los valores de los parámetros. 
package com.openkm;


import java.util.HashMap;
import java.util.Map;


import com.openkm.api.OKMSearch;
import com.openkm.bean.QueryResult;
import com.openkm.bean.ResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMSearch okmSearch = ContextWrapper.getContext().getBean(OKMSearch.class);
            Map<String, String> filter = new HashMap<>();
            String sortField = "okm:";
            int type = OKMSearch.TYPE_MAIL_ALL;
            ResultSet rs = okmSearch.findMailPaginated(null, filter, sortField, false, type, 0, 10);
            System.out.println("Total results:" + rs.getTotal());


            for (QueryResult qr : rs.getResults()) {
                System.out.println(qr);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

csvExport

Sección titulada «csvExport»

Descripción:

Método Valores devueltos Descripción
csvExport(String token, String lang, QueryParams params, boolean compact, Ref fileName) InputStream Exporta una lista de resultados como CSV filtrados por los valores del parámetro queryParams.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;
import com.openkm.sdk4j.impl.OKMWebservices;
import org.apache.commons.io.IOUtils;


import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            QueryParams params = new QueryParams();
            params.setDomain(QueryParams.DOCUMENT + QueryParams.FOLDER);
            params.setName("test*");


            Ref fileName = new Ref<>("export.csv");
            InputStream is = ws.search.csvExport(null, "es-ES", params, false, fileName);
            // Or you can use the deprecated method directly with the filename
            OutputStream fos = new FileOutputStream("/home/openkm/okm/export.csv");
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}