Dashboard samples
Basics
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);
Once you are logged with the webservices the session is keep in the webservice Object. Then you can use the other API method
At this point you can use all the Dashboard methods from "dasboard" class as is shown below:
ws.dashboard.getUserCheckedOutDocuments();
Methods
getUserCheckedOutDocuments
Description:
Method | Return values | Description |
---|---|---|
getUserCheckedOutDocuments() |
List<DashboardResult> |
Returns a list of the documents in edition by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserCheckedOutDocuments();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserLastModifiedDocuments
Description:
Method | Return values | Description |
---|---|---|
getUserLastModifiedDocuments() |
List<DashboardResult> |
Returns a list of the last documents modified by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserCheckedOutDocuments();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserLockedDocuments
Description:
Method | Return values | Description |
---|---|---|
getUserLockedDocuments() |
List<DashboardResult> |
Returns a list of the documents locked by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserLockedDocuments();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
//
getUserLockedRecords
Description:
Method | Return values | Description |
---|---|---|
getUserLockedRecords() |
List<DashboardResult> |
Returns a list of the records locked by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserLockedRecords();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserSubscribedDocuments
Description:
Method | Return values | Description |
---|---|---|
getUserSubscribedDocuments() |
List<DashboardResult> |
Returns a list of the documents subscribed by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserSubscribedDocuments();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserSubscribedFolders
Description:
Method | Return values | Description |
---|---|---|
getUserSubscribedFolders() |
List<DashboardResult> |
Returns a list of the folders subscribed by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserSubscribedFolders();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserSubscribedRecords
Description:
Method | Return values | Description |
---|---|---|
getUserSubscribedRecords() |
List<DashboardResult> |
Returns a list of the records subscribed by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.getUserSubscribedRecords();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserLastCreatedDocuments
Description:
Method | Return values | Description |
---|---|---|
getUserLastCreatedDocuments() |
List<DashboardResult> |
Returns a list of the last documents created by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserLastCreatedDocuments();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserLastCreatedFolders
Description:
Method | Return values | Description |
---|---|---|
getUserLastCreatedFolders() |
List<DashboardResult> |
Returns a list of the last folders created by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserLastCreatedFolders();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserLastCreatedRecords
Description:
Method | Return values | Description |
---|---|---|
getUserLastCreatedRecords() |
List<DashboardResult> |
Returns a list of the last records created by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserLastCreatedRecords();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserLastDownloadedDocuments
Description:
Method | Return values | Description |
---|---|---|
getUserLastDownloadedDocuments() |
List<DashboardResult> |
Returns a list of the last documents downloaded by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserLastDownloadedDocuments();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserLastImportedMails
Description:
Method | Return values | Description |
---|---|---|
getUserLastImportedMails() |
List<DashboardResult> |
Returns a list of the last mails imported by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserLastImportedMails();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserLastImportedMailAttachments
Description:
Method | Return values | Description |
---|---|---|
getUserLastImportedMailAttachments() |
List<DashboardResult> |
Returns a list of the last mails imported with attachments by the user. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardResult;
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);
List<DashboardResult> results = ws.dashboard.getUserLastImportedMailAttachments();
for (DashboardResult dashboardResult : results) {
System.out.println(dashboardResult.getNode());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getUserSearches
Description:
Method | Return values | Description |
---|---|---|
getUserSearches() |
List<QueryParams> |
Returns a list of the searches saved by the user as user news. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.QueryParams;
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);
List<QueryParams> results = ws.dashboard.getUserSearches();
for (QueryParams userSearch : results) {
System.out.println(userSearch);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
findUserSearches
Description:
Method | Return values | Description |
---|---|---|
findUserSearches(long qpId) |
List<DashboardNodeResult> |
Returns a list of nodes based in a search saved by the user ( search of type user news ). |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.DashboardNodeResult;
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 qpId = 1;
List<DashboardNodeResult> results = ws.dashboard.findUserSearches(qpId);
for (DashboardNodeResult nodeResult : results) {
System.out.println(nodeResult);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}