Wizard Samples
Basics
Example of UUID:
- Using UUID -> "373bcdd0-c082-4e7b-addd-e10ef813946e";
Suggested code sample
First, you must create the web service object:
OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
Then you should log in using the method "login". You can access the "login" method from the web service object "ws" as shown below:
ws.login(user, password);Once you are logged in to the web services, the session is kept in the web service object. Then you can use the other API methods.
At this point you can use all the Wizard methods from the "wizard" class as shown below:
ws.wizard.findByUser();Methods
findByUser
Description:
| Method | Return values | Description |
|---|---|---|
|
findByUser() |
List<WizardNode> |
Returns a list of nodes with a wizard. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.WizardNode;
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<WizardNode> list = ws.wizard.findByUser();
for (WizardNode wizardNode : list) {
System.out.println(wizardNode);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
findByUserAndUuid
Description:
| Method | Return values | Description |
|---|---|---|
|
findByUserAndUuid(String uuid) |
WizardNode |
Gets the wizard of a node. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.WizardNode;
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);
WizardNode wizardNode = ws.wizard.findByUserAndUuid("11225723-883f-4c12-8816-650b2c82c89b");
System.out.println(wizardNode);
} catch (Exception e) {
e.printStackTrace();
}
}
}hasWizardByUserAndNode
Description:
| Method | Return values | Description |
|---|---|---|
|
hasWizardByUserAndNode(String uuid) |
boolean |
Checks if a node has a wizard. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
System.out.println("The node has a wizard: " + ws.wizard.hasWizardByUserAndNode("11225723-883f-4c12-8816-650b2c82c89b"));
} catch (Exception e) {
e.printStackTrace();
}
}
}deleteAll
Description:
| Method | Return values | Description |
|---|---|---|
|
deleteAll() |
void |
Removes all wizards of the user. |
|
Only wizards assigned to the user session will be removed.
|
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
ws.wizard.deleteAll();
System.out.println("Delete all");
} catch (Exception e) {
e.printStackTrace();
}
}
}
addShowWizardCategories
Description:
| Method | Return values | Description |
|---|---|---|
|
addShowWizardCategories(String uuid, int order) |
void |
Adds show wizard categories in the wizard of a node. |
|
The parameter order is the position of the action in the wizard. |
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
ws.wizard.removeDigitalSignature("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae", 0);
System.out.println("removeDigitalSignature");
} catch (Exception e) {
e.printStackTrace();
}
}
}
removeShowWizardCategories
Description:
| Method | Return values | Description |
|---|---|---|
|
removeShowWizardCategories(String uuid) |
void |
Removes show wizard categories in the wizard of a node. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
ws.wizard.removeShowWizardCategories("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
System.out.println("removeShowWizardCategories");
} catch (Exception e) {
e.printStackTrace();
}
}
}
addShowWizardKeywords
Description:
| Method | Return values | Description |
|---|---|---|
|
addShowWizardKeywords(String uuid, int order) |
void |
Adds show wizard keywords in the wizard of a node. |
|
The parameter order is the position of the action in the wizard. |
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
ws.wizard.addShowWizardKeywords("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae", 0);
System.out.println("addShowWizardKeywords");
} catch (Exception e) {
e.printStackTrace();
}
}
}
removeShowWizardKeywords
Description:
| Method | Return values | Description |
|---|---|---|
|
removeShowWizardKeywords(String uuid) |
void |
Removes show wizard keywords in the wizard of a node. |
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
ws.wizard.removeShowWizardKeywords("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
System.out.println("removeShowWizardKeywords");
} catch (Exception e) {
e.printStackTrace();
}
}
}
addGroup
Description:
| Method | Return values | Description |
|---|---|---|
|
addGroup(String uuid, String group, int order) |
void |
Adds a metadata group in the wizard. |
|
The parameter uuid is the unique node identifier. The parameter group is the group name. The parameter order is the position of the action in the wizard.
|
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
ws.wizard.addGroup("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae", "okg:tpl", 0);
System.out.println("addGroup");
} catch (Exception e) {
e.printStackTrace();
}
}
}
removeGroup
Description:
| Method | Return values | Description |
|---|---|---|
|
removeGroup(String uuid, String group) |
void |
Removes a metadata group in the wizard. |
|
The parameter uuid is the unique node identifier. The parameter group is the group name.
|
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
ws.wizard.removeGroup("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae", "okg:tpl");
System.out.println("removeGroup");
} catch (Exception e) {
e.printStackTrace();
}
}
}setAutostart
Description:
| Method | Return values | Description |
|---|---|---|
|
setAutostart |
void |
Sets autostart for the wizard. |
|
Autostart should always be set as the last wizard option.
|
||
Example:
package com.openkm;
import com.openkm.sdk4j.OKMWebservicesFactory;
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);
ws.wizard.setAutostart("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
System.out.println("setAutostart");
} catch (Exception e) {
e.printStackTrace();
}
}
}
