Package com.saperion.rmi

Class SaDocumentInfoImpl

java.lang.Object

com.saperion.rmi.SaDocumentInfoImpl

All Implemented Interfaces:

SaDocumentInfo, java.io.Serializable

public class SaDocumentInfoImpl
extends java.lang.Object
implements SaDocumentInfo

Author:

rbo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SaDocumentInfoImpl(SaDocumentInfo info, SaPropertyValue[] propertyValues)	Alternative constructor.
SaDocumentInfoImpl(SaPropertyValue[] propertyValues, SaLockInfo lock)	Constructor.
SaDocumentInfoImpl(SaPropertyValue[] propertyValues, com.saperion.jni.SaJNILockInfo lock)	Deprecated. use SaDocumentInfoImpl(SaPropertyValue[], SaLockInfo)

Method Summary

Modifier and Type	Method	Description
boolean	canEdit()
boolean	canIndex()
boolean	canPrint()
boolean	canSave()
boolean	canStream()
static java.util.List<SaDocumentInfo>	convertSimpleProperies(java.util.List<SaPropertyValue[]> values)
java.util.List<SaCheckoutInfo>	getCheckoutInfos()
java.lang.String	getLockToken()	Returns the lock-token if the document is locked.
int	getLockType()	Returns the lock-type if the document is locked.
java.lang.String	getLockUser()	Returns the user that has locked this document if the document is locked.
SaPropertyValue	getValue(java.lang.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(java.lang.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(java.util.List<?> rows)

Methods inherited from class java.lang.Object

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

Constructor Detail

SaDocumentInfoImpl

public SaDocumentInfoImpl(SaPropertyValue[] propertyValues,
                          SaLockInfo lock)

Constructor.

Parameters:

propertyValues - Property values

lock - Lock informations

SaDocumentInfoImpl

@Deprecated
public SaDocumentInfoImpl(SaPropertyValue[] propertyValues,
                          com.saperion.jni.SaJNILockInfo lock)

Deprecated.

use SaDocumentInfoImpl(SaPropertyValue[], SaLockInfo)

Constructor.

Parameters:

propertyValues - Property values

lock - Lock informations

SaDocumentInfoImpl

public SaDocumentInfoImpl(SaDocumentInfo info,
                          SaPropertyValue[] propertyValues)

Alternative constructor.

Parameters:

info - Second info

propertyValues - Values

Method Detail

convertSimpleProperies

public static final java.util.List<SaDocumentInfo> convertSimpleProperies(java.util.List<SaPropertyValue[]> values)

Parameters:

values - Property values

Returns:

List of document infos

getValues

public SaPropertyValue[] getValues()

Specified by:

getValues in interface SaDocumentInfo

Returns:

Array of property values

See Also:

SaDocumentInfo.getValues()

hasValue

public boolean hasValue(java.lang.String name)

Check, if a value exists for the given name.

Specified by:

hasValue in interface SaDocumentInfo

Parameters:

name - Property name

Returns:

True, if exists

See Also:

SaDocumentInfo.hasValue(java.lang.String)

getValue

public SaPropertyValue getValue(java.lang.String name)

Reads the value with the given name.

Specified by:

getValue in interface SaDocumentInfo

Parameters:

name - Property name

Returns:

Property value or null, if not found

See Also:

SaDocumentInfo.getValue(java.lang.String)

isCheckedout

public boolean isCheckedout()

Specified by:

isCheckedout in interface SaDocumentInfo

Returns:

Document is checked out.

See Also:

SaDocumentInfo.isCheckedout()

getCheckoutInfos

public java.util.List<SaCheckoutInfo> getCheckoutInfos()

Specified by:

getCheckoutInfos in interface SaDocumentInfo

Returns:

Checkout informations

See Also:

SaDocumentInfo.getCheckoutInfos()

setCheckoutInfo

public void setCheckoutInfo(java.util.List<?> rows)

Specified by:

setCheckoutInfo in interface SaDocumentInfo

Parameters:

rows - Checkout rows

See Also:

SaDocumentInfo.setCheckoutInfo(java.util.List)

isLocked

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

Specified by:

isLocked in interface SaDocumentInfo

Returns:

true, if the document is locked

See Also:

SaDocumentInfo.isLocked()

getLockToken

public final java.lang.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.

Specified by:

getLockToken in interface SaDocumentInfo

Returns:

Lock token

See Also:

SaDocumentInfo.getLockToken()

getLockType

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

Specified by:

getLockType in interface SaDocumentInfo

Returns:

Lock type

See Also:

SaDocumentInfo.getLockType()

getLockUser

public final java.lang.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.

Specified by:

getLockUser in interface SaDocumentInfo

Returns:

Lock user

See Also:

SaDocumentInfo.getLockUser()

isReadonly

public final boolean isReadonly()

Specified by:

isReadonly in interface SaDocumentInfo

Returns:

Is readonly

See Also:

SaDocumentInfo.isReadonly()

canEdit

public boolean canEdit()

Specified by:

canEdit in interface SaDocumentInfo

Returns:

Editable

See Also:

SaDocumentInfo.canEdit()

canIndex

public boolean canIndex()

Specified by:

canIndex in interface SaDocumentInfo

Returns:

Indexable

See Also:

SaDocumentInfo.canIndex()

canPrint

public boolean canPrint()

Specified by:

canPrint in interface SaDocumentInfo

Returns:

Printable

See Also:

SaDocumentInfo.canPrint()

canSave

public boolean canSave()

Specified by:

canSave in interface SaDocumentInfo

Returns:

Saveable

See Also:

SaDocumentInfo.canSave()

hasObjects

public boolean hasObjects()

Specified by:

hasObjects in interface SaDocumentInfo

Returns:

Has objects

See Also:

SaDocumentInfo.hasObjects()

hasRealACL

public boolean hasRealACL()

Specified by:

hasRealACL in interface SaDocumentInfo

Returns:

Has real ACL

See Also:

SaDocumentInfo.hasRealACL()

hasWorkflows

public boolean hasWorkflows()

Returns true if the document has started or finished workflows.

Specified by:

hasWorkflows in interface SaDocumentInfo

Returns:

Has workflows

See Also:

SaDocumentInfo.hasWorkflows()

hasActiveWorkflows

public boolean hasActiveWorkflows()

Returns true, if the document has an active workflow.

Specified by:

hasActiveWorkflows in interface SaDocumentInfo

Returns:

has active workflow

See Also:

SaDocumentInfo.hasActiveWorkflows()

isCheckedIn

public boolean isCheckedIn()

Specified by:

isCheckedIn in interface SaDocumentInfo

Returns:

Is checked in

See Also:

SaDocumentInfo.isCheckedIn()

isDeleted

public boolean isDeleted()

Specified by:

isDeleted in interface SaDocumentInfo

Returns:

Is deleted

See Also:

SaDocumentInfo.isDeleted()

isLink

public boolean isLink()

Specified by:

isLink in interface SaDocumentInfo

Returns:

Is link

See Also:

SaDocumentInfo.isLink()

isRevised

public boolean isRevised()

Specified by:

isRevised in interface SaDocumentInfo

Returns:

Is revised

See Also:

SaDocumentInfo.isRevised()

hasStatus

public boolean hasStatus()

Specified by:

hasStatus in interface SaDocumentInfo

Returns:

Has status informations

See Also:

SaDocumentInfo.hasStatus()

canStream

public boolean canStream()

Specified by:

canStream in interface SaDocumentInfo

Returns:

Document can be streamed

See Also:

SaDocumentInfo.canStream()

isOfflineConflict

public boolean isOfflineConflict()

Specified by:

isOfflineConflict in interface SaDocumentInfo

Returns:

Document is in offline-conflict-state

See Also:

SaDocumentInfo.isOfflineConflict()

isSigned

public boolean isSigned()

Specified by:

isSigned in interface SaDocumentInfo

Returns:

Document is signed

See Also:

SaDocumentInfo.isSigned()

isLockedByCurrentUser

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

Specified by:

isLockedByCurrentUser in interface SaDocumentInfo

Returns:

true, if locked by current user

See Also:

SaDocumentInfo.isLockedByCurrentUser()