org.eclipse.stardust.engine.core.spi.dms

Interface IRepositoryCapabilities

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRepositoryInstanceInfo, IRepositoryProviderInfo

public interface IRepositoryCapabilities
extends Serializable

Represents the capabilities of a repository. By marking a capability as not supported the client code is able to decide which methods from IRepositoryService are available for use and which ones are not implemented.

Author:

Roland.Stamm

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAccessControlPolicySupported() Indicates if access control policies are supported.
boolean	isFullTextSearchSupported() Indicates if queries can use filters on the content of a document.
boolean	isMetaDataSearchSupported() Indicates if queries can use filters on meta data properties that are contained in the ResourceInfo.getProperties() map.
boolean	isMetaDataWriteSupported() Indicates if the repository supports write operations for the ResourceInfo.getProperties() map.
boolean	isTransactionSupported() Indicates if the repository integrates into the container managed transaction.
boolean	isVersioningSupported() Indicates if the repository supports versioning operations.
boolean	isWriteSupported() Indicates if the repository supports write operations.

Method Detail

isFullTextSearchSupported

boolean isFullTextSearchSupported()

Indicates if queries can use filters on the content of a document.

Returns:

true if the capability is supported.

See Also:

IRepositoryService.findDocuments(DocumentQuery), DocumentQuery.CONTENT

isMetaDataSearchSupported

boolean isMetaDataSearchSupported()

Indicates if queries can use filters on meta data properties that are contained in the ResourceInfo.getProperties() map.

Returns:

true if the capability is supported.

See Also:

IRepositoryService.findDocuments(DocumentQuery), DocumentQuery.META_DATA, ResourceInfo.getProperties()

isMetaDataWriteSupported

boolean isMetaDataWriteSupported()

Indicates if the repository supports write operations for the ResourceInfo.getProperties() map.

Returns:

true if the capability is supported.

isVersioningSupported

boolean isVersioningSupported()

Indicates if the repository supports versioning operations.

Returns:

true if the capability is supported.

See Also:

IRepositoryService.getDocumentVersions(String), IRepositoryService.versionDocument(String, String, String), IRepositoryService.updateDocument(Document, boolean, String, String, boolean), IRepositoryService.updateDocument(Document, byte[], String, boolean, String, String, boolean)

isTransactionSupported

boolean isTransactionSupported()

Indicates if the repository integrates into the container managed transaction.

Returns:

true if the capability is supported.

isAccessControlPolicySupported

boolean isAccessControlPolicySupported()

Indicates if access control policies are supported.

Returns:

true if the capability is supported.

See Also:

IRepositoryService.getApplicablePolicies(String), IRepositoryService.getEffectivePolicies(String), IRepositoryService.getPolicies(String), IRepositoryService.setPolicy(String, org.eclipse.stardust.engine.api.runtime.AccessControlPolicy), IRepositoryService.getPrivileges(String)

isWriteSupported

boolean isWriteSupported()

Indicates if the repository supports write operations.

Returns:

true if the capability is supported.