1. Home
  2. SDK for Java 2.7
  3. Record samples
  1.  

SDK for Java 2.7
Sample client
Basic concepts
Auth samples
Conversion samples
Document samples
Folder samples
Mail samples
Note samples
Plugin samples
Property samples
PropertyGroup samples
Record samples
Relation samples
Repository samples
Report samples
Search samples
Workflow samples
Troubleshooting

Record samples

On most methods you'll see parameter named "recId". The value of this parameter can be a valid record UUID or path.

Example of recId:

  • Using UUID -> "a66664a3-0e1d-4b03-9049-a2f4732a0802";
  • Using path -> "/okm:root/PKI-100200"

Methods

createRecord

Description:

MethodReturn valuesDescription

createRecord(Record record)

Record

Creates a new record and return as a result an object Record.

The variable path in the parameter record, must be initializated. It indicates the folder path into OpenKM.

Record record = new Record();
record.setPath("/okm:root/PKI-100200");

Optionally it can be set title variable, the other variables of the Record  ( record ) will not take any effect on record creation.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            Record record = new Record();
            record.setPath("/okm:root/PKI-100200");
            record.setTitle("some title");
            ws.createRecord(record);	
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordProperties

Description:

MethodReturn valuesDescription

getRecordProperties(String recId)

Record

Returns the record properties.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            System.out.println(ws.getRecordProperties("/okm:root/PKI-100200"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteRecord

Description:

MethodReturn valuesDescription

deleteRecord(String recId)

void

Deletes a record.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.deleteRecord("/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purgeRecord

Description:

MethodReturn valuesDescription

purgeRecord(String recId)

void

The record is definetivelly removed from repository.

Usually you will purge records to /okm:trash/userId - the personal trash user locations - but is possible to directly purge any record from the whole repository.

When a record is purged it will only be able to be restored from a previously repository backup. The purge action remove the record definitely from the repository.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.purgeRecord("/okm:trash/okmAdmin/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

renameRecord

Description:

MethodReturn valuesDescription

renameRecord(String recId, String newName)

Record

Renames a record.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.renameRecord("/okm:root/PKI-100200", "new_name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

moveRecord

Description:

MethodReturn valuesDescription

moveRecord(String recId, String dstId)

void

Moves a record to a folder or record.
The values of the dstId parameter should be a folder or record UUID or path.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.moveRecord("/okm:root/PKI-100200", "/okm:root/tmp");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copyRecord

Description:

MethodReturn valuesDescription

copyRecord(String recId, String dstId, String newName)

void

Copies a record to a folder or record.

The values of the dstId parameter should be a folder or record UUID or path.

When the parameter newName value is null, the record will preserve the same name.

Only the security grants are copied to the destination, the metadata, keywords, etc. of the record are not copied.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.copyRecord("/okm:root/PKI-100200", "/okm:root/tmp", "new_name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValidRecord

Description:

MethodReturn valuesDescription

isValidRecord(String recId)

Boolean

Returns a boolean that indicate if the node is a record or not.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            System.out.println("Is a record:" + ws.isValidRecord("/okm:root/PKI-100200"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordChildren

Description:

MethodReturn valuesDescription

getRecordChildren(String fldId)

List<Record>

Returns a list of all records which their parent is fldId
The parameter fldId can be a folder or a record node.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            for (Record rec : ws.getRecordChildren("/okm:root/folder")) {
                System.out.println(rec);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

lockRecord

Description:

MethodReturn valuesDescription

lockRecord(String recId)

LockInfo

Locks a record and return an object with the Lock information

Only the user who locked the record is allowed to unlock.

A locked record can not be modified by other users.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.lockRecord("/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unlockRecord

Description:

MethodReturn valuesDescription

unlockRecord(String recId)

void

Unlock a locked record.

Only the user who locked the document is allowed to unlock.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.unlockRecord("/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

forceUnlockRecord

Description:

MethodReturn valuesDescription

forceUnlockRecord(String recId)

void

Unlocks a locked record.

This method allows to unlock any locked record.

It is not mandatory to execute this action by the same user who previously executed the checkout lock action.

This action can only be done by a super user ( user with ROLE_ADMIN ).

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.forceUnlockRecord("/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setRecordTitle

Description:

MethodReturn valuesDescription

setRecordTitle(String recId, String title)

void

Sets a record title.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            ws.setRecordTitle("/okm:root/PKI-100200","some title");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordPath

Description:

MethodReturn valuesDescription

getRecordPath(String uuid)

String

Converts a record UUID to a record path.

Example:

package com.openkm;

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

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);
        
        try {
            System.out.println(ws.getRecordPath("a66664a3-0e1d-4b03-9049-a2f4732a0802"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

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