OKMNote
Basics
On most methods you'll see parameter named "nodeId". The value of this parameter can be a valid document, folder, mail or record UUID.
Example of nodeId:
- Using UUID -> "b153c4b7-3d1c-4589-bd42-0ed0f34fd338";
Also on all methods you'll see parameter named "token". Because the Cron Task are executed in background without authentication, the methods used in this scenario might use the token parameter. From default application execution context you must use "null" value what indicates to the application must use the "user session".
On special cases you might be "promoted as Administrator" using the "administrator token".
String systemToken = DbSessionManager.getInstance().getSystemToken();Methods
add
Description:
| Method | Return values | Description |
|---|---|---|
|
add(String token, String nodeId, String text) |
Note |
Adds a note to a node and returns an object Note. |
Example:
package com.openkm;
import com.openkm.api.OKMNote;
import com.openkm.bean.Note;
import com.openkm.util.ContextWrapper;
public class Test {
public static void main(String[] args) {
try {
OKMNote okmNote = ContextWrapper.getContext().getBean(OKMNote.class);
Note note = okmNote.add(null, "f123a950-0329-4d62-8328-0ff500fd42db", "the note text");
System.out.println(note);
} catch (Exception e) {
e.printStackTrace();
}
}
}
get
Description:
| Method | Return values | Description |
|---|---|---|
|
get(String token, String noteId) |
Note |
Retrieves the note. |
|
The noteId is an UUID. The object Node has a variable named path, in that case the path contains an UUID.
|
||
Example:
package com.openkm;
import com.openkm.api.OKMNote;
import com.openkm.bean.Note;
import com.openkm.util.ContextWrapper;
public class Test {
public static void main(String[] args) {
try {
OKMNote okmNote = ContextWrapper.getContext().getBean(OKMNote.class);
for (Note note : okmNote.list(null, "f123a950-0329-4d62-8328-0ff500fd42db")) {
Note data = okmNote.get(null, note.getPath());
System.out.println(data);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
delete
Description:
| Method | Return values | Description |
|---|---|---|
|
delete(String token, String noteId) |
void |
Delete a note. |
|
The noteId is an UUID. The object Node has a variable named path, in that case the path contains an UUID. |
||
Example:
package com.openkm;
import com.openkm.api.OKMNote;
import com.openkm.bean.Note;
import com.openkm.util.ContextWrapper;
public class Test {
public static void main(String[] args) {
try {
OKMNote okmNote = ContextWrapper.getContext().getBean(OKMNote.class);
for (Note note : okmNote.list(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338")) {
okmNote.delete(null, note.getPath());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}set
Description:
| Method | Return values | Description |
|---|---|---|
|
set(String token, String noteId, String text) |
void |
Changes the note text. |
|
The noteId is an UUID. The object Node has a variable named path, in that case the path contains an UUID. |
||
Example:
package com.openkm;
import com.openkm.api.OKMNote;
import com.openkm.bean.Note;
import com.openkm.util.ContextWrapper;
public class Test {
public static void main(String[] args) {
try {
OKMNote okmNote = ContextWrapper.getContext().getBean(OKMNote.class);
for (Note note : okmNote.list(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338")) {
okmNote.set(null, note.getPath(), "new note");
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
list
Description:
| Method | Return values | Description |
|---|---|---|
|
list(String token, String nodeId) |
List<Note> |
Retrieves a list of all the notes of a node. |
Example:
package com.openkm;
import com.openkm.api.OKMNote;
import com.openkm.bean.Note;
import com.openkm.util.ContextWrapper;
public class Test {
public static void main(String[] args) {
try {
OKMNote okmNote = ContextWrapper.getContext().getBean(OKMNote.class);
for (Note note : okmNote.list(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338")) {
System.out.println(note);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
getNoteHistories
Description:
| Method | Return values | Description |
|---|---|---|
|
getNoteHistories(String token, String nodeId) |
List<NoteHistory> |
Return the historical notes of a node. |
Example:
package com.openkm;
import com.openkm.api.OKMNote;
import com.openkm.bean.NoteHistory;
import com.openkm.util.ContextWrapper;
public class Test {
public static void main(String[] args) {
try {
OKMNote okmNote = ContextWrapper.getContext().getBean(OKMNote.class);
for (NoteHistory noteHistory : okmNote.getNoteHistories(null, "3c68b3a1-c65c-4b1e-84b5-9ce2712ca573")) {
System.out.println(noteHistory);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
