DocumentProperties (Apache Chemistry OpenCMIS 1.1.0)

All Known Subinterfaces:

Document
```
public interface DocumentProperties
```
Accessors to CMIS document properties.

See Also:

CmisObjectProperties

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getCheckinComment()` Returns the checkin comment (CMIS property `cmis:checkinComment`).
`String`	`getContentStreamFileName()` Returns the content stream filename or `null` if the document has no content (CMIS property `cmis:contentStreamFileName`).
`List<ContentStreamHash>`	`getContentStreamHashes()` Returns the content hashes or `null` if the document has no content (CMIS property `cmis:contentStreamHash`).
`String`	`getContentStreamId()` Returns the content stream ID or `null` if the document has no content (CMIS property `cmis:contentStreamId`).
`long`	`getContentStreamLength()` Returns the content stream length or -1 if the document has no content (CMIS property `cmis:contentStreamLength`).
`String`	`getContentStreamMimeType()` Returns the content stream MIME type or `null` if the document has no content (CMIS property `cmis:contentStreamMimeType`).
`String`	`getLatestAccessibleStateId()` Returns the latest accessible state ID or `null` if the repository does not support the Latest State Identifier feature extension (CMIS property `cmis:latestAccessibleStateId` ).
`String`	`getVersionLabel()` Returns the version label (CMIS property `cmis:versionLabel`).
`String`	`getVersionSeriesCheckedOutBy()` Returns the user who checked out this version series (CMIS property `cmis:versionSeriesCheckedOutBy`).
`String`	`getVersionSeriesCheckedOutId()` Returns the PWC ID of this version series (CMIS property `cmis:versionSeriesCheckedOutId`).
`String`	`getVersionSeriesId()` Returns the version series ID (CMIS property `cmis:versionSeriesId` ).
`Boolean`	`isImmutable()` Returns `true` if this document is immutable (CMIS property `cmis:isImmutable`).
`Boolean`	`isLatestMajorVersion()` Returns `true` if this document is the latest major version (CMIS property `cmis:isLatestMajorVersion`).
`Boolean`	`isLatestVersion()` Returns `true` if this document is the latest version (CMIS property `cmis:isLatestVersion`).
`Boolean`	`isMajorVersion()` Returns `true` if this document is a major version (CMIS property `cmis:isMajorVersion`).
`Boolean`	`isPrivateWorkingCopy()` Returns `true` if this document is the PWC (CMIS property `cmis:isPrivateWorkingCopy`).
`Boolean`	`isVersionSeriesCheckedOut()` Returns `true` if this version series is checked out (CMIS property `cmis:isVersionSeriesCheckedOut`).

- Method Detail
  - isImmutable
```
Boolean isImmutable()
```
    Returns true if this document is immutable (CMIS property cmis:isImmutable).
    
    Returns:
    
    the immutable flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - isLatestVersion
```
Boolean isLatestVersion()
```
    Returns true if this document is the latest version (CMIS property cmis:isLatestVersion).
    
    Returns:
    
    the latest version flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - isMajorVersion
```
Boolean isMajorVersion()
```
    Returns true if this document is a major version (CMIS property cmis:isMajorVersion).
    
    Returns:
    
    the major version flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - isLatestMajorVersion
```
Boolean isLatestMajorVersion()
```
    Returns true if this document is the latest major version (CMIS property cmis:isLatestMajorVersion).
    
    Returns:
    
    the latest major version flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - isPrivateWorkingCopy
```
Boolean isPrivateWorkingCopy()
```
    Returns true if this document is the PWC (CMIS property cmis:isPrivateWorkingCopy).
    
    Returns:
    
    the PWC flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    See Also:
    
    Document.isVersionSeriesPrivateWorkingCopy()
    
    CMIS:
    
    1.1
  - getVersionLabel
```
String getVersionLabel()
```
    Returns the version label (CMIS property cmis:versionLabel).
    
    Returns:
    
    the version label of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - getVersionSeriesId
```
String getVersionSeriesId()
```
    Returns the version series ID (CMIS property cmis:versionSeriesId ).
    
    Returns:
    
    the version series ID of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - isVersionSeriesCheckedOut
```
Boolean isVersionSeriesCheckedOut()
```
    Returns true if this version series is checked out (CMIS property cmis:isVersionSeriesCheckedOut).
    
    Returns:
    
    the version series checked out flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - getVersionSeriesCheckedOutBy
```
String getVersionSeriesCheckedOutBy()
```
    Returns the user who checked out this version series (CMIS property cmis:versionSeriesCheckedOutBy).
    
    Returns:
    
    the user who checked out this version series or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - getVersionSeriesCheckedOutId
```
String getVersionSeriesCheckedOutId()
```
    Returns the PWC ID of this version series (CMIS property cmis:versionSeriesCheckedOutId).
    Some repositories provided this value only to the user who checked out the version series.
    
    Returns:
    
    the PWC ID of this version series or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - getCheckinComment
```
String getCheckinComment()
```
    Returns the checkin comment (CMIS property cmis:checkinComment).
    
    Returns:
    
    the checkin comment of this version or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set
    
    CMIS:
    
    1.0
  - getContentStreamLength
```
long getContentStreamLength()
```
    Returns the content stream length or -1 if the document has no content (CMIS property cmis:contentStreamLength).
    
    Returns:
    
    the content stream length of this document or -1 if the property hasn't been requested, hasn't been provided by the repository, or the document has no content
    
    CMIS:
    
    1.0
  - getContentStreamMimeType
```
String getContentStreamMimeType()
```
    Returns the content stream MIME type or null if the document has no content (CMIS property cmis:contentStreamMimeType).
    
    Returns:
    
    the content stream MIME type of this document or null if the property hasn't been requested, hasn't been provided by the repository, or the document has no content
    
    CMIS:
    
    1.0
  - getContentStreamFileName
```
String getContentStreamFileName()
```
    Returns the content stream filename or null if the document has no content (CMIS property cmis:contentStreamFileName).
    
    Returns:
    
    the content stream filename of this document or null if the property hasn't been requested, hasn't been provided by the repository, or the document has no content
    
    CMIS:
    
    1.0
  - getContentStreamId
```
String getContentStreamId()
```
    Returns the content stream ID or null if the document has no content (CMIS property cmis:contentStreamId).
    
    Returns:
    
    the content stream ID of this document or null if the property hasn't been requested, hasn't been provided by the repository, or the document has no content
    
    CMIS:
    
    1.0
  - getContentStreamHashes
```
List<ContentStreamHash> getContentStreamHashes()
```
    Returns the content hashes or null if the document has no content (CMIS property cmis:contentStreamHash).
    
    Returns:
    
    the list of content hashes or null if the property hasn't been requested, hasn't been provided by the repository, or the document has no content
    
    CMIS:
    
    Extension
  - getLatestAccessibleStateId
```
String getLatestAccessibleStateId()
```
    Returns the latest accessible state ID or null if the repository does not support the Latest State Identifier feature extension (CMIS property cmis:latestAccessibleStateId ).
    
    Returns:
    
    the latest accessible state ID or null
    
    CMIS:
    
    Extension

Interface DocumentProperties

Method Summary

Method Detail

isImmutable

isLatestVersion

isMajorVersion

isLatestMajorVersion

isPrivateWorkingCopy

getVersionLabel

getVersionSeriesId

isVersionSeriesCheckedOut

getVersionSeriesCheckedOutBy

getVersionSeriesCheckedOutId

getCheckinComment

getContentStreamLength

getContentStreamMimeType

getContentStreamFileName

getContentStreamId

getContentStreamHashes

getLatestAccessibleStateId