1. Home
  2. SDK for Java 1.5
  3. Dashboard samples
  1.  

Dashboard samples

Methods

getUserCheckedOutDocuments

Description:

MethodReturn valuesDescription

getUserCheckedOutDocuments()

List<DashboardDocumentResult>

Returns a list of the documents in edition by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getUserCheckedOutDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastModifiedDocuments

Description:

MethodReturn valuesDescription

getUserLastModifiedDocuments()

List<DashboardDocumentResult>

Returns a list of the last documents modified by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getUserLastModifiedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLockedDocuments

Description:

MethodReturn valuesDescription

getUserLockedDocuments()

List<DashboardDocumentResult>

Returns a list of the documents locked by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getUserLockedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSubscribedDocuments

Description:

MethodReturn valuesDescription

getUserSubscribedDocuments()

List<DashboardDocumentResult>

Returns a list of the documents subscribed by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getUserSubscribedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSubscribedFolders

Description:

MethodReturn valuesDescription

getUserSubscribedFolders()

List<DashboardFolderResult>

Returns a list of the folders subscribed by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardFolderResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardFolderResult> dashboardFolderResults = ws.getUserSubscribedFolders();
            for (DashboardFolderResult dashboardFolderResult : dashboardFolderResults) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastUploadedDocuments

Description:

MethodReturn valuesDescription

getUserLastUploadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last documents uploaded by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getUserLastUploadedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastDownloadedDocuments

Description:

MethodReturn valuesDescription

getUserLastDownloadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last documents downloaded by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getUserLastDownloadedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastImportedMails

Description:

MethodReturn valuesDescription

getUserLastImportedMails()

List<DashboardMailResult>

Returns a list of the last mails imported by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardMailResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardMailResult> dashboardMailResults = ws.getUserLastImportedMails();
            for (DashboardMailResult dashboardMailResult : dashboardMailResults) {
                System.out.println(dashboardMailResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastImportedMailAttachments

Description:

MethodReturn valuesDescription

getUserLastImportedMailAttachments()

List<DashboardDocumentResult>

Returns a list of the last mails imported with attachments by the user.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getUserLastImportedMailAttachments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSearches

Description:

MethodReturn valuesDescription

getUserSearches()

List<QueryParams>

Returns a list of the searches saved by the user as user news.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<QueryParams> queryParams = ws.getUserSearchs();
            for (QueryParams params : queryParams) {
                System.out.println(params);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findUserSearches

Description:

MethodReturn valuesDescription

findUserSearches(int qpId)

List<DashboardDocumentResult>

Returns a list of nodes based in a search saved by the user ( search of type user news ).

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.findUserSearches(3);
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastWeekTopDownloadedDocuments

Description:

MethodReturn valuesDescription

getLastWeekTopDownloadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last week top documents downloaded.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getLastWeekTopDownloadedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastMonthTopDownloadedDocuments

Description:

MethodReturn valuesDescription

getLastMonthTopDownloadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last month top documents downloaded.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getLastMonthTopDownloadedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastWeekTopModifiedDocuments

Description:

MethodReturn valuesDescription

getLastWeekTopModifiedDocuments()

List<DashboardDocumentResult>

Returns a list of the last week top documents modified.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getLastWeekTopModifiedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastMonthTopModifiedDocuments

Description:

MethodReturn valuesDescription

getLastMonthTopModifiedDocuments()

List<DashboardDocumentResult>

Returns a list of the last month top documents modified.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getLastMonthTopModifiedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastModifiedDocuments

Description:

MethodReturn valuesDescription

getLastModifiedDocuments()

List<DashboardDocumentResult>

Returns a list of the last documents modified.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getLastModifiedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastUploadedDocuments

Description:

MethodReturn valuesDescription

getLastUploadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last documents uploaded.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardDocumentResult;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        try {
            List<DashboardDocumentResult> dashboardDocumentResults = ws.getLastUploadedDocuments();
            for (DashboardDocumentResult dashboardDocumentResult : dashboardDocumentResults) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}