com.openkm.sdk4j.impl

Class RecordImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.RecordImpl

All Implemented Interfaces:

BaseRecord, Serializable

public class RecordImpl
extends ClientImpl
implements BaseRecord, Serializable

RecordImpl

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RecordImpl(String host) RecordImpl

Method Summary

Modifier and Type	Method and Description
Record	copyRecord(String uuid, String dstId, String newName) Copy record record.
void	createMissingRecords(String recPath) Create missing records.
Record	createRecord(String uuid, String name, String title, long nodeClass) Create record record.
Record	createRecordFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean propertyGroups, boolean security, Map<String,String> properties) Create record from template record.
WizardNode	createWizardRecord(String uuid, String name, String title, long nodeClass) Create wizard record wizard node.
void	deleteRecord(String uuid) Delete record.
Record	extendedRecordCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security) Extended record copy record.
List<Record>	getRecordChildren(String uuid) Gets record children.
String	getRecordPath(String uuid) Gets record path.
Record	getRecordProperties(String uuid) Gets record properties.
boolean	isValidRecord(String uuid) Is valid record boolean.
void	moveRecord(String uuid, String dstId) Move record.
void	purgeRecord(String uuid) Purge record.
Record	renameRecord(String uuid, String newName) Rename record.
void	setAuthorizationToken(String authorizationToken) setAuthenticationToken
void	setRecordDescription(String uuid, String description) Sets record description.
void	setRecordTitle(String uuid, String title) Sets record title.

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, resource, resource, resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecordImpl

public RecordImpl(String host)

RecordImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

createRecord

public Record createRecord(String uuid,
                           String name,
                           String title,
                           long nodeClass)
                    throws AccessDeniedException,
                           RepositoryException,
                           PathNotFoundException,
                           ItemExistsException,
                           DatabaseException,
                           ExtensionException,
                           AutomationException,
                           PromotedAsRecordLockException,
                           UnknownException,
                           WebserviceException

Description copied from interface: BaseRecord

Create record record.

Specified by:

createRecord in interface BaseRecord

Parameters:

uuid - the uuid

name - the name

title - the title

nodeClass - the node class

Returns:

the record

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getRecordProperties

public Record getRecordProperties(String uuid)
                           throws AccessDeniedException,
                                  RepositoryException,
                                  PathNotFoundException,
                                  DatabaseException,
                                  UnknownException,
                                  WebserviceException

Description copied from interface: BaseRecord

Gets record properties.

Specified by:

getRecordProperties in interface BaseRecord

Parameters:

uuid - the uuid

Returns:

the record properties

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteRecord

public void deleteRecord(String uuid)
                  throws AutomationException,
                         LockException,
                         PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         PromotedAsRecordLockException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseRecord

Delete record.

Specified by:

deleteRecord in interface BaseRecord

Parameters:

uuid - the uuid

Throws:

AutomationException - the automation exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

purgeRecord

public void purgeRecord(String uuid)
                 throws LockException,
                        AccessDeniedException,
                        RepositoryException,
                        PathNotFoundException,
                        DatabaseException,
                        ExtensionException,
                        PromotedAsRecordLockException,
                        UnknownException,
                        WebserviceException

Description copied from interface: BaseRecord

Purge record.

Specified by:

purgeRecord in interface BaseRecord

Parameters:

uuid - the uuid

Throws:

LockException - the lock exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

ExtensionException - the extension exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

renameRecord

public Record renameRecord(String uuid,
                           String newName)
                    throws AccessDeniedException,
                           RepositoryException,
                           PathNotFoundException,
                           ItemExistsException,
                           PromotedAsRecordLockException,
                           UnknownException,
                           WebserviceException

Description copied from interface: BaseRecord

Rename record.

Specified by:

renameRecord in interface BaseRecord

Parameters:

uuid - the uuid

newName - the new name

Returns:

the record

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

moveRecord

public void moveRecord(String uuid,
                       String dstId)
                throws LockException,
                       PathNotFoundException,
                       ItemExistsException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       ExtensionException,
                       PromotedAsRecordLockException,
                       FilePlanCatalogManagerException,
                       AutomationException,
                       VersionException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseRecord

Move record.

Specified by:

moveRecord in interface BaseRecord

Parameters:

uuid - the uuid

dstId - the dst id

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

PromotedAsRecordLockException - the promoted as record lock exception

FilePlanCatalogManagerException - the file plan catalog manager exception

AutomationException - the automation exception

VersionException - the version exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

copyRecord

public Record copyRecord(String uuid,
                         String dstId,
                         String newName)
                  throws ItemExistsException,
                         PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         ExtensionException,
                         AutomationException,
                         PromotedAsRecordLockException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseRecord

Copy record record.

Specified by:

copyRecord in interface BaseRecord

Parameters:

uuid - the uuid

dstId - the dst id

newName - the new name

Returns:

the record

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

isValidRecord

public boolean isValidRecord(String uuid)
                      throws PathNotFoundException,
                             AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             UnknownException,
                             WebserviceException

Description copied from interface: BaseRecord

Is valid record boolean.

Specified by:

isValidRecord in interface BaseRecord

Parameters:

uuid - the uuid

Returns:

the boolean

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getRecordChildren

public List<Record> getRecordChildren(String uuid)
                               throws AccessDeniedException,
                                      RepositoryException,
                                      PathNotFoundException,
                                      DatabaseException,
                                      UnknownException,
                                      WebserviceException

Description copied from interface: BaseRecord

Gets record children.

Specified by:

getRecordChildren in interface BaseRecord

Parameters:

uuid - the uuid

Returns:

the record children

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setRecordTitle

public void setRecordTitle(String uuid,
                           String title)
                    throws VersionException,
                           LockException,
                           PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           PromotedAsRecordLockException,
                           UnknownException,
                           WebserviceException

Description copied from interface: BaseRecord

Sets record title.

Specified by:

setRecordTitle in interface BaseRecord

Parameters:

uuid - the uuid

title - the title

Throws:

VersionException - the version exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getRecordPath

public String getRecordPath(String uuid)
                     throws AccessDeniedException,
                            RepositoryException,
                            DatabaseException,
                            UnknownException,
                            WebserviceException

Description copied from interface: BaseRecord

Gets record path.

Specified by:

getRecordPath in interface BaseRecord

Parameters:

uuid - the uuid

Returns:

the record path

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setRecordDescription

public void setRecordDescription(String uuid,
                                 String description)
                          throws VersionException,
                                 LockException,
                                 PathNotFoundException,
                                 AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException,
                                 PromotedAsRecordLockException,
                                 WebserviceException,
                                 UnknownException

Description copied from interface: BaseRecord

Sets record description.

Specified by:

setRecordDescription in interface BaseRecord

Parameters:

uuid - the uuid

description - the description

Throws:

VersionException - the version exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

createWizardRecord

public WizardNode createWizardRecord(String uuid,
                                     String name,
                                     String title,
                                     long nodeClass)
                              throws ItemExistsException,
                                     PathNotFoundException,
                                     AccessDeniedException,
                                     RepositoryException,
                                     DatabaseException,
                                     AutomationException,
                                     PromotedAsRecordLockException,
                                     WebserviceException,
                                     ExtensionException,
                                     UnknownException

Description copied from interface: BaseRecord

Create wizard record wizard node.

Specified by:

createWizardRecord in interface BaseRecord

Parameters:

uuid - the uuid

name - the name

title - the title

nodeClass - the node class

Returns:

the wizard node

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

WebserviceException - the webservice exception

ExtensionException - the extension exception

UnknownException - the unknown exception

extendedRecordCopy

public Record extendedRecordCopy(String uuid,
                                 String dstId,
                                 String newName,
                                 boolean categories,
                                 boolean keywords,
                                 boolean propertyGroups,
                                 boolean notes,
                                 boolean security)
                          throws ItemExistsException,
                                 PathNotFoundException,
                                 AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException,
                                 UserQuotaExceededException,
                                 AutomationException,
                                 PromotedAsRecordLockException,
                                 UnknownException,
                                 WebserviceException

Description copied from interface: BaseRecord

Extended record copy record.

Specified by:

extendedRecordCopy in interface BaseRecord

Parameters:

uuid - the uuid

dstId - the dst id

newName - the new name

categories - the categories

keywords - the keywords

propertyGroups - the property groups

notes - the notes

security - the security

Returns:

the record

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createRecordFromTemplate

public Record createRecordFromTemplate(String uuid,
                                       String dstPath,
                                       boolean categories,
                                       boolean keywords,
                                       boolean notes,
                                       boolean propertyGroups,
                                       boolean security,
                                       Map<String,String> properties)
                                throws PathNotFoundException,
                                       AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       TemplateException,
                                       DocumentTemplateException,
                                       ItemExistsException,
                                       AutomationException,
                                       FilePlanException,
                                       PromotedAsRecordLockException,
                                       ParseException,
                                       NoSuchGroupException,
                                       NoSuchPropertyException,
                                       LockException,
                                       ValidationFormException,
                                       ClassNotFoundException,
                                       UnknownException,
                                       WebserviceException

Description copied from interface: BaseRecord

Create record from template record.

Specified by:

createRecordFromTemplate in interface BaseRecord

Parameters:

uuid - the uuid

dstPath - the dst path

categories - the categories

keywords - the keywords

notes - the notes

propertyGroups - the property groups

security - the security

properties - the properties

Returns:

the record

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

TemplateException - the template exception

DocumentTemplateException - the document template exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

FilePlanException - the file plan exception

PromotedAsRecordLockException - the promoted as record lock exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

NoSuchPropertyException - the no such property exception

LockException - the lock exception

ValidationFormException - the validation form exception

ClassNotFoundException - the class not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createMissingRecords

public void createMissingRecords(String recPath)
                          throws RepositoryException,
                                 DatabaseException,
                                 PathNotFoundException,
                                 ItemExistsException,
                                 AccessDeniedException,
                                 AutomationException,
                                 PromotedAsRecordLockException,
                                 UnknownException,
                                 WebserviceException

Description copied from interface: BaseRecord

Create missing records.

Specified by:

createMissingRecords in interface BaseRecord

Parameters:

recPath - the record path

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception