OKMBookmark

Used for managing bookmarks of users. For example add or remove bookmark of a node for a user. 

Basics

On almost methods you'll see parameter named "nodePath". The value of this parameter can be some valid node path ( folder, document, mail ).

Also 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 "null" value what indicates to the application must use the "user session".

String systemToken = DbSessionManager.getInstance().getSystemToken();

Methods

add

Description:

Example:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.dao.bean.Bookmark;

public class Test {
    public static void main(String[] args) {
        try {
            Bookmark bookmark = OKMBookmark.getInstance().add(null, "/okm:root/document.doc", "document.doc");
            System.out.println(bookmark);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

get

Description:

Example:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.dao.bean.Bookmark;

public class Test {
    public static void main(String[] args) {
        try {
            int bmId = 23;
            Bookmark bookmark = OKMBookmark.getInstance().get(null, bmId);
            System.out.println(bookmark);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAll

Description:

Example:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.dao.bean.Bookmark;

public class Test {
    public static void main(String[] args) {
        try {
            for (Bookmark bookmark : OKMBookmark.getInstance().getAll(null)) {
                System.out.println(bookmark);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

remove

Description:

Example:

package com.openkm;

import com.openkm.api.OKMBookmark;

public class Test {
    public static void main(String[] args) {
        try {
            int bmId = 23;
            OKMBookmark.getInstance().remove(null, bmId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

rename

Description:

Example:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.dao.bean.Bookmark;

public class Test {
    public static void main(String[] args) {
        try {
            int bmId = 23;
            Bookmark bookmark = OKMBookmark.getInstance().rename(null, bmId, "newname.doc");
            System.out.println(bookmark);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}