Ir al contenido
Otras versiones

Cargando…

Task samples

Aspectos básicos

Sección titulada «Aspectos básicos»

Descripción de los campos de Task:

Campo Tipo Descripción Obligatorio
Id Long Id interno de la tarea.
Se establece automáticamente por la aplicación.		 No aplica.
Owner String Contiene el ID de usuario de OpenKM.
Se establece automáticamente por la aplicación.		 No aplica.
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 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 la tarea comience, el sistema puede enviar una notificación por correo electrónico al usuario. No.
ReminderEndValue Integer Cuántos días antes de que la tarea finalice, el sistema puede enviar una notificación por correo electrónico 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 Conjunto de usuarios asignados a la tarea. No. Pero se debe asignar al menos un usuario o rol.
Roles Set Conjunto de roles asignados a la tarea. No. Pero se debe asignar 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, verá un parámetro llamado “token”. Al acceder a la aplicación mediante SOAP, el proceso de inicio de sesión devuelve un token, que se usa para identificar al usuario en todos los métodos expuestos. Por defecto, desde el contexto de ejecución de la aplicación debe usar el valor “null”, que indica que la aplicación debe usar la “sesión de usuario”.

Ejemplo de código sugerido

Sección titulada «Ejemplo de código sugerido»

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Llegados a este punto puede usar todos los métodos de Task desde la clase “task”, tal y como se muestra a continuación:

ws.task.getAssignedTasks(projectId, typeId, statusId, orderColumn, true, 0, 10, subject);

Métodos

Sección titulada «Métodos»

getAssignedTasks

Sección titulada «getAssignedTasks»

Descripción:

Método Valores de retorno Descripción
getAssignedTasks(long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit, Calendar from, Calendar to, String subject) List Recupera una lista de tareas asignadas a un usuario, filtrada y paginada.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


import java.util.Calendar;


public class Test {


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


        try {
            ws.login(user, password);


            String orderColumn = "subject"; // A valid TaskManagerTask class parameter name used in HQL query
            Calendar from = Calendar.getInstance();
            from.set(from.get(Calendar.YEAR), Calendar.NOVEMBER, 1);


            Calendar to = Calendar.getInstance();
            to.set(from.get(Calendar.YEAR), Calendar.NOVEMBER, 30);


            long statusId = 1; // A valid task status id
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id


            TaskList listAssigned = ws.task.getAssignedTasks(projectId, typeId, statusId, orderColumn, true, 0, 10, from, to, "");
            for (Task task : listAssigned.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getActiveTasks

Sección titulada «getActiveTasks»

Descripción:

Método Valores de retorno Descripción
getActiveTasks(long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit, Calendar from, Calendar to, String subject) List Recupera una lista de tareas activas asignadas a un usuario, filtrada y paginada.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


import java.util.Calendar;


public class Test {


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


        try {
            ws.login(user, password);


            String orderColumn = "subject"; // A valid TaskManagerTask class parameter name used in HQL query
            Calendar from = Calendar.getInstance();
            from.set(from.get(Calendar.YEAR), Calendar.NOVEMBER, 1);


            Calendar to = Calendar.getInstance();
            to.set(from.get(Calendar.YEAR), Calendar.NOVEMBER, 30);


            long statusId = 1; // A valid task status id
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id


            TaskList listAssigned = ws.task.getActiveTasks(projectId, typeId, statusId, orderColumn, true, 0, 10, from, to, "");
            for (Task task : listAssigned.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFinishedTasks

Sección titulada «getFinishedTasks»

Descripción:

Método Valores de retorno Descripción
getFinishedTasks(long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit, Calendar from, Calendar to, String subject) List Recupera una lista de tareas finalizadas asignadas a un usuario, filtrada y paginada.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


import java.util.Calendar;


public class Test {


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


        try {
            ws.login(user, password);


            String orderColumn = "subject"; // A valid TaskManagerTask class parameter name used in HQL query
            Calendar from = Calendar.getInstance();
            from.set(from.get(Calendar.YEAR), Calendar.NOVEMBER, 1);


            Calendar to = Calendar.getInstance();
            to.set(from.get(Calendar.YEAR), Calendar.NOVEMBER, 30);


            long statusId = 1; // A valid task status id
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id


            TaskList listAssigned = ws.task.getFinishedTasks(projectId, typeId, statusId, orderColumn, true, 0, 10, from, to, "");
            for (Task task : listAssigned.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNotifiedTasks

Sección titulada «getNotifiedTasks»

Descripción:

Método Valores de retorno Descripción
getNotifiedTasks(long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit, Calendar from, Calendar to, String subject) List Recupera una lista de tareas notificadas asignadas a un usuario, filtrada y paginada.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.*;
import com.openkm.sdk4j.impl.OKMWebservices;


import java.util.Calendar;


public class Test {


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


        try {
            ws.login(user, password);


            String orderColumn = "subject"; // A valid TaskManagerTask class parameter name used in HQL query
            Calendar from = Calendar.getInstance();
            from.set(from.get(Calendar.YEAR), Calendar.NOVEMBER, 1);


            Calendar to = Calendar.getInstance();
            to.set(from.get(Calendar.YEAR), Calendar.NOVEMBER, 30);


            long statusId = 1; // A valid task status id
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id


            TaskList listAssigned = ws.task.getNotifiedTasks(projectId, typeId, statusId, orderColumn, true, 0, 10, from, to, "");
            for (Task task : listAssigned.getTasks()) {
                System.out.println(task);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskStatus

Sección titulada «getTaskStatus»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskStatus;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            for (TaskStatus ts : ws.task.getTaskStatus()) {
                System.out.println(ts);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskProjects

Sección titulada «getTaskProjects»

Descripción:

Método Valores de retorno Descripción
getTaskProjects(boolean filterActive) List Recupera una lista de todos los proyectos de tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskProject;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            for (TaskProject tp : ws.task.getTaskProjects(true)) {
                System.out.println(tp);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskTypes

Sección titulada «getTaskTypes»

Descripción:

Método Valores de retorno Descripción
getTaskTypes(boolean filterActive) List Recupera una lista de todos los tipos de tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskType;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            for (TaskType tt : ws.task.getTaskTypes(true)) {
                System.out.println(tt);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAssignedTasksCount

Sección titulada «getAssignedTasksCount»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = ws.task.getAssignedTasksCount(statusId, projectId, typeId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getActiveTasksCount

Sección titulada «getActiveTasksCount»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = ws.task.getActiveTasksCount(statusId, projectId, typeId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFinishedTasksCount

Sección titulada «getFinishedTasksCount»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = ws.task.getFinishedTasksCount(statusId, projectId, typeId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNotifiedTasksCount

Sección titulada «getNotifiedTasksCount»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id
            long statusId = 1; // A valid status id
            long total = ws.task.getNotifiedTasksCount(statusId, projectId, typeId);
            System.out.println(total);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createTask

Sección titulada «createTask»

Descripción:

Método Valores de retorno Descripción
createTask(String subject, String start, String end, String description, long statusId, long projectId,
long typeId, String user, List notificationUsers, List externalUsers, List relatedDocuments,
List relatedFolders, List relatedRecords, List relatedMails, String repeatExpression,
String repeatExpression, String formatDate, int repeatTimes, String reminderStartUnit, int reminderStartValue,
String reminderEndUnit, int reminderEndValue)		 Task Crea una nueva tarea.
Descripción del parámetro repeatExpression:
Los comandos son ejecutados por cron cuando los campos de minuto, hora y mes coinciden con la hora actual, y cuando al menos uno de los dos campos de día (día del mes o día de la semana) coincide con la hora actual. El planificador examina las entradas de crontab una vez por minuto. Los campos de hora y fecha son:
<br>* * * * * comando a ejecutar<br> ? ? ? ? ?<br> ? ? ? ? ?<br> ? ? ? ? ????? día de la semana (0 - 6) (de 0 a 6 son domingo a sábado, o puede usar nombres; 7 es domingo, igual que 0)<br> ? ? ? ?????????? mes (1 - 12)<br> ? ? ??????????????? día del mes (1 - 31)<br> ? ???????????????????? hora (0 - 23)<br> ????????????????????????? minuto (0 - 59)<br>

Ejemplo:

package com.openkm;


import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Task;
import com.openkm.sdk4j.impl.OKMWebservices;
import com.openkm.sdk4j.util.ISO8601;


public class Test {


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


        try {
            ws.login(user, password);
            String subject = "task subject";


            Calendar calendar = Calendar.getInstance();
            String start = ISO8601.formatBasic(calendar);


            calendar.add(Calendar.DATE, 15);
            String end = ISO8601.formatBasic(calendar);


            String description = "description test";


            long statusId = 1; // A valid task status id
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id


            List<String> notificationUsers = new ArrayList<>();
            notificationUsers.add("gnujavasergio");
            notificationUsers.add("sochoa");


            List<String> externalUsers = new ArrayList<>();
            externalUsers.add("gnu.java.sergio@gmail.com");


            List<String> relatedDocuments = new ArrayList<>();
            relatedDocuments.add("d701c503-87fc-4a9e-829e-478dc375eb83");
            relatedDocuments.add("f02053e3-2264-4040-bb84-67983a0208f7");


            List<String> relatedFolders = new ArrayList<>();
            relatedFolders.add("0a777b34-f518-4da7-9e58-8b1425e05add");
            relatedFolders.add("271cc3aa-218e-4574-8065-c34c704f4a20");


            List<String> relatedMails = new ArrayList<>();
            relatedMails.add("3ae1bb26-acdf-4463-a0c1-06cc62f55b95");
            relatedMails.add("c599be73-7831-4e93-be91-453baeda2b00");


            List<String> relatedRecords = new ArrayList<>();
            relatedRecords.add("96801b33-e92e-436b-8ed7-5d8dea904673");
            relatedRecords.add("23b50095-aa18-4d16-ae75-74b994a2f2b4");


            String currentDate = "31/04/2018";
            SimpleDateFormat sdf = new SimpleDateFormat("dd/MM/yyyy");
            calendar.setTime(sdf.parse(currentDate));


            String repeatExpression = "0 0 1 * *";


            calendar.add(Calendar.DATE, 1);
            String repeatUntil = ISO8601.formatBasic(calendar);


            // createTask
            Task newTask = ws.task.createTask(subject, start, end, description, statusId, projectId, typeId,
                    "okmAdmin", notificationUsers, externalUsers, relatedDocuments, relatedFolders, relatedRecords, relatedMails, repeatExpression, repeatUntil,
                    "dd-MM-yyyy", 10, "m", 5, "m", 10);
            System.out.println(newTask);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateTask

Sección titulada «updateTask»

Descripción:

Método Valores de retorno Descripción
updateTask(long taskId, String subject, String start, String end, String description, long statusId,
long projectId, long typeId, String user, List notificationUsers, List externalUsers,
List relatedDocuments, List relatedFolders, List relatedRecords, List relatedMails,
String owner, String repeatExpression, String repeatUntil, String formatDate, int repeatTimes, int progress,
String reminderStartUnit, int reminderStartValue, String reminderEndUnit, int reminderEndValue)		 Task Actualiza una tarea.

Ejemplo:

package com.openkm;


import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Task;
import com.openkm.sdk4j.impl.OKMWebservices;
import com.openkm.sdk4j.util.ISO8601;


public class Test {


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


        try {
            ws.login(user, password);
            String subject = "update task subject";


            Calendar calendar = Calendar.getInstance();
            String start = ISO8601.formatBasic(calendar);


            calendar.add(Calendar.DATE, 15);
            String end = ISO8601.formatBasic(calendar);


            String description = "Update description test";


            long statusId = 1; // A valid task status id
            long projectId = 1; // A valid project id
            long typeId = 1; // A valid type id


            List<String> notificationUsers = new ArrayList<>();
            notificationUsers.add("gnujavasergio");
            notificationUsers.add("sochoa");


            List<String> externalUsers = new ArrayList<>();
            externalUsers.add("gnu.java.sergio@gmail.com");


            List<String> relatedDocuments = new ArrayList<>();
            relatedDocuments.add("d701c503-87fc-4a9e-829e-478dc375eb83");
            relatedDocuments.add("f02053e3-2264-4040-bb84-67983a0208f7");


            List<String> relatedFolders = new ArrayList<>();
            relatedFolders.add("0a777b34-f518-4da7-9e58-8b1425e05add");
            relatedFolders.add("271cc3aa-218e-4574-8065-c34c704f4a20");


            List<String> relatedMails = new ArrayList<>();
            relatedMails.add("3ae1bb26-acdf-4463-a0c1-06cc62f55b95");
            relatedMails.add("c599be73-7831-4e93-be91-453baeda2b00");


            List<String> relatedRecords = new ArrayList<>();
            relatedRecords.add("96801b33-e92e-436b-8ed7-5d8dea904673");
            relatedRecords.add("23b50095-aa18-4d16-ae75-74b994a2f2b4");


            String currentDate = "31/04/2018";
            SimpleDateFormat sdf = new SimpleDateFormat("dd/MM/yyyy");
            calendar.setTime(sdf.parse(currentDate));


            String repeatExpression = "0 0 1 * *";


            calendar.add(Calendar.DATE, 1);
            String repeatUntil = ISO8601.formatBasic(calendar);


            long taskId = 1;
            Task updateTask = ws.task.updateTask(taskId, subject, start, end, description,
                    statusId, projectId, typeId, "okmAdmin", notificationUsers, externalUsers,
                    relatedDocuments, relatedFolders, relatedRecords, relatedMails,
                    "okmAdmin", repeatExpression, repeatUntil, "dd-MM-yyyy",
                    10, 10, "m", 5, "m", 10);
            System.out.println(updateTask);;
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTask

Sección titulada «getTask»

Descripción:

Método Valores de retorno Descripción
getTask(long taskId) Task Recupera una tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Task;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long taskId = 2;
            Task task = ws.task.getTask(taskId);
            System.out.println(task);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteTask

Sección titulada «deleteTask»

Descripción:

Método Valores de retorno Descripción
deleteTask(long taskId) void Elimina una tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long taskId = 2;
            ws.task.deleteTask(taskId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createTaskProject

Sección titulada «createTaskProject»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskProject;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            TaskProject tp = ws.task.createTaskProject("Project one", true, "Description");
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateTaskProject

Sección titulada «updateTaskProject»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskProject;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long projectId = 4; // A valid project id
            TaskProject tp = ws.task.getTaskProject(projectId);
            System.out.println(tp);
            tp = ws.task.updateTaskProject(projectId, false, "cancelled", "Description");
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteTaskProject

Sección titulada «deleteTaskProject»

Descripción:

Método Valores de retorno Descripción
deleteTaskProject(long projectId) void Elimina un proyecto de tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long projectId = 5; // A valid project id
            ws.task.deleteTaskProject(projectId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskProject

Sección titulada «getTaskProject»

Descripción:

Método Valores de retorno Descripción
getTaskProject(long projectId) TaskProject Devuelve un objeto de proyecto de tarea según su id.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskProject;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long projectId = 1; // A valid project id
            TaskProject tp = ws.task.getTaskProject(projectId);
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskProjects

Sección titulada «getTaskProjects»

Descripción:

Método Valores de retorno Descripción
getTaskProjects(boolean filterActive) List Recupera una lista de todos los proyectos de tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskProject;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            for (TaskProject tp : ws.task.getTaskProjects(true)) {
                System.out.println(tp);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createTaskType

Sección titulada «createTaskType»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskType;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            TaskType tt = ws.task.createTaskType("Type one", true, "Description");
            System.out.println(tt);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateTaskType

Sección titulada «updateTaskType»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskType;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long typeId = 4; // A valid type id
            TaskType tp = ws.task.getTaskType(typeId);
            System.out.println(tp);
            tp = ws.task.updateTaskType(typeId, false, "Type one", "Description");
            System.out.println(tp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteTaskType

Sección titulada «deleteTaskType»

Descripción:

Método Valores de retorno Descripción
deleteTaskType(long typeId) void Elimina un tipo de tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long typeId = 4; // A valid type id
            ws.task.deleteTaskType(typeId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskType

Sección titulada «getTaskType»

Descripción:

Método Valores de retorno Descripción
getTaskType(long typeId) TaskType Devuelve un objeto de tipo de tarea según su id.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskType;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long typeId = 1; // A valid type id
            TaskType tt = ws.task.getTaskType(typeId);
            System.out.println(tt);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskTypes

Sección titulada «getTaskTypes»

Descripción:

Método Valores de retorno Descripción
getTaskTypes(boolean filterActive) List Recupera una lista de todos los tipos de tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskType;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            for (TaskType tt : ws.task.getTaskTypes(true)) {
                System.out.println(tt);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createTaskStatus

Sección titulada «createTaskStatus»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskStatus;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            TaskStatus ts = ws.task.createTaskStatus("cancelled", true);
            System.out.println(ts);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateTaskStatus

Sección titulada «updateTaskStatus»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskStatus;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long statusId = 1; // A valid task id
            TaskStatus ts = ws.task.getTaskStatus(statusId);
            System.out.println(ts);
            ts = ws.task.updateTaskStatus(statusId, "cancelled", true);
            System.out.println(ts);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteTaskStatus

Sección titulada «deleteTaskStatus»

Descripción:

Método Valores de retorno Descripción
deleteTaskStatus(long statusId) void Elimina un estado de tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long statusId = 4; // A valid status id
            ws.task.deleteTaskStatus(statusId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskStatus

Sección titulada «getTaskStatus»

Descripción:

Método Valores de retorno Descripción
getTaskStatus(long statusId) TaskStatus Devuelve un objeto de estado de tarea según su id.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskStatus;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long statusId = 1; // A valid status id
            TaskStatus ts = ws.task.getTaskStatus(statusId);
            System.out.println(ts);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskStatus

Sección titulada «getTaskStatus»

Descripción:

Método Valores de retorno Descripción
getTaskStatus() 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();
        }
    }
}

createTaskNote

Sección titulada «createTaskNote»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskNote;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long taskId = 1; // A valid task id
            TaskNote tn = ws.task.createTaskNote(taskId, "New note");
            System.out.println(tn);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateTaskNote

Sección titulada «updateTaskNote»

Descripción:

Método Valores de retorno Descripción
updateTaskNote(long noteId, String text) TaskNote Actualiza una nota de una tarea.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskNote;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long noteId = 1; // A valid note id
            TaskNote tn = ws.task.updateTaskNote(noteId, "Note updated");
            System.out.println(tn);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteTaskNote

Sección titulada «deleteTaskNote»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long noteId = 1; // A valid note id
            ws.task.deleteTaskNote(noteId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskNotes

Sección titulada «getTaskNotes»

Descripción:

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

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.TaskNote;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


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


        try {
            ws.login(user, password);
            long taskId = 1; // A valid task id
            for (TaskNote tn : ws.task.getTaskNotes(taskId)) {
                System.out.println(tn);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}