Ir al contenido
Otras versiones

Cargando…

OKMTask

Conceptos básicos

Sección titulada «Conceptos básicos»

Descripción de los campos de la tarea:

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 ID del usuario 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 comenzar la tarea. Sí.
End Calendar Cuándo puede finalizar 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 de progreso numérico.
El rango de valores permitidos va de 0 a 100, donde el 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 comience la tarea puede enviar el sistema una notificación por correo electrónico al usuario. No.
ReminderEndValue Integer Cuántos días antes de que finalice la tarea puede enviar el sistema una notificación por correo electrónico al usuario. No.
ReminderStartUnit String Unidades del recordatorio de inicio.
Valores permitidos:
- “m” para minutos.
- “h” para horas.
- “d” para días.		 Obligatorio cuando ReminderStartValue es mayor que 0.
ReminderEndUnit String Unidades del recordatorio de fin.
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 un rol.
Roles Set Colección de roles asignados a la tarea. No. Pero debe asignarse al menos un usuario o un 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 existe un parámetro denominado “token”. Cuando se accede a la aplicación mediante REST, el proceso de inicio de sesión devuelve un token. El token se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución predeterminado de la aplicación debe utilizar el valor “null”, que indica que la aplicación debe utilizar la “sesión del usuario”.

Métodos

Sección titulada «Métodos»

create

Sección titulada «create»

Descripción:

Método Valores devueltos 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

Sección titulada «update»

Descripción:

Método Valores devueltos 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

Sección titulada «find»

Descripción:

Método Valores devueltos Descripción
find(String token, Task task) 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

Sección titulada «delete»

Descripción:

Método Valores devueltos Descripción
delete(String token, Task task) 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

Sección titulada «getByProject»

Descripción:

Método Valores devueltos 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

Sección titulada «getByType»

Descripción:

Método Valores devueltos 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

Sección titulada «getAssigned»

Descripción:

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

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

Sección titulada «getAssigned»

Descripción:

Método Valores devueltos 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, filtrada y paginada.

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

Sección titulada «countAssigned»

Descripción:

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

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

Sección titulada «getActive»

Descripción:

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

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

Sección titulada «getActive»

Descripción:

Método Valores devueltos 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, filtrada y paginada.

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

Sección titulada «countActive»

Descripción:

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

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();
        }
    }
}

getFinished

Sección titulada «getFinished»

Descripción:

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

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

Sección titulada «getFinished»

Descripción:

Método Valores devueltos 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, filtrada y paginada.

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

Sección titulada «countFinished»

Descripción:

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

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

Sección titulada «findStatus»

Descripción:

Método Valores devueltos Descripción
findStatus(String token, long statusId) TaskStatus Devuelve un objeto de estado de tarea por su 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

Sección titulada «findProject»

Descripción:

Método Valores devueltos Descripción
findProject(String token, long projectId) TaskProject Devuelve un objeto de proyecto de tarea por su 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

Sección titulada «findType»

Descripción:

Método Valores devueltos Descripción
findType(String token, long typeId) TaskType Devuelve un objeto de tipo de tarea por su 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

Sección titulada «findNote»

Descripción:

Método Valores devueltos Descripción
findNote(String token, long noteId) TaskNote Devuelve un objeto de nota de tarea por su 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

Sección titulada «getStatuses»

Descripción:

Método Valores devueltos 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

Sección titulada «getProjects»

Descripción:

Método Valores devueltos 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

Sección titulada «getTypes»

Descripción:

Método Valores devueltos 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

Sección titulada «getNotes»

Descripción:

Método Valores devueltos 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

Sección titulada «createStatus»

Descripción:

Método Valores devueltos Descripción
createStatus(String token, String name, boolean finish) TaskStatus Crea un nuevo estado 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);
            TaskStatus ts = okmTask.createStatus(null, "cancelled", true);
            System.out.println(ts);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createProject

Sección titulada «createProject»

Descripción:

Método Valores devueltos Descripción
createProject(String token, String name, String description, boolean active) TaskProject Crea un nuevo proyecto 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);
            TaskProject tp = okmTask.createProject(null, "Project one", "Description", true);
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createType

Sección titulada «createType»

Descripción:

Método Valores devueltos Descripción
createType(String token, String name, String description, boolean active) TaskType Crea un nuevo tipo 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);
            TaskType tt = okmTask.createType(null, "Type one", "Description", true);
            System.out.println(tt);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createNote

Sección titulada «createNote»

Descripción:

Método Valores devueltos Descripción
createNote(String token, long taskId, String text) TaskNote Crea una nueva nota para 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

Sección titulada «updateStatus»

Descripción:

Método Valores devueltos Descripción
updateStatus(String token, long id, String name, boolean finish) TaskStatus Actualiza un estado 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);
            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

Sección titulada «updateProject»

Descripción:

Método Valores devueltos Descripción
updateProject(String token, long id, String name, String description, boolean active) TaskProject Actualiza un proyecto 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);
            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

Sección titulada «updateType»

Descripción:

Método Valores devueltos Descripción
updateType(String token, long id, String name, String description, boolean active) TaskType Actualiza un tipo 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);
            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

Sección titulada «updateNote»

Descripción:

Método Valores devueltos 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

Sección titulada «deleteStatus»

Descripción:

Método Valores devueltos 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

Sección titulada «deleteProject»

Descripción:

Método Valores devueltos 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

Sección titulada «deleteType»

Descripción:

Método Valores devueltos 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

Sección titulada «deleteNote»

Descripción:

Método Valores devueltos 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

Sección titulada «getByNode»

Descripción:

Método Valores devueltos 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

Sección titulada «getHistory»

Descripción:

Método Valores devueltos 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

Sección titulada «getAssigned»

Descripción:

Método Valores devueltos 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, filtrada y paginada.

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

Sección titulada «countAssigned»

Descripción:

Método Valores devueltos 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.

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

Sección titulada «getActive»

Descripción:

Método Valores devueltos 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, filtrada y paginada.

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

Sección titulada «countActive»

Descripción:

Método Valores devueltos 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.

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

Sección titulada «getFinished»

Descripción:

Método Valores devueltos 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, filtrada y paginada.

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

Sección titulada «countFinished»

Descripción:

Método Valores devueltos 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.

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

Sección titulada «getAssignedCount»

Descripción:

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

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

Sección titulada «getActiveCount»

Descripción:

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

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

Sección titulada «getNotified»

Descripción:

Método Valores devueltos 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, paginada.

Ejemplo:

package com.openkm;


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 {
            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
            OKMTask okmTask = ContextWrapper.getContext().getBean(OKMTask.class);
            TaskList taskList = okmTask.getNotified(null, projectId, typeId, statusId, orderColumn, true, 0, 10);
            for (Task task : taskList.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFinishedCount

Sección titulada «getFinishedCount»

Descripción:

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

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();
        }
    }
}