FilePlan 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 FilePlan methods from "filePlan" class as is shown below:
ws.filePlan.getRootSections();
Methods
getRootSections
Description:
Method | Return values | Description |
---|---|---|
getRootSections() |
List<NodeClassSectionDefinition> |
Returns a list of the NodeClassSectionDefinition. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
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<NodeClassSectionDefinition> list = ws.filePlan.getRootSections();
for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
System.out.println(nodeClassSectionDefinition);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getRootSectionsFilteredBySecurity
Description:
Method | Return values | Description |
---|---|---|
getRootSectionsFilteredBySecurity(int permissions) |
List<NodeClassSectionDefinition> |
Returns a list of the NodeClassSectionDefinition by permissions. |
The class com.openkm.sdk4j.bean.Permission contains permission values ( READ, WRITE, etc. ). You should use it in combination with methods that are changing or getting security grants.
|
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;
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<NodeClassSectionDefinition> list = ws.filePlan.getRootSectionsFilteredBySecurity(Permission.ALL_GRANTS);
for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
System.out.println(nodeClassSectionDefinition);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getChildrenSections
Description:
Method | Return values | Description |
---|---|---|
getChildrenSections(long parentId) |
List<NodeClassSectionDefinition> |
Returns a list of the NodeClassSectionDefinition by parent section. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
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);
int parentId = 1;
List<NodeClassSectionDefinition> list = ws.filePlan.getChildrenSections(parentId);
for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
System.out.println(nodeClassSectionDefinition);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getChildrenSectionsFilteredBySecurity
Description:
Method | Return values | Description |
---|---|---|
getChildrenSectionsFilteredBySecurity(long parentId, int permissions) |
List<NodeClassSectionDefinition> |
Returns a list of the NodeClassSectionDefinition by parent section and permissions. |
The class com.openkm.sdk4j.bean.Permission contains permission values ( READ, WRITE, etc. ). You should use it in combination with methods that are changing or getting security grants. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;
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);
int parentId = 4;
List<NodeClassSectionDefinition> list = ws.filePlan.getChildrenSectionsFilteredBySecurity(parentId, Permission.READ + Permission.WRITE);
for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
System.out.println(nodeClassSectionDefinition);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getChildrenClasses
Description:
Method | Return values | Description |
---|---|---|
getChildrenClasses(long sectionId) |
List<NodeClass> |
Returns a list of the NodeClass by section. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
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);
int sectionId = 3;
List<NodeClass> list = ws.filePlan.getChildrenClasses(sectionId);
for (NodeClass nodeClass : list) {
System.out.println(nodeClass);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getChildrenClassesFilteredBySecurity
Description:
Method | Return values | Description |
---|---|---|
getChildrenClassesFilteredBySecurity(long sectionId, int permissions) |
List<NodeClass> |
Returns a list of the NodeClass by section and permissions. |
The class com.openkm.sdk4j.bean.Permission contains permission values ( READ, WRITE, etc. ). You should use it in combination with methods that are changing or getting security grants. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;
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);
int sectionId = 3;
List<NodeClass> list = ws.filePlan.getChildrenClassesFilteredBySecurity(sectionId, Permission.WRITE);
for (NodeClass nodeClass : list) {
System.out.println(nodeClass);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
findNodeClassByPk
Description:
Method | Return values | Description |
---|---|---|
findNodeClassByPk(long id) |
NodeClass |
Return a NodeClass. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
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);
int id = 4;
NodeClass nodeClass = ws.filePlan.findNodeClassByPk(id);
System.out.println(nodeClass);
} catch (Exception e) {
e.printStackTrace();
}
}
}
findElectronicRecordClasses
Description:
Method | Return values | Description |
---|---|---|
findElectronicRecordClasses() |
List<NodeClass> |
Returns a list of the NodeClass what are Elecrronic Records. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
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<NodeClass> list = ws.filePlan.findElectronicRecordClasses();
for (NodeClass nodeClass : list) {
System.out.println(nodeClass);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
findElectronicRecordClassesFilteredBySecurity
Description:
Method | Return values | Description |
---|---|---|
findElectronicRecordClassesFilteredBySecurity(int permissions) |
List<NodeClass> |
Returns a list of the NodeClass by section and permissions what are Electronic Records. |
The class com.openkm.sdk4j.bean.Permission contains permission values ( READ, WRITE, etc. ). You should use it in combination with methods that are changing or getting security grants. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;
import com.openkm.sdk4j.impl.OKMWebservices;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8090/openkm";
String user = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try {
ws.login(user, password);
List<NodeClass> list = ws.filePlan.findElectronicRecordClassesFilteredBySecurity(Permission.ALL_GRANTS);
for (NodeClass nodeClass : list) {
System.out.println(nodeClass);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
findFilteredByCodeOrNameFilteredBySecurity
Description:
Method | Return values | Description |
---|---|---|
findFilteredByCodeOrNameFilteredBySecurity(String code, String name, int permissions) |
List<NodeClass> |
Returns a list of the NodeClass by code, name and permissions. |
The class com.openkm.sdk4j.bean.Permission contains permission values ( READ, WRITE, etc. ). You should use it in combination with methods that are changing or getting security grants. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;
import com.openkm.sdk4j.impl.OKMWebservices;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8090/openkm";
String user = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try {
ws.login(user, password);
List<NodeClass> list = ws.filePlan.findFilteredByCodeOrNameFilteredBySecurity("1.", "", Permission.ALL_GRANTS);
for (NodeClass nodeClass : list) {
System.out.println(nodeClass);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
findSectionFiltered
Description:
Method | Return values | Description |
---|---|---|
findSectionFiltered(String code, String name, int permissions) |
List<NodeClassSectionDefinition> |
Returns a list of the NodeClassSectionDefinition by code, name and permissions. |
The class com.openkm.sdk4j.bean.Permission contains permission values ( READ, WRITE, etc. ). You should use it in combination with methods that are changing or getting security grants. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;
import com.openkm.sdk4j.impl.OKMWebservices;
public class Test {
public static void main(String[] args) {
String host = "http://localhost:8090/openkm";
String user = "okmAdmin";
String password = "admin";
OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try {
ws.login(user, password);
List<NodeClassSectionDefinition> list = ws.filePlan.findSectionFiltered("1.", "invoice", Permission.ALL_GRANTS);
for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
System.out.println(nodeClassSectionDefinition);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getNodeClassBreadcrumb
Description:
Method | Return values | Description |
---|---|---|
getNodeClassBreadcrumb(long sectionId) |
List<NodeClassSectionDefinition> |
Returns a list of the NodeClassSectionDefinition what are Electronic Records. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
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);
int sectionId = 3;
List<NodeClassSectionDefinition> list = ws.filePlan.getNodeClassBreadcrumb(sectionId);
for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
System.out.println(nodeClassSectionDefinition);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
findAllNodeClasses
Description:
Method | Return values | Description |
---|---|---|
findAllNodeClasses() |
List<NodeClass> |
Returns a list of the NodeClass. |
Example:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
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<NodeClass> list = ws.filePlan.findAllNodeClasses();
for (NodeClass nodeClass : list) {
System.out.println(nodeClass);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getRootSectionsIdWithChildren
Description:
Method | Return values | Description |
---|---|---|
getRootSectionsIdWithChildren() |
List<Long> |
Returns a list of the section ids what have childs and parent is root. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;
import java.util.List;
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<Long> list = ws.filePlan.getRootSectionsIdWithChildren();
for (long id : list) {
System.out.println(id);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getChildrenSectionsIdByTenantWithChildren
Description:
Method | Return values | Description |
---|---|---|
getChildrenSectionsIdByTenantWithChildren(long parendId) |
List<Long> |
Returns a list of the section ids what have childs with parent equals to parentId and filtered by tenant. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;
import java.util.List;
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 parentId = 1;
List<Long> list = ws.filePlan.getChildrenSectionsIdByTenantWithChildren(parentId);
for (long id : list) {
System.out.println(id);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}