LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Modules | Classes | Enumerations
com::sun::star::ucb Module Reference

Universal Content Broker interfaces. More...

Constant Groups

constants CommandInfoChange
 specifies reasons for sending CommandInfoChangeEvents.
 
constants ConnectionMode
 These are the possible values for the property "ConnectionMode".
 
constants ContentAction
 specifies actions which can be transported with content events.
 
constants ContentInfoAttribute
 These are the possible values for ContentInfo::Attributes.
 
constants ContentResultSetCapability
 These values are used to specify the capabilities of an XDynamicResultSet.
 
constants Error
 These codes are used to indicate errors.
 
constants FetchError
 These values are used to specify whether and which error has occurred while fetching data of some ContentResultSet rows.
 
constants FileSystemNotation
 The notational conventions used to denote file system paths on different file systems or operating systems.
 
constants ListActionType
 These values are used to specify the type of change happened to a list.
 
constants NameClash
 These are the possible values for TransferInfo::NameClash.
 
constants OpenMode
 These are the possible values for OpenCommandArgument::Mode.
 
constants RuleAction
 These are the possible values for Rule::Action.
 
constants RuleOperator
 These are the possible values for RuleTerm::RuleOperator.
 

Classes

exception  AlreadyInitializedException
 This exception is thrown to indicate that an attempt was made to reinitialize an object that can only be initialized once. More...
 
service  AnyCompareFactory
 is a factory to get XAnyCompare service implementations. More...
 
exception  AuthenticationFallbackRequest
 An interaction continuation handing back some authentication data. More...
 
exception  AuthenticationRequest
 An error specifying lack of correct authentication data (e.g., to log into an account). More...
 
service  CachedContentResultSet
 is used on client side to access a ContentResultSet remote optimized. More...
 
service  CachedContentResultSetFactory
 is a factory for CachedContentResultSet implementations. More...
 
service  CachedContentResultSetStub
 is used on provider side to access a ContentResultSet remote optimized. More...
 
service  CachedContentResultSetStubFactory
 is a factory for CachedContentResultSetStub implementations. More...
 
service  CachedDynamicResultSet
 provides read access to a static or dynamically changing ContentResultSet. More...
 
service  CachedDynamicResultSetFactory
 is a factory for CachedDynamicResultSet implementations. More...
 
service  CachedDynamicResultSetStub
 provides read access to a static or dynamically changing ContentResultSet. More...
 
service  CachedDynamicResultSetStubFactory
 is a factory for CachedDynamicResultSetStub implementations. More...
 
exception  CertificateValidationRequest
 An error specifying an invalid certificate. More...
 
struct  CheckinArgument
 contains information needed to checkin a document. More...
 
service  CmisContentProvider
 The Cmis Content Provider implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
struct  Command
 contains a command. More...
 
exception  CommandAbortedException
 This exception is thrown to indicate that a command was aborted. More...
 
service  CommandEnvironment
 
exception  CommandFailedException
 This exception is thrown if an exception situation occurred during the processing of a command and an com::sun::star::task::XInteractionHandler was able to handle the request for the error condition and the requesting code decided to abort the command execution according to the selection made by the interaction handler. More...
 
struct  CommandInfo
 describes a command. More...
 
struct  CommandInfoChangeEvent
 This event gets delivered whenever a XCommandInfo is changed. More...
 
service  Content
 A Content is a service that provides access to data of a content provided by an implementation of the service ContentProvider. More...
 
exception  ContentCreationException
 This exception is thrown to indicate that the creation of a UCB content failed. More...
 
struct  ContentEvent
 A structure for content events. More...
 
struct  ContentInfo
 A structure for information about contents. More...
 
service  ContentProvider
 provides access to a set of Contents. More...
 
struct  ContentProviderInfo
 A structure for content provider information. More...
 
service  ContentProviderProxy
 is a proxy for a content provider. More...
 
service  ContentProviderProxyFactory
 is a factory for ContentProviderProxy implementations. More...
 
service  ContentResultSet
 provides access to the children of a folder content. More...
 
service  ContentTransmitter
 A ContentTransmitter is a service that provides. More...
 
struct  CrossReference
 This struct contains information describing a cross reference. More...
 
service  DefaultHierarchyDataSource
 is a concrete implementation of service HierarchyDataSource, which uses the service com::sun::star::configuration::ConfigurationProvider for reading and writing hierarchy data. More...
 
struct  DocumentHeaderField
 This struct contains a name-value pair of a document header (i.e. More...
 
exception  DuplicateCommandIdentifierException
 is thrown by XCommandProcessor::execute() to indicate that the same command identifier was used for two threads. More...
 
exception  DuplicateProviderException
 is thrown to indicate that a content provider with the same identifier already was registered with a content provider manager. More...
 
service  DynamicResultSet
 provides read access to a static or dynamically changing ContentResultSet. More...
 
service  ExpandContentProvider
 The Expand Content Provider implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
struct  ExportStreamInfo
 information needed to export an object in mbx format (supplying an output stream to export into). More...
 
struct  FetchResult
 contains data of several rows of a ContentResultSet. More...
 
service  FileContent
 A File Content represents either a directory or a file in the local file system. More...
 
service  FileContentProvider
 The File Content Provider (FCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
struct  FolderList
 A list of folders. More...
 
struct  FolderListEntry
 Information about a single folder in a FolderList. More...
 
service  FTPContent
 A FTPContent provides an object representing either a (ftp-server-side) directory object allowing listing of children or a content object providing access to a (ftp-server-side) file. More...
 
service  FTPContentProvider
 The FTP Content Provider (FCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
service  GIOContentProvider
 
struct  GlobalTransferCommandArgument
 This struct contains information needed to transfer objects from one location to another. More...
 
struct  GlobalTransferCommandArgument2
 This struct extends the one for transfers arguments by adding a Mime type and a Document Id property to it. More...
 
service  GnomeVFSContentProvider
 
service  GnomeVFSDocumentContent
 
service  GnomeVFSFolderContent
 A DCP Folder is a container for other DCP Folders or Documents. More...
 
service  HelpContent
 A Help Content represents either a directory object allowing access to a search engine and to index information for the respective module, or an object allowing access to the concrete written help content. More...
 
service  HelpContentProvider
 The Help Content Provider (HCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
service  HierarchyContentProvider
 The Hierarchy Content Provider (HCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
service  HierarchyDataReadAccess
 provides read access to a fragment of the hierarchy data. More...
 
service  HierarchyDataReadWriteAccess
 provides read and write access to a fragment of the hierarchy data. More...
 
service  HierarchyDataSource
 manages one or more complete sets of hierarchy data and serves as a factory for objects that provide access to a subset of the data. More...
 
service  HierarchyFolderContent
 A HCP Folder is a container for other HCP Folders and HCP Links. More...
 
service  HierarchyLinkContent
 A HCP Link is a content which points to another location. More...
 
service  HierarchyRootFolderContent
 A HCP Root Folder is the root container for all other HCP Folders and HCP Links. More...
 
exception  IllegalIdentifierException
 This exception is thrown to indicate an illegal content identifier. More...
 
struct  InsertCommandArgument
 The argument for the command "insert". More...
 
struct  InsertCommandArgument2
 The argument for the command "insert" augmented with some properties. More...
 
exception  InteractiveAppException
 An application error. More...
 
exception  InteractiveAugmentedIOException
 An input/output error with arguments. More...
 
exception  InteractiveBadTransferURLException
 An interaction request to inform the client of a "transfer" command that the supplied source URL is not supported. More...
 
exception  InteractiveFileIOException
 An input/output error while processing a file. More...
 
exception  InteractiveIOException
 An input/output error. More...
 
exception  InteractiveLockingException
 An error related to locking operations. More...
 
exception  InteractiveLockingLockedException
 An error indicating that the resource is locked. More...
 
exception  InteractiveLockingLockExpiredException
 An error indicating that a lock that has been previously obtained by this OOo session has expired. More...
 
exception  InteractiveLockingNotLockedException
 An error indicating that the resource is not locked. More...
 
exception  InteractiveNetworkConnectException
 A network error specifying a connection failure. More...
 
exception  InteractiveNetworkException
 An error related to network operations. More...
 
exception  InteractiveNetworkGeneralException
 A network error specifying a general failure. More...
 
exception  InteractiveNetworkOffLineException
 A network error specifying an off line condition. More...
 
exception  InteractiveNetworkReadException
 A network error specifying a read failure. More...
 
exception  InteractiveNetworkResolveNameException
 A network error specifying a name resolution failure. More...
 
exception  InteractiveNetworkWriteException
 A network error specifying a write failure. More...
 
exception  InteractiveWrongMediumException
 is thrown when the wrong medium is inserted into a removable drive during an operation. More...
 
struct  Link
 defines a link. More...
 
struct  ListAction
 This struct contains information needed in the notifications of a XDynamicResultSet. More...
 
exception  ListenerAlreadySetException
 
This exception is thrown to indicate that a Listener is already set while

only one is allowed. More...

 
struct  ListEvent
 specifies the type of event fired by an XDynamicResultSet More...
 
struct  Lock
 defines a lock. More...
 
struct  LockEntry
 defines the types of locks that can be used with a resource. More...
 
exception  MissingInputStreamException
 This exception is used to indicate that there is an com::sun::star::io::XInputStream missing. More...
 
exception  MissingPropertiesException
 This exception is used to indicate that there are properties missing. More...
 
exception  NameClashException
 An exception used to notify a name clash. More...
 
exception  NameClashResolveRequest
 This request is used to indicate a name clash. More...
 
struct  NumberedSortingInfo
 contains information for sorting a ContentResultSet. More...
 
service  ODMAContent
 A OCP content is representation of a document saved in a DMS. More...
 
service  ODMAContentProvider
 The ODMA Content Provider (OCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
struct  OpenCommandArgument
 The argument for commands like "open", "update", and "synchronize". More...
 
struct  OpenCommandArgument2
 The argument for commands like "open", "update", and "synchronize". More...
 
struct  OpenCommandArgument3
 Extended argument for commands like "open". More...
 
service  PackageContentProvider
 The Package Content Provider (PCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
service  PackageFolderContent
 A PCP Folder is a container for other PCP Folders and PCP Streams. More...
 
service  PackageStreamContent
 A PCP Stream is a content which represents a file inside a package. More...
 
service  PersistentPropertySet
 This service contains the interfaces to implement by objects returned by XPropertySetRegistry::openPropertySet(). More...
 
struct  PostCommandArgument
 The argument for the command "post". More...
 
struct  PostCommandArgument2
 The argument for the command "post". More...
 
service  PropertiesManager
 This service provides access to the meta data of the well known (predefined) UCB properties. More...
 
struct  PropertyCommandArgument
 The argument for the "addProperty" command. More...
 
service  PropertySetRegistry
 This service contains the interfaces to implement by objects returned by XPropertySetRegistryFactory::createRegistry(). More...
 
struct  PropertyValueInfo
 contains value and state of a com::sun::star::beans::Property. More...
 
struct  RecipientInfo
 contains all information needed to send a message using one send protocol. More...
 
service  RemoteAccessContentProvider
 A RemoteAccessContentProvider is a ContentProvider that provides access to contents available at other (remote) UCBs. More...
 
service  RemoteContentProviderAcceptor
 allows content providers running in remote processes to be registered at the local content provider broker. More...
 
struct  RemoteContentProviderChangeEvent
 The description of a change to a com::sun::star::ucb::XRemoteContentProviderSupplier. More...
 
service  RemoteProxyContentProvider
 A ContentProvider that wraps remote content providers that (potentially) have been distributed to a UCB. More...
 
exception  ResultSetException
 This exception is thrown to propagate exceptions thrown by operations on ContentResultSets. More...
 
struct  Rule
 describes a rule that can be applies to a number of objects. More...
 
struct  RuleSet
 describes a set of Rules. More...
 
struct  RuleTerm
 describes a term. More...
 
struct  SearchCommandArgument
 The argument for the command "search". More...
 
struct  SearchCriterium
 a criterion describing how an object must match some rules that specify (part of) a search. More...
 
struct  SearchInfo
 information needed to (recursively) search an object. More...
 
struct  SendInfo
 contains information related to a send protocol. More...
 
struct  SendMediaTypes
 contains a list of Internet media types (like "text/plain" and "text/html"), that are related to a send protocol. More...
 
exception  ServiceNotFoundException
 This exception is thrown to indicate that a needed service was not registered. More...
 
service  SimpleFileAccess
 
Offers a simple access to resources, like files and folders located in a

local file system or on an WebDAV server. More...

 
service  SortedDynamicResultSetFactory
 is a factory for DynamicResultSet implementations, which will be sorted according to the given sorting options. More...
 
struct  SortingInfo
 contains a sorting info. More...
 
service  Store
 creates instances of the service PropertySetRegistry. More...
 
struct  TransferInfo
 contains information needed to transfer objects from one location to another. More...
 
struct  TransferInfo2
 extends TransferInfo structure to give some additional parameters for transfers. More...
 
struct  TransferResult
 Information about a transfer activity. More...
 
service  TransientDocumentsContentProvider
 The Transient Documents Content Provider (TDCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
service  TransientDocumentsDocumentContent
 A TDCP Document represents the root folder of a transient document. More...
 
service  TransientDocumentsFolderContent
 A TDCP Folder is a container for other TDCP Folders and TDCP Streams. More...
 
service  TransientDocumentsRootContent
 A TDCP Root Folder is the root container for all other TDCP contents. More...
 
service  TransientDocumentsStreamContent
 A TDCP Stream is a content which represents a data stream of an Office document. More...
 
service  UniversalContentBroker
 is a one-instance service that provides access to a set of Contents via ContentProviders. More...
 
exception  UnsupportedCommandException
 is thrown to indicate that the a command is not known by the implementation of an interface. More...
 
exception  UnsupportedDataSinkException
 This exception is used to indicate that the requested type of data sink is not supported. More...
 
exception  UnsupportedNameClashException
 
exception  UnsupportedOpenModeException
 This exception is used to indicate that the requested OpenMode is not supported. More...
 
exception  URLAuthenticationRequest
 An error specifying lack of correct authentication data (e.g., to log into an account). More...
 
service  WebDAVContentProvider
 The WebDAV Content Provider (DCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...
 
service  WebDAVDocumentContent
 A DCP Document is a container for Document data/content. More...
 
service  WebDAVFolderContent
 A DCP Folder is a container for other DCP Folders or Documents. More...
 
struct  WelcomeDynamicResultSetStruct
 This struct is to be contained in the first notification of an XDynamicResultSet. More...
 
interface  XAnyCompare
 compares two anys. More...
 
interface  XAnyCompareFactory
 creates an XAnyCompare instance. More...
 
interface  XCachedContentResultSetFactory
 creates a CachedContentResultSet. More...
 
interface  XCachedContentResultSetStubFactory
 creates a CachedContentResultSetStub. More...
 
interface  XCachedDynamicResultSetFactory
 creates a CachedDynamicResultSet. More...
 
interface  XCachedDynamicResultSetStubFactory
 creates a CachedDynamicResultSetStub and connects a non-remote optimized DynamicResultSet to a remote optimized CachedDynamicResultSet. More...
 
interface  XCommandEnvironment
 defines the environment for a command. More...
 
interface  XCommandInfo
 provides access to information on a set of commands. More...
 
interface  XCommandInfoChangeListener
 a listener for events related to changing XCommandInfos. More...
 
interface  XCommandInfoChangeNotifier
 a notifier for changes of XCommandInfos. More...
 
interface  XCommandProcessor
 defines a processor for synchronous commands, which are executed in a specific execution environment. More...
 
interface  XCommandProcessor2
 An improved version of a com::sun::star::ucb::XCommandProcessor that helps avoid ever-increasing resource consumption. More...
 
interface  XContent
 specifies a content with a type and an identifier, which is able to manage listeners for events that are related to contents. More...
 
interface  XContentAccess
 specifies methods for obtaining information on a content in different levels. More...
 
interface  XContentCreator
 A creator for new (persistent) contents, like file system folders. More...
 
interface  XContentEventListener
 a listener for events related to XContents. More...
 
interface  XContentIdentifier
 An identifier for contents. More...
 
interface  XContentIdentifierFactory
 A factory for content identifiers. More...
 
interface  XContentIdentifierMapping
 A mapping from a (source) set of XContentIdentifiers to another (target) set of XContentIdentifiers. More...
 
interface  XContentProvider
 a content provider which creates and manages XContents. More...
 
interface  XContentProviderFactory
 a factory for a XContentProvider. More...
 
interface  XContentProviderManager
 makes it possible to query/register/deregister content providers. More...
 
interface  XContentProviderSupplier
 a supplier for a content provider. More...
 
interface  XContentTransmitter
 
interface  XDataContainer
 specifies a container for (binary) data. More...
 
interface  XDynamicResultSet
 Provides read access to a ContentResultSet. More...
 
interface  XDynamicResultSetListener
 used to receive notifications from an XDynamicResultSet. More...
 
interface  XFetchProvider
 provides the possibility to get the contents of the columns of several rows of a ContentResultSet with a single function call. More...
 
interface  XFetchProviderForContentAccess
 provides the possibility to load information offered by a XContentAccess for several rows of a ContentResultSet with a single function call. More...
 
interface  XFileIdentifierConverter
 specifies methods to convert between (file) URLs and file paths in system dependent notation. More...
 
interface  XInteractionAuthFallback
 An interaction continuation specifying authentication success. More...
 
interface  XInteractionHandlerSupplier
 This interface should be implemented by an internal XCommandEnvironment that can not supply an com::sun::star::task::XInteractionHandler, but instead wants interaction requests to be handled by other internal error handling mechanism. More...
 
interface  XInteractionReplaceExistingData
 is an interaction continuation used to instruct the requester to replace existing data. More...
 
interface  XInteractionSupplyAuthentication
 An interaction continuation handing back some authentication data. More...
 
interface  XInteractionSupplyAuthentication2
 An interaction continuation handing back some authentication data. More...
 
interface  XInteractionSupplyName
 is an interaction continuation used to hand back a new name for something. More...
 
interface  XParameterizedContentProvider
 Register specially adjusted instances of content providers on URL templates and supplementary arguments. More...
 
interface  XPersistentPropertySet
 A persistent property set, which can be saved in and restored from a XPropertySetRegistry. More...
 
interface  XProgressHandler
 Handle a tasks notification that it has made some progress. More...
 
interface  XPropertyMatcher
 Checks whether a set of properties matches a set of search criteria. More...
 
interface  XPropertyMatcherFactory
 Creates an XPropertyMatcher, given a set of search criteria. More...
 
interface  XPropertySetRegistry
 A registry (storage medium) for persistent property sets. More...
 
interface  XPropertySetRegistryFactory
 A factory for property set registries. More...
 
interface  XRecycler
 Allows an XContent to delete itself into the trash can. More...
 
interface  XRemoteContentProviderAcceptor
 Accept remote content providers that want to make themselves known to the local process. More...
 
interface  XRemoteContentProviderActivator
 This interface should be implemented together with XRemoteContentProviderAcceptor and allows for a lazy implementation of XRemoteContentProviderAcceptor::addRemoteContentProvider(). More...
 
interface  XRemoteContentProviderChangeListener
 A listener interested in changes to a com::sun::star::ucb::XRemoteContentProviderSupplier. More...
 
interface  XRemoteContentProviderChangeNotifier
 Notify about changes to a XRemoteContentProviderSupplier. More...
 
interface  XRemoteContentProviderConnectionControl
 A simple mechanism to find out if the connection between a remote content provider distributor and acceptor gets lost. More...
 
interface  XRemoteContentProviderDistributor
 Distribute a content broker to various XRemoteContentProviderAcceptors. More...
 
interface  XRemoteContentProviderDoneListener
 A notification mechanism that a XRemoteContentProviderAcceptor no longer needs a remote content provider. More...
 
interface  XRemoteContentProviderSupplier
 Provide access to a collection of remote content providers. More...
 
interface  XSimpleFileAccess
 This is the basic interface to read data from a stream. More...
 
interface  XSimpleFileAccess2
 This is an extension to the interface XSimpleFileAccess. More...
 
interface  XSimpleFileAccess3
 This is an extension to the interface XSimpleFileAccess2. More...
 
interface  XSortedDynamicResultSetFactory
 Provides a method to create an XDynamicResultSet which will be sorted according to the given sorting options. More...
 
interface  XSourceInitialization
 provides the initialization of a component with any source object. More...
 
interface  XUniversalContentBroker
 
interface  XWebDAVCommandEnvironment
 A command environment that can be used to deal with WebDAV/HTTP specific commands. More...
 

Enumerations

enum  ContentCreationError {
  UNKNOWN, NO_CONTENT_BROKER, NO_IDENTIFIER_FACTORY, IDENTIFIER_CREATION_FAILED,
  NO_CONTENT_PROVIDER, CONTENT_CREATION_FAILED
}
 Codes for content creation errors. More...
 
enum  DocumentStoreMode { REMOTE, LOCAL }
 These are the possible values for the property "DocumentStoreMode". More...
 
enum  FolderListCommand { GET, GET_SUBSCRIBED, SET }
 The various commands to process on a list of folders. More...
 
enum  IOErrorCode {
  ABORT, ACCESS_DENIED, ALREADY_EXISTING, BAD_CRC,
  CANT_CREATE, CANT_READ, CANT_SEEK, CANT_TELL,
  CANT_WRITE, CURRENT_DIRECTORY, DEVICE_NOT_READY, DIFFERENT_DEVICES,
  GENERAL, INVALID_ACCESS, INVALID_CHARACTER, INVALID_DEVICE,
  INVALID_LENGTH, INVALID_PARAMETER, IS_WILDCARD, LOCKING_VIOLATION,
  MISPLACED_CHARACTER, NAME_TOO_LONG, NOT_EXISTING, NOT_EXISTING_PATH,
  NOT_SUPPORTED, NO_DIRECTORY, NO_FILE, OUT_OF_DISK_SPACE,
  OUT_OF_FILE_HANDLES, OUT_OF_MEMORY, PENDING, RECURSIVE,
  UNKNOWN, WRITE_PROTECTED, WRONG_FORMAT, WRONG_VERSION
}
 Types of input/output errors. More...
 
enum  LockDepth { ZERO, ONE, INFINITY }
 defines a depth for a lock. More...
 
enum  LockScope { EXCLUSIVE, SHARED }
 defines the scope of a lock. More...
 
enum  LockType { WRITE }
 specifies the access type of a lock. More...
 
enum  OutgoingMessageState {
  WRITTEN, PARTIALLY_LOCALLY_SENT, COMPLETELY_LOCALLY_SENT, RECOVERABLE_LOCAL_ERROR,
  NONRECOVERABLE_LOCAL_ERROR, EXTERNAL_ERROR, WAITING_CONFIRMATION, CONFIRMED
}
 These are the possible values for RecipientInfo::State. More...
 
enum  Priority {
  HIGHEST, HIGH, NORMAL, LOW,
  LOWEST
}
 These are the possible values for the property "Priority". More...
 
enum  PropertyValueState { UNPROCESSED, PROCESSED, INVALID_NAME, INVALID_TYPE }
 defines the states of a property value in the process of obtaining the value (asynchronously). More...
 
enum  RememberAuthentication { NO, SESSION, PERSISTENT }
 A specification of how long to remember some authentication data. More...
 
enum  RemoteContentProviderChangeAction { ADDED, REMOVED }
 An indication used in a com::sun::star::ucb::RemoteContentProviderChangeEvent to specify whether a remote content provider has been added to or removed from an com::sun::star::ucb::XRemoteContentProviderSupplier. More...
 
enum  SearchRecursion { NONE, ONE_LEVEL, DEEP }
 the various modes of recursion when searching through a hierarchical object. More...
 
enum  SynchronizePolicy { SERVER_IS_MASTER, CLIENT_IS_MASTER, NONE_IS_MASTER }
 These are the possible values for the property "SynchronizePolicy". More...
 
enum  TransferCommandOperation { COPY, MOVE, LINK }
 These are the possible values for GlobalTransferCommandArgument::Operation. More...
 
enum  VerificationMode { ALWAYS, ONCE, NEVER }
 These are the possible values for the property "VerificationMode". More...
 
enum  WebDAVHTTPMethod {
  GET, HEAD, POST, PUT,
  DELETE, TRACE, OPTIONS, CONNECT,
  PATCH, PROPFIND, PROPPATCH, MKCOL,
  COPY, MOVE, LOCK, UNLOCK
}
 Standard WebDAV/HTTP methods. More...
 

Detailed Description

Universal Content Broker interfaces.

Enumeration Type Documentation

enum ContentCreationError
published

Codes for content creation errors.

Enumerator
UNKNOWN 

Unknown.

An unknown I/O error has occurred.

NO_CONTENT_BROKER 
Deprecated:
NO_IDENTIFIER_FACTORY 
Deprecated:
IDENTIFIER_CREATION_FAILED 

Creation of content identifier failed.

NO_CONTENT_PROVIDER 

No Content Provider for given content identifier available.

CONTENT_CREATION_FAILED 

Provider was unable to create the content instance.

enum DocumentStoreMode
published

These are the possible values for the property "DocumentStoreMode".

See Also
XCommandProcessor
Content
Enumerator
REMOTE 

Document contents are not stored locally.

LOCAL 

Document contents are stored locally.

enum FolderListCommand
published

The various commands to process on a list of folders.

See Also
FolderList
Enumerator
GET 

Get a list of all folders.

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

GET_SUBSCRIBED 

Get a list of subscribed folders.

SET 

Set a list of folders.

enum IOErrorCode
published

Types of input/output errors.

See com::sun::star::task::InteractionHandler for a description of what kinds of arguments InteractiveAugmentedIOException should use with each of these error codes.

Enumerator
ABORT 

An operation was aborted.

ACCESS_DENIED 

An object cannot be accessed due to insufficient user rights.

ALREADY_EXISTING 

An object already exists.

BAD_CRC 

A bad checksum.

CANT_CREATE 

An object could not be created.

CANT_READ 

Data could not be read from a file.

CANT_SEEK 

A seek operation could not be run.

CANT_TELL 

A tell operation could not be run.

CANT_WRITE 

Data could not be written to a file.

CURRENT_DIRECTORY 

A function is not possible because the path contains the current directory.

DEVICE_NOT_READY 

A device (drive) not ready.

DIFFERENT_DEVICES 

A function is not possible because the devices (drives) are not identical.

GENERAL 

A general input/output error.

INVALID_ACCESS 

An invalid attempt was made to access an object.

INVALID_CHARACTER 

A file name contains invalid characters.

INVALID_DEVICE 

A specified device is invalid.

INVALID_LENGTH 

Invalid data length.

INVALID_PARAMETER 

An operation was started with an invalid parameter.

IS_WILDCARD 

An operation cannot be run on file names containing wildcards.

LOCKING_VIOLATION 

A locking problem.

MISPLACED_CHARACTER 

An invalid file name.

NAME_TOO_LONG 

A file name is too long.

NOT_EXISTING 

A nonexistent object.

NOT_EXISTING_PATH 

The path to a file does not exist.

NOT_SUPPORTED 

An action is not supported.

NO_DIRECTORY 

An object is not a directory.

NO_FILE 

An object is not a file.

OUT_OF_DISK_SPACE 

No more space on a device.

OUT_OF_FILE_HANDLES 

No more file handles available.

OUT_OF_MEMORY 

An operation could not be run due to insufficient memory.

PENDING 

An operation is still pending.

RECURSIVE 

An object cannot be copied into itself.

UNKNOWN 

Unknown.

An unknown I/O error has occurred.

WRITE_PROTECTED 

A function is not possible because the object is write protected.

WRONG_FORMAT 

An incorrect file format.

WRONG_VERSION 

An incorrect file version.

enum LockDepth
published

defines a depth for a lock.

See Also
Lock
Enumerator
ZERO 

Zero (includes no children).

ONE 

One (includes children).

INFINITY 

Infinity (includes children and children's children and ...).

enum LockScope
published

defines the scope of a lock.

See Also
LockEntry
Enumerator
EXCLUSIVE 

the lock is exclusive.

SHARED 

the lock is shared.

enum LockType
published

specifies the access type of a lock.

See Also
LockEntry
Enumerator
WRITE 

specifies a write lock.

read lock.read-write lock.

enum OutgoingMessageState
published

These are the possible values for RecipientInfo::State.

Enumerator
WRITTEN 

Message has just been placed into the out tray.

PARTIALLY_LOCALLY_SENT 

Message has been sent upstream to some recipients.

COMPLETELY_LOCALLY_SENT 

Message has been sent upstream to all recipients.

RECOVERABLE_LOCAL_ERROR 

Local, non-fatal error (e.g.

network temporarily not available).

NONRECOVERABLE_LOCAL_ERROR 

Local fatal error (e.g.

first SMTP server upstream did not accept the message).

EXTERNAL_ERROR 

Global fatal error (e.g.

last member in SMTP chain could not deliver the message).

WAITING_CONFIRMATION 

Message was sent; we are waiting for confirmation.

CONFIRMED 

Recipient confirmed reading.

enum Priority
published

These are the possible values for the property "Priority".

See Also
XCommandProcessor
Content
Enumerator
HIGHEST 

Highest priority.

HIGH 

High priority.

NORMAL 

Normal priority.

LOW 

Low priority.

LOWEST 

Lowest priority.

enum PropertyValueState
published

defines the states of a property value in the process of obtaining the value (asynchronously).

See Also
PropertyValueInfo
Enumerator
UNPROCESSED 

The property value was not obtained yet.

PROCESSED 

The value was obtained.

The value is stored in PropertyValueInfo::Value.

INVALID_NAME 

The given property name/handle is invalid.

INVALID_TYPE 

The given property type is invalid.

enum RememberAuthentication
published

A specification of how long to remember some authentication data.

Enumerator
NO 

Do not remember the authentication data (use it once and immediately forget about it).

SESSION 

Remember the authentication data, but only until the end of the current session.

PERSISTENT 

Remember the authentication data "forever".

An indication used in a com::sun::star::ucb::RemoteContentProviderChangeEvent to specify whether a remote content provider has been added to or removed from an com::sun::star::ucb::XRemoteContentProviderSupplier.

Version
1.0
Author
Stephan Bergmann
Enumerator
ADDED 

The indicator that a remote content provider has been added.

REMOVED 

The indicator that a remote content provider has been removed.

enum SearchRecursion
published

the various modes of recursion when searching through a hierarchical object.

See Also
SearchInfo
Enumerator
NONE 

Does not search through any sub-objects.

ONE_LEVEL 

Only searches through sub-objects of the first hierarchy level.

DEEP 

Searches through the complete hierarchy of all sub-objects.

enum SynchronizePolicy
published

These are the possible values for the property "SynchronizePolicy".

See Also
XCommandProcessor
Content
Enumerator
SERVER_IS_MASTER 

Server is master.

CLIENT_IS_MASTER 

Client is master.

NONE_IS_MASTER 

None is master.

enum TransferCommandOperation
published

These are the possible values for GlobalTransferCommandArgument::Operation.

Enumerator
COPY 

Copy the source to the target folder.

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)

MOVE 

Move the source to the target folder.

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)

LINK 

Create a link in the target folder.

The link's target is the source object.

enum VerificationMode
published

These are the possible values for the property "VerificationMode".

See Also
XCommandProcessor
Content
Enumerator
ALWAYS 

Always.

ONCE 

Once.

NEVER 

Never.

Standard WebDAV/HTTP methods.

Since
Apache OpenOffice 4.0, LibreOffice 4.2
Enumerator
GET 

Get a list of all folders.

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

HEAD 

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

POST 

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

PUT 

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

DELETE 

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

TRACE 

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

OPTIONS 

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

CONNECT 

HTTP request method as defined in RFC 2616: Hypertext Transfer Protocol – HTTP/1.1

PATCH 

HTTP request method as defined in RFC 5789: PATCH Method for HTTP

PROPFIND 

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)

PROPPATCH 

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)

MKCOL 

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)

COPY 

Copy the source to the target folder.

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)

MOVE 

Move the source to the target folder.

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)

LOCK 

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)

UNLOCK 

WebDAV methods as defined in HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)