Package com.openkm.sdk4j.definition

Interface BaseRecord

All Known Implementing Classes:

RecordImpl

public interface BaseRecord

BaseRecord

Author:

sochoa

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.
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.
void	setDescription(String uuid, String description)	Sets record description.
void	setDispositionStage(String uuid, long stage)	Sets record disposition stage.
void	setNodeClass(String uuid, long ncId)	Sets record node class.
void	setTitle(String uuid, String title)	Sets record title.

Method Detail

create

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

Create record record.

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

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

Gets record properties.

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

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

Delete record.

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

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

Purge record.

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

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

Rename record.

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

LockException - the lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

move

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

Move record.

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

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

Copy record record.

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

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

Is valid record boolean.

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

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

Gets record children.

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

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

Sets record title.

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

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

Sets record node class.

Parameters:

uuid - the uuid

ncId - 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

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

Sets record disposition stage.

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

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

Gets record path.

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

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

Sets record description.

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

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

Extended record copy record.

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

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

Create from template record.

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
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.

Create from template record.

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

createWizard

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

Create wizard record wizard node.

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

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

Create missing records.

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