FileNet Content Services
Java Connector v3.0

Package com.filenet.wcm.api

This package contains the classes and interfaces you can use to build Java-based applications that provide access to Content Services objects such as ObjectStore, Folder, and Document.

See:
          Description

Interface Summary
AccessPermissionDescription

Not Implemented in CS Java Connector v3.0.

ActiveMarking

Not Implemented in CS Java Connector v3.0.

Annotation

Not Implemented in CS Java Connector v3.0.

AuditDefinition

Not Implemented in CS Java Connector v3.0.

AuditDefinitions

Not Implemented in CS Java Connector v3.0.

BaseObject The BaseObject interface is the base from which most of the interfaces in the com.filenet.wcm.api package derive derive.
BaseObjects A BaseObjects collection can contain various types of objects from a Content Services server.
BatchResultItem

Not Implemented in CS Java Connector v3.0.

BatchResultItems

Not Implemented in CS Java Connector v3.0.

Choice A Choice object is an element in a ChoiceList collection and represents a possible value of a property.
ChoiceList A ChoiceList collection represents a set of choices for a settable property.
ChoiceLists A ChoiceLists collection is a collection of ChoiceList objects.
ClassDescription A ClassDescription object is a collection of metadata that describes a Content Services class.
ClassDescriptions A ClassDescriptions object represents a collection of ClassDescription objects.
ContainableObject An object implementing the ContainableObject interface is an object that can be referentially-contained in a folder.
CreatableObject An object implementing the CreatableObject interface is an object that can be created by calling ObjectStore.createObject.
CustomObject

Not Implemented in CS Java Connector v3.0.

CustomObjects

Not Implemented in CS Java Connector v3.0.

Document A Document object represents a document stored in a Content Services object store.
Documents A Documents collection represents a collection of Document objects.
Domain

Not Implemented in CS Java Connector v3.0.

Domains

Not Implemented in CS Java Connector v3.0.

DynamicReferentialContainmentRelationship

Not Implemented in CS Java Connector v3.0.

EntireNetwork An EntireNetwork object represents all of the object stores (libraries) on the network.
Event

Not Implemented in CS Java Connector v3.0.

EventAction

Not Implemented in CS Java Connector v3.0.

EventActions

Not Implemented in CS Java Connector v3.0.

FeatureAddOn

Not Implemented in CS Java Connector v3.0.

FeatureAddOns

Not Implemented in CS Java Connector v3.0.

Folder A Folder object represents a container that can hold other objects.
Folders A Folders collection represents a collection of Folder objects.
GettableObject An object implementing the GettableObject interface is an object that can be instantiated by calling getObject on the ObjectStore interface.
Group A Group object reflects a set of user accounts defined on the Content Services server.
Groups

Not Implemented in CS Java Connector v3.0.

Link

Not Implemented in CS Java Connector v3.0.

Links

Not Implemented in CS Java Connector v3.0.

LockableObject

Not Implemented in CS Java Connector v3.0.

Marking

Not Implemented in CS Java Connector v3.0.

MarkingSet

Not Implemented in CS Java Connector v3.0.

ObjectStore This base interface includes methods for getting objects persisted in the object store and retrieving metadata.
ObjectStores An ObjectStores collection contains ObjectStore objects.
Permission A Permission object represents an access control (or rule) associated with with a Folder or Document object.
PermissionDescriptions public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; A PermissionDescriptions collection contains one or more AccessPermissionDescription objects.
Permissions A Permissions collection contains one or more com.filenet.Panagon.Permission objects.
Properties A Properties collection represents a collection of Property objects.
Property A Property object represents information about a property of an object stored in a Content Services server.
PropertyDescription A PropertyDescription object is a collection of metadata that describes a property.
PropertyDescriptions A PropertyDescriptions interface represents a collection of PropertyDescription objects.
PublishRequest

Not Implemented in CS Java Connector v3.0.

PublishRequests

Not Implemented in CS Java Connector v3.0.

PublishTemplate

Not Implemented in CS Java Connector v3.0.

PublishTemplates

Not Implemented in CS Java Connector v3.0.

ReadableMetadataObject An object implementing the ReadableMetadataObject interface is an object for which metadata (including properties, but not permissions) can be examined.
ReadableMetadataObjects A ReadableMetadataObjects collection represents a collection of ReadableMetadataObject objects.
ReadableSecurityObject An object implementing the ReadableSecurityObject interface is an object for which security information (permissions) can be examined.
ReadableSecurityObjects For future use.
Realm

Not Implemented in CS Java Connector v3.0.

Realms

Not Implemented in CS Java Connector v3.0.

ReferentialContainmentRelationship

Not Implemented in CS Java Connector v3.0.

Search A Search object contains the search criteria used to retrieve objects from an object store (library).
SearchPropertyDescription

Not Implemented in CS Java Connector v3.0.

SearchPropertyDescriptions

Not Implemented in CS Java Connector v3.0.

SecurityGrantee Group and User interfaces that extend SecurityGrantee describe objects which comprise grantees in a Permissions collection.
SecurityPolicies A SecurityPolicies collection contains a set of SecurityPolicy objects.
SecurityPolicy

Not Implemented in CS Java Connector v3.0.

SecurityTemplate

Not Implemented in CS Java Connector v3.0.

Session A Session object contains information, such as configuration options and credentials, needed to execute an operation on the Content Services server.
StoredSearch

Not Implemented in CS Java Connector v3.0.

StoredSearches

Not Implemented in CS Java Connector v3.0.

StyleTemplate

Not Implemented in CS Java Connector v3.0.

StyleTemplates

Not Implemented in CS Java Connector v3.0.

Subscription

Not Implemented in CS Java Connector v3.0.

Subscriptions

Not Implemented in CS Java Connector v3.0.

User A User object exists in the CS Java Connector as part of the security interface that allows a particular user to access a Content Services resource.
Users A Users collection contains User objects, each of which represents a user account on the Content Services server.
Value A Value object is a value associated with a Property object.
ValueObject An object implementing the ValueObject interface is an object that can be used in a call to Property.setValue(ValueObject objectValue) or value.setValue(ValueObject objectValue).
Values A Values collection is a collection of Value objects for a multi-valued property.
VersionableObject An object implementing the VersionableObject interface is an object that can be versioned; that is, multiple versions of the object can exist in a Content Services object store (library).
VersionSeries A VersionSeries object represents a collection of versionable documents.
WorkflowDefinition

Not Implemented in CS Java Connector v3.0.

WorkflowDefinitions

Not Implemented in CS Java Connector v3.0.

WorkflowSubscription

Not Implemented in CS Java Connector v3.0.

WorkflowSubscriptions

Not Implemented in CS Java Connector v3.0.

WorkflowTarget

Not Implemented in CS Java Connector v3.0.

WriteableMetadataObject An object implementing the WriteableMetadataObject interface is an object for which metadata (including properties, but not permissions) can be changed and persisted to the object store.
WriteableMetadataObjects For future use.
WriteableSecurityObject An object implementing the WriteableSecurityObject interface is an object for which security information (permissions) can be changed and persisted to the object store.
WriteableSecurityObjects For future use.
 

Class Summary
MimeTypes

Not Applicable in CS Java Connector v3.0.

ObjectFactory

Not Applicable in CS Java Connector v3.0.

PublicationFilter The PublicationFilter class specifies the filter to use in a call to the Document interface's getPublications and getPublicationsXML methods.
PublishRequestFilter The PublishRequestFilter class specifies the filter to use in a call to the ObjectStore interface's getPublishRequests method.
PublishRequestStatus The PublishRequestStatus class indicates the status of a publish request.
SearchClassInfo

Not Applicable in CS Java Connector v3.0.

SearchPropInfo

Not Applicable in CS Java Connector v3.0.

TransportInputStream A TransportInputStream object is used for uploading (sending) or downloading (receiving) content to or from the Content Services server.
 

Exception Summary
BadPropertyValueException

Not Applicable in CS Java Connector v3.0.

BadReferenceException This exception is thrown if an attempt is made to use an object instance of a CS Java Connector BaseObject class (or subclass) for which there is no corresponding Content Services object.
BaseException This is a checked exception class from which other CS Java Connector checked exceptions are inherited.
BaseRuntimeException This is an unchecked exception class from which other CS Java Connector unchecked exceptions are inherited.
BatchException

Not Applicable in CS Java Connector v3.0.

CannotDeleteObjectException This exception is thrown when the Content Services server indicates that it cannot delete an object.
CannotDetokenizeException This exception is thrown from Session.fromToken if the parameter supplied to the method cannot be parsed into keyword=value pairs for the returned HashMap.
ConcurrentUpdateException

Not Applicable in CS Java Connector v3.0.

ConfigurationException

Not Applicable in CS Java Connector v3.0.

ContentEngineHardwareException

Not Applicable in CS Java Connector v3.0.

ContentEngineMemoryException

Not Applicable in CS Java Connector v3.0.

ContentEngineNetworkException

Not Applicable in CS Java Connector v3.0.

ContentEngineUnsupportedOperationException

Not Applicable in CS Java Connector v3.0.

ElementOrderException

Not Applicable in CS Java Connector v3.0.

EncryptionException

Not Applicable in CS Java Connector v3.0.

FreezeException

Not Applicable in CS Java Connector v3.0.

InsufficientPermissionException

Not Applicable in CS Java Connector v3.0.

InvalidContentEngineClassException

Not Applicable in CS Java Connector v3.0.

InvalidCredentialsException This exception is thrown if the supplied credentials did not result in a successful login on the Content Services server where the Java API Listener is running.
LocalPropertyDescriptionException This exception is thrown when an operation is attempted that requires a property description created against an object store but the property description was obtained from a call to the ObjectFactory class's getPropertyDescription method.
NoContentInRefException This exception is thrown if a getContent or getContentElement call is attempted on a content element that is actually a content reference element (that is, external content).
ObjectCreationException This exception is thrown if an attempt is made to create an object and the Content Services server indicates that objects of that type may not be created.
ObjectLockedException This exception is thrown when an operation is attempted on a persisted object that is already locked.
ObjectStoreNotRespondingException This exception is thrown if an attempt to access an ObjectStore finds that the ObjectStore is corrupted or inaccessible.
PropertyNotFoundException This checked exception is thrown in a variety of contexts in which specific properties are being manipulated by an application and at least one of those properties cannot be found for the given object.
PropertyRequiresValueException

Not Applicable in CS Java Connector v3.0.

ReadOnlyObjectException

Not Applicable in CS Java Connector v3.0.

RemoteServerException

Not Applicable in CS Java Connector v3.0.

SecurityInheritanceException This exception is thrown when there is an error involving inherited permissions, such as attempting to modify a permission element that is inherited.
TransactionConstraintException

Not Applicable in CS Java Connector v3.0.

TransactionTimeoutException

Not Applicable in CS Java Connector v3.0.

UniquenessConstraintException

Not Applicable in CS Java Connector v3.0.

UntrustedCredentialsException

Not Applicable in CS Java Connector v3.0.

VersioningException This exception is thrown when a versioning-related operation (checkout, checkin, or cancel checkout) is attempted but fails for versioning-related semantic reasons, such as the following examples: Calling checkout on a Document object that already has a reservation (the document is already checked out).
 

Package com.filenet.wcm.api Description

This package contains the classes and interfaces you can use to build Java-based applications that provide access to Content Services objects such as ObjectStore, Folder, and Document.


FileNet Content Services
Java Connector v3.0