SaDocumentInfo (JCS Classic Connector Module 8.2.0-0 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

SaDocumentInfoImpl
```
public interface SaDocumentInfo
extends Serializable
```
Document info interface.

Represents the information of a document from the database. No medium information are read.
Holds the information about a document which was returned from the backend system by using one of the following Classic Connector get or search functions:

SaClassicConnector.getDocumentFolders(String, String, String) SaClassicConnector.getFolderChildren(String, String, int, SaQueryInfo, int) SaClassicConnector.getFolderFromPath(String, String, String) SaClassicConnector.getFolderInfo(String, String, boolean) SaClassicConnector.getFolderInfo(String, String) SaClassicConnector.getFolderParent(String, String) SaClassicConnector.searchFolderDocuments(String, String, SaQueryInfo) SaClassicConnector.searchHQL(SaQueryInfo)

The document information contains e.g. the following data:
SaPropertyValue[] values; SaLockInfo lockInfo; SaStatusInfo statusInfo; List checkoutInfo;

Author:

rbo

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canEdit()`
`boolean`	`canIndex()`
`boolean`	`canPrint()`
`boolean`	`canSave()`
`boolean`	`canStream()`
`List<SaCheckoutInfo>`	`getCheckoutInfos()`
`String`	`getLockToken()` Returns the lock-token if the document is locked.
`int`	`getLockType()` Returns the lock-type if the document is locked.
`String`	`getLockUser()` Returns the user that has locked this document if the document is locked.
`SaPropertyValue`	`getValue(String name)` Reads the value with the given name.
`SaPropertyValue[]`	`getValues()`
`boolean`	`hasActiveWorkflows()` Returns true, if the document has an active workflow.
`boolean`	`hasObjects()`
`boolean`	`hasRealACL()`
`boolean`	`hasStatus()`
`boolean`	`hasValue(String name)` Check, if a value exists for the given name.
`boolean`	`hasWorkflows()` Returns true if the document has started or finished workflows.
`boolean`	`isCheckedIn()`
`boolean`	`isCheckedout()`
`boolean`	`isDeleted()`
`boolean`	`isLink()`
`boolean`	`isLocked()` Check, if the document is locked.
`boolean`	`isLockedByCurrentUser()` Returns true, if the document represented by this SaDocumentInfo is locked by the current user.
`boolean`	`isOfflineConflict()`
`boolean`	`isReadonly()`
`boolean`	`isRevised()`
`boolean`	`isSigned()`
`void`	`setCheckoutInfo(List<?> rows)`

- Method Detail
  - getValues
```
SaPropertyValue[] getValues()
```
    Returns:
    
    Array of property values
  - getValue
```
SaPropertyValue getValue(String name)
```
    Reads the value with the given name.
    
    Parameters:
    
    name - Property name
    
    Returns:
    
    Property value or null, if not found
  - hasValue
```
boolean hasValue(String name)
```
    Check, if a value exists for the given name.
    
    Parameters:
    
    name - Property name
    
    Returns:
    
    True, if exists
  - isCheckedout
```
boolean isCheckedout()
```
    Returns:
    
    Document is checked out.
  - getCheckoutInfos
```
List<SaCheckoutInfo> getCheckoutInfos()
```
    Returns:
    
    Checkout informations
  - setCheckoutInfo
```
void setCheckoutInfo(List<?> rows)
```
    Parameters:
    
    rows - Checkout rows
  - isLocked
```
boolean isLocked()
```
    Check, if the document is locked.
    Note that locking information will only be available when the document represented by this SaDocumentInfo is contained in a DDC that is located on the default data-source. Use the getLockInfo method of SaClassicConnector to retrieve locking information otherwise.
    
    Returns:
    
    true, if the document is locked
  - getLockToken
```
String getLockToken()
```
    Returns the lock-token if the document is locked.
    Note that locking information will only be available when the document represented by this SaDocumentInfo is contained in a DDC that is located on the default data-source. Use the getLockInfo method of SaClassicConnector to retrieve locking information otherwise.
    
    Returns:
    
    Lock token
    
    See Also:
    
    SaJNILockInfo.getLockToken()
  - getLockType
```
int getLockType()
```
    Returns the lock-type if the document is locked.
    Note that locking information will only be available when the document represented by this SaDocumentInfo is contained in a DDC that is located on the default data-source. Use the getLockInfo method of SaClassicConnector to retrieve locking information otherwise.
    
    Returns:
    
    Lock type
    
    See Also:
    
    SaJNILockInfo.getLockType()
  - getLockUser
```
String getLockUser()
```
    Returns the user that has locked this document if the document is locked.
    Note that locking information will only be available when the document represented by this SaDocumentInfo is contained in a DDC that is located on the default data-source. Use the getLockInfo method of SaClassicConnector to retrieve locking information otherwise.
    
    Returns:
    
    Lock user
    
    See Also:
    
    SaJNILockInfo.getLockUser()
  - isReadonly
```
boolean isReadonly()
```
    Returns:
    
    Is readonly
    
    See Also:
    
    SaJNILockInfo.isReadonly()
  - canEdit
```
boolean canEdit()
```
    Returns:
    
    Editable
    
    See Also:
    
    SaStatusInfo.canEdit()
  - canIndex
```
boolean canIndex()
```
    Returns:
    
    Indexable
    
    See Also:
    
    SaStatusInfo.canIndex()
  - canPrint
```
boolean canPrint()
```
    Returns:
    
    Printable
    
    See Also:
    
    SaStatusInfo.canPrint()
  - canSave
```
boolean canSave()
```
    Returns:
    
    Saveable
    
    See Also:
    
    SaStatusInfo.canSave()
  - hasObjects
```
boolean hasObjects()
```
    Returns:
    
    Has objects
    
    See Also:
    
    SaStatusInfo.hasObjects()
  - hasRealACL
```
boolean hasRealACL()
```
    Returns:
    
    Has real ACL
    
    See Also:
    
    SaStatusInfo.hasRealACL()
  - hasWorkflows
```
boolean hasWorkflows()
```
    Returns true if the document has started or finished workflows.
    
    Returns:
    
    Has workflows
    
    See Also:
    
    SaStatusInfo.hasWorkflows()
  - hasActiveWorkflows
```
boolean hasActiveWorkflows()
```
    Returns true, if the document has an active workflow.
    
    Returns:
    
    has active workflow
  - isCheckedIn
```
boolean isCheckedIn()
```
    Returns:
    
    Is checked in
    
    See Also:
    
    SaStatusInfo.isCheckedIn()
  - isDeleted
```
boolean isDeleted()
```
    Returns:
    
    Is deleted
    
    See Also:
    
    SaStatusInfo.isDeleted()
  - isLink
```
boolean isLink()
```
    Returns:
    
    Is link
    
    See Also:
    
    SaStatusInfo.isLink()
  - isRevised
```
boolean isRevised()
```
    Returns:
    
    Is revised
    
    See Also:
    
    SaStatusInfo.isRevised()
  - hasStatus
```
boolean hasStatus()
```
    Returns:
    
    Has status informations
  - isOfflineConflict
```
boolean isOfflineConflict()
```
    Returns:
    
    Document is in offline-conflict-state
  - isSigned
```
boolean isSigned()
```
    Returns:
    
    Document is signed
  - canStream
```
boolean canStream()
```
    Returns:
    
    Document can be streamed
  - isLockedByCurrentUser
```
boolean isLockedByCurrentUser()
```
    Returns true, if the document represented by this SaDocumentInfo is locked by the current user.
    Note that locking information will only be available when the document represented by this SaDocumentInfo is contained in a DDC that is located on the default data-source. Use the getLockInfo method of SaClassicConnector to retrieve locking information otherwise.
    
    Returns:
    
    true, if locked by current user

Interface SaDocumentInfo

Method Summary

Method Detail

getValues

getValue

hasValue

isCheckedout

getCheckoutInfos

setCheckoutInfo

isLocked

getLockToken

getLockType

getLockUser

isReadonly

canEdit

canIndex

canPrint

canSave

hasObjects

hasRealACL

hasWorkflows

hasActiveWorkflows

isCheckedIn

isDeleted

isLink

isRevised

hasStatus

isOfflineConflict

isSigned

canStream

isLockedByCurrentUser