OKMTask

Fundamentos

Descripción de los campos de Task:

Campo	Tipo	Descripción	Obligatorio
Id	Long	Id interno de la tarea. Lo establece automáticamente la aplicación.	No aplicable.
Owner	String	Contiene el userId de OpenKM. Lo establece automáticamente la aplicación.	No aplicable.
Subject	String	El asunto de la tarea.	Sí.
Description	String	La descripción de la tarea.	No.
Start	Calendar	Cuándo puede empezar la tarea.	Sí.
End	Calendar	Cuándo puede terminar la tarea.	No.
Status	TaskStatus	El estado de la tarea. Usted administra la lista de valores de estado.	Sí.
Project	TaskProject	El proyecto relacionado con la tarea. Usted administra la lista de valores de proyecto.	Sí.
Type	TaskType	El tipo de tarea. Usted administra la lista de valores de tipo de tarea.	Sí.
Progress	Integer	El estado numérico de progreso. El rango de valores permitidos va de 0 a 100, donde 100% indica una tarea completada.	Sí.
RepeatGroup	Long	Cuando una tarea se repite a lo largo del tiempo, pertenece a un grupo. El grupo se identifica mediante un id de grupo de repetición único.	No.
ReminderStartValue	Integer	Cuántos días antes de que empiece la tarea el sistema puede enviar una notificación por correo al usuario.	No.
ReminderEndValue	Integer	Cuántos días antes de que termine la tarea el sistema puede enviar una notificación por correo al usuario.	No.
ReminderStartUnit	String	Unidades de inicio del recordatorio. Valores permitidos: - “m” para minutos. - “h” para horas. - “d” para días.	Obligatorio cuando ReminderStartValue es mayor que 0.
ReminderEndUnit	String	Unidades de fin del recordatorio. Valores permitidos: - “m” para minutos. - “h” para horas. - “d” para días.	Obligatorio cuando ReminderEndValue es mayor que 0.
Users	Set	Colección de usuarios asignados a la tarea.	No. Pero debe asignarse al menos un usuario o rol.
Roles	Set	Colección de roles asignados a la tarea.	No. Pero debe asignarse al menos un usuario o rol.
Documents	Set	Lista de UUID de los documentos relacionados.	No.
Folders	Set	Lista de UUID de las carpetas relacionadas.	No.
Mails	Set	Lista de UUID de los correos relacionados.	No.
Records	Set	Lista de UUID de los expedientes relacionados.	No.

En todos los métodos hay un parámetro llamado “token”. Al acceder a la aplicación vía REST, el proceso de login devuelve un token. El token se usa para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución de la aplicación por defecto debe usar el valor “null”, que indica que la aplicación debe usar la “sesión de usuario”.

Consejo

En casos especiales, puede ser “promovido a Administrador” usando el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Métodos

create

Descripción:

Método	Valores de retorno	Descripción
create(String token, Task task)	Task	Crea una nueva tarea.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.bean.TaskProject;
import com.openkm.bean.TaskStatus;
import com.openkm.bean.TaskType;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            Task task = new Task();
            task.setSubject("task subject");
            task.setDescription("description");
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, 15);
            task.setStart(start);
            long taskStatusId = 1; // A valid task status id
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            TaskStatus status = okmTask.findStatus(null, taskStatusId);
            TaskProject project = okmTask.findProject(null, projectId);
            TaskType type = okmTask.findType(null, typeId);
            task.setStatus(status);
            task.setProject(project);
            task.setType(type);
            task.setProgress(0);
            okmTask.create(null, task);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

update

Descripción:

Método	Valores de retorno	Descripción
update(String token, Task task)	Task	Actualiza una tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long taskId = 1; // A valid task id
            Task task = okmTask.find(null, taskId);
            task.setSubject("subject modified");
            okmTask.update(null, task);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

find

Descripción:

Método	Valores de retorno	Descripción
find(String token, long taskId)	Task	Busca una tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long taskId = 1; // A valid task id
            Task task = okmTask.find(null, taskId);
            System.out.println(task);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

delete

Descripción:

Método	Valores de retorno	Descripción
delete(String token, long taskId)	void	Elimina una tarea.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long taskId = 1; // A valid task id
            okmTask.delete(null, taskId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getByProject

Descripción:

Método	Valores de retorno	Descripción
getByProject(String token, long projectId)	List	Recupera una lista de tareas relacionadas con un proyecto.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            for (Task task : okmTask.getByProject(null, projectId)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getByType

Descripción:

Método	Valores de retorno	Descripción
getByType(String token, long typeId)	List	Recupera una lista de tareas relacionadas con un tipo de tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long typeId = 1; // A valid type id
            for (Task task : okmTask.getByType(null, typeId)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAssigned

Descripción:

Método	Valores de retorno	Descripción
getAssigned(String token, long projectId, long typeId, long statusId, String orderColumn)	List	Recupera una lista de tareas asignadas a un usuario y filtradas.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros usados habitualmente son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "subject"; // A valid TaskManagerTask class parameter name used in HQL query
            for (Task task : okmTask.getAssigned(null, projectId, typeId, statusId, orderColumn)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAssigned

Descripción:

Método	Valores de retorno	Descripción
getAssigned(String token, long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit)	List	Recupera una lista de tareas asignadas a un usuario, filtradas y paginadas.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros usados habitualmente son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.
• El parámetro orderAsc ordena de forma ascendente o descendente.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "start"; // A valid TaskManagerTask class parameter name used in HQL query
            for (Task task : okmTask.getAssigned(null, projectId, typeId, statusId, orderColumn, true, 0, 10)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

countAssigned

Descripción:

Método	Valores de retorno	Descripción
countAssigned(String token, long projectId, long typeId, long statusId)	Long	Devuelve el número de tareas asignadas a un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = okmTask.countAssigned(null, projectId, typeId, statusId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getActive

Descripción:

Método	Valores de retorno	Descripción
getActive(String token, long projectId, long typeId, long statusId, String orderColumn)	List	Recupera una lista de tareas activas asignadas a un usuario y filtradas.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros usados habitualmente son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "start"; // A valid TaskManagerTask class parameter name used in HQL query
            for (Task task : okmTask.getActive(null, projectId, typeId, statusId, orderColumn)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getActive

Descripción:

Método	Valores de retorno	Descripción
getActive(String token, long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit)	List	Recupera una lista de tareas activas asignadas a un usuario, filtradas y paginadas.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros usados habitualmente son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.
• El parámetro orderAsc ordena de forma ascendente o descendente.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "start"; // A valid TaskManagerTask class parameter name used in HQL query
            for (Task task : okmTask.getActive(null, projectId, typeId, statusId, orderColumn, true, 0, 10)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

countActive

Descripción:

Método	Valores de retorno	Descripción
countActive(String token, long projectId, long typeId, long statusId)	Long	Devuelve el número de tareas activas de un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = okmTask.countActive(null, projectId, typeId, statusId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFinished

Descripción:

Método	Valores de retorno	Descripción
getFinished(String token, long projectId, long typeId, long statusId, String orderColumn)	List	Recupera una lista de tareas finalizadas asignadas a un usuario y filtradas.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros usados habitualmente son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "start"; // A valid TaskManagerTask class parameter name used in HQL query
            for (Task task : okmTask.getFinished(null, projectId, typeId, statusId, orderColumn)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFinished

Descripción:

Método	Valores de retorno	Descripción
getFinished(String token, long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit)	List	Recupera una lista de tareas finalizadas asignadas a un usuario, filtradas y paginadas.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros usados habitualmente son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.
• El parámetro orderAsc ordena de forma ascendente o descendente.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "start"; // A valid TaskManagerTask class parameter name used in HQL query
            for (Task task : okmTask.getFinished(null, projectId, typeId, statusId, orderColumn, true, 0, 10)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

countFinished

Descripción:

Método	Valores de retorno	Descripción
countFinished(String token, long projectId, long typeId, long statusId)	Long	Devuelve el número de tareas finalizadas de un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = okmTask.countFinished(null, projectId, typeId, statusId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findStatus

Descripción:

Método	Valores de retorno	Descripción
findStatus(String token, long statusId)	TaskStatus	Devuelve un objeto de estado de tarea por id.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskStatus;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long statusId = 1; // A valid status id
            TaskStatus ts = okmTask.findStatus(null, statusId);
            System.out.println(ts);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findProject

Descripción:

Método	Valores de retorno	Descripción
findProject(String token, long projectId)	TaskProject	Devuelve un objeto de proyecto de tarea por id.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskProject;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            TaskProject tp = okmTask.findProject(null, projectId);
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findType

Descripción:

Método	Valores de retorno	Descripción
findType(String token, long typeId)	TaskType	Devuelve un objeto de tipo de tarea por id.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskType;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long typeId = 1; // A valid type id
            TaskType tt = okmTask.findType(null, typeId);
            System.out.println(tt);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findNote

Descripción:

Método	Valores de retorno	Descripción
findNote(String token, long noteId)	TaskNote	Devuelve un objeto de nota de tarea por id.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskNote;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long noteId = 2; // A valid note id
            TaskNote tn = okmTask.findNote(null, noteId);
            System.out.println(tn);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getStatuses

Descripción:

Método	Valores de retorno	Descripción
getStatuses(String token)	List	Recupera una lista de todos los estados de tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskStatus;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            for (TaskStatus ts : okmTask.getStatuses(null)) {
                System.out.println(ts);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProjects

Descripción:

Método	Valores de retorno	Descripción
getProjects(String token, boolean filterByActive)	List	Recupera una lista de todos los proyectos de tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskProject;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            for (TaskProject tp : okmTask.getProjects(null, true)) {
                System.out.println(tp);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTypes

Descripción:

Método	Valores de retorno	Descripción
getTypes(String token, boolean filterByActive)	List	Recupera una lista de todos los tipos de tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskType;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            for (TaskType tt : okmTask.getTypes(null, true)) {
                System.out.println(tt);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNotes

Descripción:

Método	Valores de retorno	Descripción
getNotes(String token, long taskId)	List	Recupera una lista de todas las notas de una tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskNote;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long taskId = 1; // A valid task id
            for (TaskNote tn : okmTask.getNotes(null, taskId)) {
                System.out.println(tn);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createStatus

Descripción:

Método	Valores de retorno	Descripción
createStatus(String token, String name, boolean finish)	TaskStatus	Crea un nuevo estado de tarea.

Nota

Según su lógica, varios estados pueden ser estados finales. Por ejemplo, estados llamados “closed” o “cancelled”. El parámetro booleano “finish” indica si su estado es un estado final.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskStatus;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            TaskStatus ts = okmTask.createStatus(null, "cancelled", true);
            System.out.println(ts);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createProject

Descripción:

Método	Valores de retorno	Descripción
createProject(String token, String name, String description, boolean active)	TaskProject	Crea un nuevo proyecto de tarea.

Nota

El parámetro booleano “active” indica si su proyecto está activo o no.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskProject;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            TaskProject tp = okmTask.createProject(null, "Project one", "Description", true);
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createType

Descripción:

Método	Valores de retorno	Descripción
createType(String token, String name, String description, boolean active)	TaskType	Crea un nuevo tipo de tarea.

Nota

El parámetro booleano “active” indica si su tipo está activo o no.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskType;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            TaskType tt = okmTask.createType(null, "Type one", "Description", true);
            System.out.println(tt);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createNote

Descripción:

Método	Valores de retorno	Descripción
createNote(String token, long taskId, String text)	TaskNote	Crea una nueva nota en una tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskNote;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long taskId = 1; // A valid task id
            TaskNote tn = okmTask.createNote(null, taskId, "New note");
            System.out.println(tn);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateStatus

Descripción:

Método	Valores de retorno	Descripción
updateStatus(String token, long id, String name, boolean finish)	TaskStatus	Actualiza un estado de tarea.

Nota

Según su lógica, varios estados pueden ser estados finales. Por ejemplo, estados llamados “closed” o “cancelled”. El parámetro booleano “finish” indica si su estado es un estado final.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskStatus;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long statusId = 1; // A valid task id
            TaskStatus ts = okmTask.findStatus(null, statusId);
            System.out.println(ts);
            ts = okmTask.updateStatus(null, statusId, "cancelled", true);
            System.out.println(ts);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateProject

Descripción:

Método	Valores de retorno	Descripción
updateProject(String token, long id, String name, String description, boolean active)	TaskProject	Actualiza un proyecto de tarea.

Nota

El parámetro booleano “active” indica si su proyecto está activo o no.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskProject;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 4; // A valid project id
            TaskProject tp = okmTask.findProject(null, projectId);
            System.out.println(tp);
            tp = okmTask.updateProject(null, projectId, "cancelled", "Description", false);
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateType

Descripción:

Método	Valores de retorno	Descripción
updateType(String token, long id, String name, String description, boolean active)	TaskType	Actualiza un tipo de tarea.

Nota

El parámetro booleano “active” indica si su tipo está activo o no.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskType;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long typeId = 4; // A valid type id
            TaskType tp = okmTask.findType(null, typeId);
            System.out.println(tp);
            tp = okmTask.updateType(null, typeId, "Type one", "Description", false);
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateNote

Descripción:

Método	Valores de retorno	Descripción
updateNote(String token, long id, String text)	TaskNote	Actualiza la nota de una tarea.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskNote;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long noteId = 1; // A valid note id
            TaskNote tn = okmTask.updateNote(null, noteId, "Note updated");
            System.out.println(tn);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteStatus

Descripción:

Método	Valores de retorno	Descripción
deleteStatus(String token, long statusId)	void	Elimina un estado de tarea.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long statusId = 4; // A valid status id
            okmTask.deleteStatus(null, statusId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteProject

Descripción:

Método	Valores de retorno	Descripción
deleteProject(String token, long projectId)	void	Elimina un proyecto de tarea.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 5; // A valid project id
            okmTask.deleteProject(null, projectId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteType

Descripción:

Método	Valores de retorno	Descripción
deleteType(String token, long typeId)	void	Elimina un tipo de tarea.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long typeId = 4; // A valid type id
            okmTask.deleteType(null, typeId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteNote

Descripción:

Método	Valores de retorno	Descripción
deleteNote(String token, long noteId)	void	Elimina una nota de una tarea.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long noteId = 1; // A valid note id
            okmTask.deleteNote(null, noteId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getByNode

Descripción:

Método	Valores de retorno	Descripción
getByNode(String token, String nodeUuid)	List	Devuelve la lista de tareas asignadas a un nodo concreto.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String uuid = "d168924d-e801-426d-a222-00124a1461bd"; // A valid uuid
            for (Task task : okmTask.getByNode(null, uuid)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getHistory

Descripción:

Método	Valores de retorno	Descripción
getHistory(String token, long taskId)	List	Devuelve el historial de una tarea concreta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.TaskHistory;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long taskId = 1; // A valid task id
            for (TaskHistory taskHistory : okmTask.getHistory(null, taskId)) {
                System.out.println(taskHistory);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAssigned

Descripción:

Método	Valores de retorno	Descripción
getAssigned(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end, String orderColumn, boolean orderAsc, int offset, int limit)	TaskList	Recupera una lista de tareas asignadas a un usuario, filtradas y paginadas.

Nota

Descripción de los parámetros de filtro:

• El parámetro subject es el asunto de la tarea.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• The orderColumn parameter must be a valid parameter of the TaskManagerTask class. Commonly used parameters are “subject”, “start”, “end”, “progress”, “owner”. More information at javadoc documentation.
• El parámetro orderAsc ordena de forma ascendente o descendente.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.TaskList;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "subject"; // A valid TaskManagerTask class parameter name used in HQL query
            boolean orderAsc = true;
            int offset = 0;
            int limit = 10;
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();

            TaskList taskList = okmTask.getAssigned(null, subject, 10, projectId, typeId, statusId, lastModified, start, end,
                    orderColumn, orderAsc, offset, limit);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

countAssigned

Descripción:

Método	Valores de retorno	Descripción
countAssigned(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end)	long	Devuelve el número de tareas asignadas a un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro subject es el asunto de la tarea.
• El parámetro progress es el progreso de la tarea.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

Ejemplo:

package com.openkm;

import java.util.Calendar;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            int progress = 10;
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();

            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);

            Calendar end = Calendar.getInstance();

            long total = okmTask.countAssigned(null, subject, progress, projectId, typeId, statusId, lastModified, start, end);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getActive

Descripción:

Método	Valores de retorno	Descripción
getActive(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end, String orderColumn, boolean orderAsc, int offset, int limit)	TaskList	Recupera una lista de tareas activas asignadas a un usuario, filtradas y paginadas.

Nota

Descripción de los parámetros de filtro:

• El parámetro subject es el asunto de la tarea.
• El parámetro progress es el progreso de la tarea.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• The orderColumn parameter must be a valid parameter of the TaskManagerTask class. Commonly used parameters are “subject”, “start”, “end”, “progress”, “owner”. More information at javadoc documentation.
• El parámetro orderAsc ordena de forma ascendente o descendente.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.TaskList;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "progress"; // A valid TaskManagerTask class parameter name used in HQL query
            boolean orderAsc = true;
            int offset = 0;
            int limit = 10;
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();

            TaskList taskList = okmTask.getActive(null, subject, 10, projectId, typeId, statusId, lastModified, start, end,
                    orderColumn, orderAsc, offset, limit);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

countActive

Descripción:

Método	Valores de retorno	Descripción
countActive(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end)	long	Devuelve el número de tareas activas de un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro subject es el asunto de la tarea.
• El parámetro progress es el progreso de la tarea.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

Ejemplo:

package com.openkm;

import java.util.Calendar;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            int progress = 10;
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();

            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);

            Calendar end = Calendar.getInstance();

            long total = okmTask.countActive(null, subject, progress, projectId, typeId, statusId, lastModified, start, end);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFinished

Descripción:

Método	Valores de retorno	Descripción
getFinished(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end, String orderColumn, boolean orderAsc, int offset, int limit)	TaskList	Recupera una lista de tareas finalizadas asignadas a un usuario, filtradas y paginadas.

Nota

Descripción de los parámetros de filtro:

• El parámetro subject es el asunto de la tarea.
• El parámetro progress es el progreso de la tarea.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• The orderColumn parameter must be a valid parameter of the TaskManagerTask class. Commonly used parameters are “subject”, “start”, “end”, “progress”, “owner”. More information at javadoc documentation.
• El parámetro orderAsc ordena de forma ascendente o descendente.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.TaskList;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "end"; // A valid TaskManagerTask class parameter name used in HQL query
            boolean orderAsc = true;
            int offset = 0;
            int limit = 10;
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();

            TaskList taskList = okmTask.getFinished(null, subject, 10, projectId, typeId, statusId, lastModified, start, end,
                    orderColumn, orderAsc, offset, limit);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

countFinished

Descripción:

Método	Valores de retorno	Descripción
countFinished(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end)	long	Devuelve el número de tareas finalizadas de un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro subject es el asunto de la tarea.
• El parámetro progress es el progreso de la tarea.
• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

Ejemplo:

package com.openkm;

import java.util.Calendar;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            int progress = 10;
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();

            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);

            Calendar end = Calendar.getInstance();

            long total = okmTask.countFinished(null, subject, progress, projectId, typeId, statusId, lastModified, start, end);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAssignedCount

Descripción:

Método	Valores de retorno	Descripción
getAssignedCount(String token, long projectId, long typeId, long statusId)	long	Devuelve el número de tareas asignadas a un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id

            long total = okmTask.getAssignedCount(null, projectId, typeId, statusId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getActiveCount

Descripción:

Método	Valores de retorno	Descripción
getActiveCount(String token, long projectId, long typeId, long statusId)	Long	Devuelve el número de tareas activas de un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id

            long total = okmTask.getActiveCount(null, projectId, typeId, statusId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNotified

Descripción:

Método	Valores de retorno	Descripción
getNotified(String token, long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit)	List	Recupera una lista de tareas notificadas asignadas a un usuario, paginadas.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.
• El parámetro statusId debe ser un id de estado válido.
• The orderColumn parameter must be a valid parameter of the TaskManagerTask class. Commonly used parameters are “subject”, “start”, “end”, “progress”, “owner”. More information at javadoc documentation.
• El parámetro orderAsc ordena de forma ascendente o descendente.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” especifica cuántos resultados omitir antes de empezar a devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20; debe usar estos valores:

• limit=10
• offset=10

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            String orderColumn = "start"; // A valid TaskManagerTask class parameter name used in HQL query
            for (Task task : okmTask.getNotified(null, projectId, typeId, statusId, orderColumn, true, 0, 10)) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFinishedCount

Descripción:

Método	Valores de retorno	Descripción
getFinishedCount(String token, long projectId, long typeId, long statusId)	Long	Devuelve el número de tareas finalizadas de un usuario.

Nota

Descripción de los parámetros de filtro:

• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id

            long total = okmTask.getFinishedCount(null, projectId, typeId, statusId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNotified

Descripción:

Método	Valores de retorno	Descripción
getNotified(String token, long projectId, long typeId, long statusId, String orderColumn)	List	Recupera una lista de tareas sobre las que se notifica al usuario, filtradas (sin paginación).

Ejemplo:

package com.openkm;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            for (Task task : okmTask.getNotified(null, projectId, typeId, statusId, "subject")) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNotified

Descripción:

Método	Valores de retorno	Descripción
getNotified(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end, String orderColumn, boolean orderAsc, int offset, int limit)	TaskList	Recupera una lista de tareas sobre las que se notifica al usuario, con filtrado completo y paginación.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.TaskList;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();

            TaskList taskList = okmTask.getNotified(null, subject, 10, projectId, typeId, statusId,
                    lastModified, start, end, "subject", true, 0, 10);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNotified

Descripción:

Método	Valores de retorno	Descripción
getNotified(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end, Calendar from, Calendar to, String orderColumn, boolean orderAsc, int offset, int limit)	TaskList	Recupera una lista de tareas sobre las que se notifica al usuario, con filtrado completo incluyendo el rango de fechas de creación (from/to) y paginación.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.TaskList;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();
            Calendar from = Calendar.getInstance();
            from.add(Calendar.MONTH, -1);
            Calendar to = Calendar.getInstance();

            TaskList taskList = okmTask.getNotified(null, subject, 10, projectId, typeId, statusId,
                    lastModified, start, end, from, to, "subject", true, 0, 10);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

countNotified

Descripción:

Método	Valores de retorno	Descripción
countNotified(String token, long projectId, long typeId, long statusId)	long	Devuelve el número de tareas sobre las que se notifica al usuario, filtradas por proyecto, tipo y estado.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = okmTask.countNotified(null, projectId, typeId, statusId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

countNotified

Descripción:

Método	Valores de retorno	Descripción
countNotified(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end)	long	Devuelve el número de tareas sobre las que se notifica al usuario, con filtrado completo.

Ejemplo:

package com.openkm;

import java.util.Calendar;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            int progress = 10;
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();

            long total = okmTask.countNotified(null, subject, progress, projectId, typeId, statusId,
                    lastModified, start, end);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNotifiedCount

Descripción:

Método	Valores de retorno	Descripción
getNotifiedCount(String token, long projectId, long typeId, long statusId)	long	Devuelve el recuento total de tareas notificadas del usuario actual, filtradas por proyecto, tipo y estado.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = okmTask.getNotifiedCount(null, projectId, typeId, statusId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAssigned

Descripción:

Método	Valores de retorno	Descripción
getAssigned(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end, Calendar from, Calendar to, String orderColumn, boolean orderAsc, int offset, int limit)	TaskList	Recupera una lista de tareas asignadas a un usuario, con filtrado completo incluyendo el rango de fechas de creación (from/to) y paginación.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.TaskList;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();
            Calendar from = Calendar.getInstance();
            from.add(Calendar.MONTH, -1);
            Calendar to = Calendar.getInstance();

            TaskList taskList = okmTask.getAssigned(null, subject, 10, projectId, typeId, statusId,
                    lastModified, start, end, from, to, "subject", true, 0, 10);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getActive

Descripción:

Método	Valores de retorno	Descripción
getActive(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end, Calendar from, Calendar to, String orderColumn, boolean orderAsc, int offset, int limit)	TaskList	Recupera una lista de tareas activas asignadas a un usuario, con filtrado completo incluyendo el rango de fechas de creación (from/to) y paginación.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.TaskList;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();
            Calendar from = Calendar.getInstance();
            from.add(Calendar.MONTH, -1);
            Calendar to = Calendar.getInstance();

            TaskList taskList = okmTask.getActive(null, subject, 10, projectId, typeId, statusId,
                    lastModified, start, end, from, to, "progress", true, 0, 10);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFinished

Descripción:

Método	Valores de retorno	Descripción
getFinished(String token, String subject, int progress, long projectId, long typeId, long statusId, Calendar lastModified, Calendar start, Calendar end, Calendar from, Calendar to, String orderColumn, boolean orderAsc, int offset, int limit)	TaskList	Recupera una lista de tareas finalizadas asignadas a un usuario, con filtrado completo incluyendo el rango de fechas de creación (from/to) y paginación.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMTask;
import com.openkm.bean.Task;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.TaskList;

public class Test {

    public static void main(String[] args) {
        try {
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            String subject = "test subject";
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            Calendar lastModified = Calendar.getInstance();
            Calendar start = Calendar.getInstance();
            start.add(Calendar.DATE, -30);
            Calendar end = Calendar.getInstance();
            Calendar from = Calendar.getInstance();
            from.add(Calendar.MONTH, -1);
            Calendar to = Calendar.getInstance();

            TaskList taskList = okmTask.getFinished(null, subject, 10, projectId, typeId, statusId,
                    lastModified, start, end, from, to, "end", true, 0, 10);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}