1. Home
  2. SDK for Java 3.7
  3. FilePlan samples
  1.  

SDK for Java 3.7
Sample client
Basic concepts
Activity samples
Auth samples
Bookmark samples
Conversion samples
Dashboard samples
Document samples
FilePlan samples
Folder samples
Import samples
Mail samples
Node samples
Note samples
Notification samples
Plugin samples
Property samples
PropertyGroup samples
Record samples
Relation samples
Repository samples
Report samples
Stamp samples
Search samples
Workflow samples
Task samples

FilePlan samples

Methods

getRootSections

Description:

MethodReturn valuesDescription

getRootSections()

List<NodeClassSectionDefinition>

Returns a list of the NodeClassSectionDefinition.

Example:

package com.openkm;

import java.util.List;

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

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.getRootSections();
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRootSectionsFilteredBySecurity

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;

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.getRootSectionsFilteredBySecurity(Permission.ALL_GRANTS);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenSections

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;

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.getChildrenSections(parentId);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenSectionsFilteredBySecurity

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;

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.getChildrenSectionsFilteredBySecurity(parentId, Permission.READ + Permission.WRITE);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenClasses

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;

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.getChildrenClasses(sectionId);
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenClassesFilteredBySecurity

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;

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.getChildrenClassesFilteredBySecurity(sectionId, Permission.WRITE);
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findNodeClassByPk

Description:

MethodReturn valuesDescription

findNodeClassByPk(long id)

NodeClass

Return a NodeClass.

Example:

package com.openkm;

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

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.findNodeClassByPk(id);
            System.out.println(nodeClass);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findElectronicRecordClasses

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;

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.findElectronicRecordClasses();
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findElectronicRecordClassesFilteredBySecurity

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;

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.findElectronicRecordClassesFilteredBySecurity(Permission.ALL_GRANTS);
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findFilteredByCodeOrNameFilteredBySecurity

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;

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.findFilteredByCodeOrNameFilteredBySecurity("1.", "", Permission.ALL_GRANTS);
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findSectionFiltered

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;

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.findSectionFiltered("1.", "invoice", Permission.ALL_GRANTS);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findElectronicRecordClasses

Description:

MethodReturn valuesDescription

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.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;

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.getNodeClassBreadcrumb(sectionId);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findAllNodeClasses

Description:

MethodReturn valuesDescription

findAllNodeClasses()

List<NodeClass>

Returns a list of the NodeClass.

Example:

package com.openkm;

import java.util.List;

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

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.findAllNodeClasses();
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

© OpenKM kcenter v.1.0.0 (build: d51a7b0). All Rights Reserved. Documentation license