Package 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:

sochoa

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RecordImpl(String host)	RecordImpl

Method Summary

Modifier and Type	Method	Description
Record	copy(String uuid, String dstId, String newName)	Copy record record.
Record	create(String uuid, String name, String title, long nodeClass)	Create record record.
Record	createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean propertyGroups, boolean security, Map<String,String> properties)	Create from template record.
Record	createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties)	Deprecated. As of sdk4j 4.3, replaced by createFromTemplate(String, String, boolean, boolean, boolean, boolean, boolean, Map)
void	createMissingRecords(String recPath)	Create missing records.
WizardNode	createWizard(String uuid, String name, String title, long nodeClass)	Create wizard record wizard node.
void	delete(String uuid)	Delete record.
Record	extendedCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)	Extended record copy record.
List<Record>	getChildren(String uuid)	Gets record children.
String	getPath(String uuid)	Gets record path.
Record	getProperties(String uuid)	Gets record properties.
boolean	isValid(String uuid)	Is valid record boolean.
void	move(String uuid, String dstId)	Move record.
void	purge(String uuid)	Purge record.
Record	rename(String uuid, String newName)	Rename record.
protected void	setAuthorizationToken(String authorizationToken)	setAuthenticationToken
void	setDescription(String uuid, String description)	Sets record description.
void	setDispositionStage(String uuid, long stage)	Sets record disposition stage.
void	setNodeClass(String uuid, long nodeClass)	Sets record node class.
void	setTitle(String uuid, String title)	Sets record title.

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

getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

Methods inherited from class java.lang.Object

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

Constructor Details

RecordImpl

public RecordImpl(String host)

RecordImpl

Method Details

setAuthorizationToken

protected void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

create

public Record create(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:

create 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

getProperties

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

Description copied from interface: BaseRecord

Gets record properties.

Specified by:

getProperties 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

delete

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

Description copied from interface: BaseRecord

Delete record.

Specified by:

delete 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

purge

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

Description copied from interface: BaseRecord

Purge record.

Specified by:

purge 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

rename

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

Description copied from interface: BaseRecord

Rename record.

Specified by:

rename 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

move

public void move(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:

move 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

copy

public Record copy(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:

copy 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

isValid

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

Description copied from interface: BaseRecord

Is valid record boolean.

Specified by:

isValid 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

getChildren

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

Description copied from interface: BaseRecord

Gets record children.

Specified by:

getChildren 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

setTitle

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

Description copied from interface: BaseRecord

Sets record title.

Specified by:

setTitle 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

setNodeClass

public void setNodeClass(String uuid,
 long nodeClass)
                  throws VersionException,
LockException,
PathNotFoundException,
AccessDeniedException,
RepositoryException,
DatabaseException,
PromotedAsRecordLockException,
UnknownException,
WebserviceException

Description copied from interface: BaseRecord

Sets record node class.

Specified by:

setNodeClass in interface BaseRecord

Parameters:

uuid - the uuid

nodeClass - the nc id

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

setDispositionStage

public void setDispositionStage(String uuid,
 long stage)
                         throws PathNotFoundException,
AccessDeniedException,
DatabaseException,
WebserviceException,
UnknownException

Description copied from interface: BaseRecord

Sets record disposition stage.

Specified by:

setDispositionStage in interface BaseRecord

Parameters:

uuid - the uuid

stage - the stage

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getPath

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

Description copied from interface: BaseRecord

Gets record path.

Specified by:

getPath 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

setDescription

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

Description copied from interface: BaseRecord

Sets record description.

Specified by:

setDescription 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

extendedCopy

public Record extendedCopy(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:

extendedCopy 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

createFromTemplate

public Record createFromTemplate(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 from template record.

Specified by:

createFromTemplate 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

createFromTemplate

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

Deprecated.

As of sdk4j 4.3, replaced by createFromTemplate(String, String, boolean, boolean, boolean, boolean, boolean, Map)

createFromTemplate

Specified by:

createFromTemplate in interface BaseRecord

Parameters:

uuid - the uuid

dstPath - the dst path

categories - the categories

keywords - the keywords

notes - the notes

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

See Also:

• createFromTemplate(String, String, boolean, boolean, boolean, boolean, boolean, Map)

createWizard

public WizardNode createWizard(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:

createWizard 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

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