BaseRecord (OpenKM SDK for Java 3.14 API)

All Known Implementing Classes:

OKMWebservices, RecordImpl
```
public interface BaseRecord
```
BaseRecord

Author:

jllort

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Record`	`copyRecord(String uuid, String dstId, String newName)`
`Record`	`createRecord(String uuid, String name, String title, long nodeClass)`
`Record`	`createRecordFromTemplate(String uuid, String dstPath, String language, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, Map<String,String> properties)`
`Record`	`createRecordFromTemplate(String uuid, String dstPath, String language, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, Map<String,String> properties)`
`WizardNode`	`createWizardRecord(String uuid, String name, String title, long nodeClass)`
`void`	`deleteRecord(String uuid)`
`Record`	`extendedRecordCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)`
`Record`	`extendedRecordCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, boolean security)`
`LockInfo`	`forceLockRecord(String uuid)`
`void`	`forceUnlockRecord(String uuid)`
`List<Record>`	`getRecordChildren(String uuid)`
`String`	`getRecordPath(String uuid)`
`Record`	`getRecordProperties(String uuid)`
`boolean`	`isValidRecord(String uuid)`
`LockInfo`	`lockRecord(String uuid)`
`void`	`moveRecord(String uuid, String dstId)`
`void`	`purgeRecord(String uuid)`
`Record`	`renameRecord(String uuid, String newName)`
`void`	`setRecordDescription(String uuid, String description)`
`void`	`setRecordDispositionStage(String uuid, long stage)`
`void`	`setRecordNodeClass(String uuid, long ncId)`
`void`	`setRecordTitle(String uuid, String title)`
`void`	`unlockRecord(String uuid)`

Method Detail

createRecord

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; ItemExistsException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

getRecordProperties

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

deleteRecord

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

Throws:: AutomationException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknownException; WebserviceException

purgeRecord

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

Throws:: LockException; AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; ExtensionException; PromotedAsRecordLockException; UnknownException; WebserviceException

renameRecord

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; ItemExistsException; PromotedAsRecordLockException; LockException; UnknownException; WebserviceException

moveRecord

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

Throws:: LockException; PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; PromotedAsRecordLockException; FilePlanCatalogManagerException; AutomationException; VersionException; UnknownException; WebserviceException

copyRecord

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

Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

isValidRecord

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

Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getRecordChildren

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

lockRecord

LockInfo lockRecord(String uuid)
             throws LockException,
                    PathNotFoundException,
                    AccessDeniedException,
                    RepositoryException,
                    DatabaseException,
                    UnknownException,
                    WebserviceException

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

forceLockRecord

LockInfo forceLockRecord(String uuid)
                  throws LockException,
                         PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

unlockRecord

void unlockRecord(String uuid)
           throws LockException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  UnknownException,
                  WebserviceException

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

forceUnlockRecord

void forceUnlockRecord(String uuid)
                throws LockException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       UnknownException,
                       WebserviceException

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

setRecordTitle

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

Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknownException; WebserviceException

setRecordNodeClass

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

Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknownException; WebserviceException

getRecordPath

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

Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

setRecordDispositionStage

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

Throws:: PathNotFoundException; AccessDeniedException; DatabaseException; WebserviceException; UnknownException

setRecordDescription

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

Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; WebserviceException; UnknownException

createWizardRecord

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

Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; AutomationException; PromotedAsRecordLockException; WebserviceException; ExtensionException; UnknownException

extendedRecordCopy

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

Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UserQuotaExceededException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

extendedRecordCopy

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

Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UserQuotaExceededException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

createRecordFromTemplate

Record createRecordFromTemplate(String uuid,
                                String dstPath,
                                String language,
                                boolean categories,
                                boolean keywords,
                                boolean propertyGroups,
                                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

Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; TemplateException; DocumentTemplateException; ItemExistsException; AutomationException; FilePlanException; PromotedAsRecordLockException; ParseException; NoSuchGroupException; NoSuchPropertyException; LockException; ValidationFormException; ClassNotFoundException; UnknownException; WebserviceException

createRecordFromTemplate

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

Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; TemplateException; DocumentTemplateException; ItemExistsException; AutomationException; FilePlanException; PromotedAsRecordLockException; ParseException; NoSuchGroupException; NoSuchPropertyException; LockException; ValidationFormException; ClassNotFoundException; UnknownException; WebserviceException

Interface BaseRecord

Method Summary

Method Detail

createRecord

getRecordProperties

deleteRecord

purgeRecord

renameRecord

moveRecord

copyRecord

isValidRecord

getRecordChildren

lockRecord

forceLockRecord

unlockRecord

forceUnlockRecord

setRecordTitle

setRecordNodeClass

getRecordPath

setRecordDispositionStage

setRecordDescription

createWizardRecord

extendedRecordCopy

extendedRecordCopy

createRecordFromTemplate

createRecordFromTemplate