Skip to content
Other versions

Loading…

Task samples

Basics

Section titled “Basics”

Task fields description:

Field Type Description Mandatory
Id Long Internal task id.
It is automatically set by application.		 Not applicable.
Owner String It contains the OpenKM userId.
It is automatically set by application.		 Not applicable.
Subject String The topic of the task. Yes.
Description String The description of the task. No.
Start Calendar When the task might start. Yes.
End Calendar When the task might endding. No.
Status TaskStatus The task status.
You administering the list of status values.		 Yes.
Project TaskProject The project related with the task.
You administering the list of project values.		 Yes.
Type TaskType The task type.
You administering the list of task type values.		 Yes.
Progress Integer The numeric progress status.
The range of allowed values is from 0 to 100. Where 100% indicates a completed task.		 Yes.
RepeatGroup Long When a task is repeated along time is a member of a group. The group is identified by an unique repeat group id. No.
ReminderStartValue Integer How many days before the task starting, the system might send a mail notification to the user. No.
ReminderEndValue Integer How many days before the task ending, the system might send a mail notification to the user. No.
ReminderStartUnit String Reminder start units.
Allowed values:
- “m” for minutes.
- “h” for hours.
- “d” for days.		 Mandatory when ReminderStartValue greater than 0.
ReminderEndUnit String Reminder end units.
Allowed values:
- “m” for minutes.
- “h” for hours.
- “d” for days.		 Mandatory when ReminderEndValue greater than 0.
Users Set Collection of assigned users to the task. No. But At least should be a user or role assigned.
Roles Set Collection of assigned roles to the task. No. But At least should be a user or role assigned.
Documents Set List of UUID’s of the related documents. No.
Folders Set List of UUID’s of the related folders. No.
Mails Set List of UUID’s of the related mails. No.
Records Set List of UUID’s of the related records. No.

On all methods, you’ll see parameter named “token”. When accessing application across SOAP the login process returns a token, what is used to identify the user on all the exposed methods. From default application execution context you must use the “null” value what indicates the application must use the “user session”.

Suggested code sample

Section titled “Suggested code sample”

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

Then should login using the method “login”. You can access the “login” method from webservice object “ws” as is shown below:

ws.login(user, password);

At this point you can use all the Task methods from “task” class as is shown below:

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

Methods

Section titled “Methods”

getAssignedTasks

Section titled “getAssignedTasks”

Description:

Method Return values Description
getAssignedTasks(long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit, Calendar from, Calendar to, String subject) List Retrieve a list of tasks assigned to a user, filtered and paginated.

Example:

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

Section titled “getActiveTasks”

Description:

Method Return values Description
getActiveTasks(long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit, Calendar from, Calendar to, String subject) List Retrieve a list of active tasks assigned to a user, filtered and paginated.

Example:

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

Section titled “getFinishedTasks”

Description:

Method Return values Description
getFinishedTasks(long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit, Calendar from, Calendar to, String subject) List Retrieve a list of finished tasks assigned to a user, filtered and paginated.

Example:

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

Section titled “getNotifiedTasks”

Description:

Method Return values Description
getNotifiedTasks(long projectId, long typeId, long statusId, String orderColumn, boolean orderAsc, int offset, int limit, Calendar from, Calendar to, String subject) List Retrieve a list of notified tasks assigned to a user, filtered and paginated.

Example:

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

Section titled “getTaskStatus”

Description:

Method Return values Description
getTaskStatus() List Retrieve a list of all the task status.

Example:

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

Section titled “getTaskProjects”

Description:

Method Return values Description
getTaskProjects(boolean filterActive) List Retrieve a list of all the task projects.

Example:

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

Section titled “getTaskTypes”

Description:

Method Return values Description
getTaskTypes(boolean filterActive) List Retrieve a list of all the task types.

Example:

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

Section titled “getAssignedTasksCount”

Description:

Method Return values Description
getAssignedTasksCount(long statusId, long projectId, long typeId) long Return the number of tasks assigned to a user.

Example:

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

Section titled “getActiveTasksCount”

Description:

Method Return values Description
getActiveTasksCount(long statusId, long projectId, long typeId) Long Return the number of active tasks to a user.

Example:

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

Section titled “getFinishedTasksCount”

Description:

Method Return values Description
getFinishedTasksCount(long statusId, long projectId, long typeId) Long Return the number of finished tasks to a user.

Example:

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

Section titled “getNotifiedTasksCount”

Description:

Method Return values Description
getNotifiedTasksCount(long statusId, long projectId, long typeId) Long Return the number of notified tasks assigned to a user.

Example:

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

Section titled “createTask”

Description:

Method Return values Description
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 Create a new task.
The repeatExpression parameters description:
The commands are executed by cron when the minute, hour, and month fields match the current time, and when at least one of the two day fields (day of month, or day of week) match the current time. The scheduler examines crontab entries once every minute. The time and date fields are:
<br>* * * * * command to execute<br> ? ? ? ? ?<br> ? ? ? ? ?<br> ? ? ? ? ????? day of week (0 - 6) (0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the same as 0)<br> ? ? ? ?????????? month (1 - 12)<br> ? ? ??????????????? day of month (1 - 31)<br> ? ???????????????????? hour (0 - 23)<br> ????????????????????????? min (0 - 59)<br>

Example:

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

Section titled “updateTask”

Description:

Method Return values Description
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 Update a task.

Example:

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

Section titled “getTask”

Description:

Method Return values Description
getTask(long taskId) Task Retrieve a task.

Example:

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

Section titled “deleteTask”

Description:

Method Return values Description
deleteTask(long taskId) void Delete a task.

Example:

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

Section titled “createTaskProject”

Description:

Method Return values Description
createTaskProject(String name, boolean active, String description) TaskProject Create a new task project.

Example:

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

Section titled “updateTaskProject”

Description:

Method Return values Description
updateTaskProject(long projectId, boolean active, String name, String description, ) TaskProject Update a task project.

Example:

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

Section titled “deleteTaskProject”

Description:

Method Return values Description
deleteTaskProject(long projectId) void Delete a task project.

Example:

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

Section titled “getTaskProject”

Description:

Method Return values Description
getTaskProject(long projectId) TaskProject Return a task project object by id.

Example:

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

Section titled “getTaskProjects”

Description:

Method Return values Description
getTaskProjects(boolean filterActive) List Retrieve a list of all the task projects.

Example:

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

Section titled “createTaskType”

Description:

Method Return values Description
createTaskType(String name, boolean active, String description) TaskType Create a new task type.

Example:

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

Section titled “updateTaskType”

Description:

Method Return values Description
updateTaskType(long typeId, boolean active, String name, String description) TaskType Update a task type.

Example:

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

Section titled “deleteTaskType”

Description:

Method Return values Description
deleteTaskType(long typeId) void Delete a task type.

Example:

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

Section titled “getTaskType”

Description:

Method Return values Description
getTaskType(long typeId) TaskType Return a task type object by id.

Example:

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

Section titled “getTaskTypes”

Description:

Method Return values Description
getTaskTypes(boolean filterActive) List Retrieve a list of all the task types.

Example:

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

Section titled “createTaskStatus”

Description:

Method Return values Description
createTaskStatus(String name, boolean finish) TaskStatus Create a new task status.

Example:

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

Section titled “updateTaskStatus”

Description:

Method Return values Description
updateTaskStatus(long statusId, String name, boolean finish) TaskStatus Update a task status.

Example:

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

Section titled “deleteTaskStatus”

Description:

Method Return values Description
deleteTaskStatus(long statusId) void Delete a task status.

Example:

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

Section titled “getTaskStatus”

Description:

Method Return values Description
getTaskStatus(long statusId) TaskStatus Return a task status object by id.

Example:

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

Section titled “getTaskStatus”

Description:

Method Return values Description
getTaskStatus() List Retrieve a list of all the task status.

Example:

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

Section titled “createTaskNote”

Description:

Method Return values Description
createTaskNote(long taskId, String text) TaskNote Create a new note to a task.

Example:

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

Section titled “updateTaskNote”

Description:

Method Return values Description
updateTaskNote(long noteId, String text) TaskNote Update note of a task.

Example:

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

Section titled “deleteTaskNote”

Description:

Method Return values Description
deleteTaskNote(String token, long noteId) void Delete note of a task.

Example:

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

Section titled “getTaskNotes”

Description:

Method Return values Description
getTaskNotes(long taskId) List Retrieve a list of all the notes of a task.

Example:

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