The IStoredSearch type exposes the following members.
Methods
Type | Name | Description |
---|---|---|
![]() | AccessContentStream | Overloaded. |
![]() | AddPendingAction |
Adds the specified pending action to this object's PendingActions
collection.
(Inherited from IIndependentlyPersistableObject.)![]() |
![]() | ApplySecurityTemplate |
Applies a security policy template to the given object. The specified value for the applyStateId parameter
must match the value of the ApplyStateID property of one of the templates in the security policy
for the object. For a versioning security template, the apply state ID can be one of the following:
(Inherited from IDocument.)
|
![]() | CancelCheckout |
Cancels the check-out reservation held on this document or version series by deleting the
reservation object associated with it. Any changes made to the reservation object are lost.
If the reservation object is an exclusive reservation (the object's ReservationType
property is set to EXCLUSIVE), only the user who checked out the document can cancel the check out,
or must have both WRITE_OWNER and DELETE access rights.
Note that this method is provided only
as a convenience method for canceling a checkout; all it does is delete the reservation version held
by the document or version series from which it is called.
(Inherited from IVersionable.)After a document's reservation object is deleted, the Content Engine performs the following steps on the reserved document version:
An error occurs if the document is not checked out or is a newly created object that has never been checked in. |
![]() | ChangeClass |
Changes the class of a Content Engine object. The new class must already exist and both it and the
original class must be subclasses of the same base class.
The ChangeClass method does not modify the security for an object, even if the object's current security
is derived from the default security for its source class. For the object's user-defined properties,
the following rules apply:
(Inherited from IVersionable.)
When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:
Changing the document class of a document object has no effect on the storage location of the document’s content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer’s Guide. |
![]() | ChangeState |
Changes the current, user-defined lifecycle state of this document, or the current state of a ICmTask object
(see TaskState for a list of the states).
The ChangeState method must be followed by a Save() or an equivalent batch operation to commit the state change.
Every state change generates a IChangeStateEvent,
to which you can subscribe or audit.
(Inherited from IDocument.)For documents, you cannot change the state of a document that is a reservation object. Valid lifecycle states are defined by the collection of DocumentState objects belonging to this document's associated DocumentLifecyclePolicy object. For documents, the LifecycleChangeFlags constant can be used as follows:
For tasks, the LifecycleChangeFlags constant can be used as follows:
For a detailed description of task states, see Task State Machine. |
![]() | Checkin |
Checks in this document reservation object by saving it as a new document version. You must have the appropriate access
rights to check in a document (MAJOR_VERSION to check it in a major version or MINOR_VERSION to check it in a
minor version). A major version is either the current released document version (if it is the latest major version) or a
former released version that has been superseded. A minor version is either the in-process document version (if it is the latest minor version)
or a former in-process version that has been superseded.
In addition, if the reservation object is an exclusive reservation (its ReservationType property is set
to EXCLUSIVE), you must be the user who checked out the document, or have the WRITE_OWNER access right.
An error will occur if this method is called by a document that is
not a reservation object.
(Inherited from IDocument.)Before you can check in a document that has content, you must set the content for the document by adding to its ContentElements collection one or more ContentTransfer objects if the content is stored in a Content Engine object store, or one or more ContentReference objects if the content is stored externally. If you do not want the Content Engine to assign a MIME type to the checked-in document, you must explicitly set the value of the document's MimeType property before calling the Checkin method. After a successful check-in, the reservation object becomes the new current version of the document (its IsCurrentVersion property is set to true). During a minor version check-in, the new minor document version is marked as in-process (its VersionStatus property is set to IN_PROCESS) and the previous in-process minor document version (if it exists) is marked as superseded (its VersionStatus property is set to SUPERSEDED). During a major version check-in, the new major document version is marked as released (its VersionStatus property is set to RELEASED) and the previous released major document version and in-process minor document version (if they exist) are marked as superseded. The checkinType parameter specifies whether to check in a document as a minor or a major version; set it to MINOR_VERSION to check in a minor version, or MAJOR_VERSION to check in a major version. The autoClassify parameter specifies whether the document should have automatic document classification enabled. (This feature is not supported for publish templates.) If set to AUTO_CLASSIFY, and if a classifier exists for the document's content type, the document will automatically be assigned the proper document class and its properties will be populated based on the document content (and, in the case of XML document classification, mapping rules from user-defined scripts). The Content Engine's classification service uses a document's MIME type to determine if there is a classifier capable of parsing the document. If you set the autoClassify parameter to AUTO_CLASSIFY, the check-in operation changes the value of the document's ClassificationStatus property to CLASSIFICATION_PENDING; if you set it to DO_NOT_AUTO_CLASSIFY, the property is set to NOT_CLASSIFIED. |
![]() | Checkout |
Creates a reservation object that can be modified and checked in as a new version of this document.
The reservation object can be accessed from this document's Reservation property. You
can either specify the type of checkout reservation (exclusive or collaborative) or use the
default checkout reservation setting of the object store.
(Inherited from IVersionable.)To successfully check out a document, the following requirements must be met or an exception will be thrown:
After a successful call to Checkout, the Content Engine performs the following steps:
|
![]() | ClearPendingActions |
Clears out the list of pending actions for this object. For example, if you
called Delete() without subsequently calling Save,
then called ClearPendingActions(), the Delete pending action
would no longer be in the object's pending actions list. This effectively
cancels changes not yet saved.
(Inherited from IIndependentlyPersistableObject.) |
![]() | Clone | Creates a new object that is a copy of the current instance. (Inherited from ICloneable.) |
![]() | CreateAnnotation |
Creates and associates a new annotation to a specific content element of this document.
This is a convenience method for creating an Annotation object from the document. You can also create an Annotation directly
using the Factory.Annotation.createInstance() method, and then setting the AnnotatedObject property with the object on which
the Annotation is placed.
(Inherited from IVersionable.)To persist the created Annotation object to the object store, you must explicitly call its Save method, which will also cause the server to add it to the Annotations collection of this document. |
![]() | Delete |
Adds a Delete pending
action to this object's PendingActions collection. You must subsequently
commit the change to the repository. (See
PendingAction for
more information about pending actions.)
(Inherited from IIndependentlyPersistableObject.)For IVersionSeries, all document versions are deleted. For ICmRecoveryItem, this method deletes the item contained within the ICmRecoveryBin object. It also deletes all recoverable objects represented by the ICmRecoveryItem object. |
![]() | DemoteVersion |
Demotes the latest major version of this document to an unreleased minor version. This method changes the previous
major version (if it exists) to the current released major version, but does not delete any document versions (including content)
from the document's version series, therefore allowing you to continue to have access to all version changes.
Note that you can demote frozen document versions and documents that are not versioning-enabled
(documents whose IsVersioningEnabled property is set to false).
(Inherited from IVersionable.)To successfully demote a document, the following requirements must be met or an error will occur:
After a successful call to demoteVersion, the Content Engine performs the following steps on the document version that is being demoted:
In addition, the Content Engine performs the following steps on the previous major document version:
|
![]() | FetchProperties | Overloaded. |
![]() | FetchProperty | Overloaded. |
![]() | Freeze |
Prevents changes to the custom properties of this document version. You can freeze any checked-in document version, but you cannot
freeze a reservation object. Once a document version has been frozen, it cannot be unfrozen; to change a frozen document's custom properties,
a new document version must be created. Note, however, that you can change a document version's writable system properties at any time. After
a successful Freeze call, the IsFrozenVersion property of the object representing the document version is set to true.
An error is generated if this document is a reservation object (VersionStatus = RESERVATION) or is already a frozen version (IsFrozenVersion = true).
(Inherited from IVersionable.) |
![]() | GetAccessAllowed |
Returns a value representing a bit mask of access rights granted to the user
requesting this object.
(Inherited from IIndependentlyPersistableObject.) |
![]() | GetClassName |
Returns the name of the class from which this object is instantiated.
(Inherited from IEngineObject.) |
![]() | GetConnection |
Returns a Connection object that represents a logical connection to the
FileNet P8 domain.
The returned Connection object is used as input to methods such as
factory instantiation methods.
(Inherited from IEngineObject.) |
![]() | GetObjectReference |
Returns an object reference that represents the object's identity.
(Inherited from IIndependentObject.)The ID of an independent object is the class name and ID of the object. The ID can be a path, GUID, or name of the object. |
![]() | GetObjectStore |
Returns a reference to the object store to which this object is persisted.
(Inherited from IRepositoryObject.) |
![]() | GetPendingActions |
Returns the pending actions for this object.
(Inherited from IIndependentlyPersistableObject.) |
![]() | GetPublicationStatus |
Returns a PublicationStatus enumeration value, which identifies the document's publication
status (dependent, independent, or not a publication).
(Inherited from IDocument.)Return ValueA PublicationStatus object. |
![]() | GetSuperClasses |
Returns a String array specifying the names of the superclasses of the
class from which this object is instantiated.
(Inherited from IEngineObject.) |
![]() | GetUpdateSequenceNumber |
Returns the update sequence number (USN) for this object.
(Inherited from IIndependentlyPersistableObject.)You can use the returned value to determine if the object has been modified since some earlier fetch of the same object. An IndependentlyPersistableObject has an update sequence number (USN), which is an Integer value on the object that protects it against concurrent updates. The USN value increases monotonically with each update to the object. When you update the object, the USN from the retrieved object is checked against the currently persisted USN value. If the values are different, the operation fails. As a special case, a USN value of Null causes the server-side check to be skipped during updates (this is sometimes called "unprotected update"). An IndependentlyPersistableObject instantiated by calling one of the GetInstance methods on a Factory class (such as Factory.CustomObject.GetInstance) does not fetch the object from the server, and therefore, is unaware of the persisted USN. Calling GetUpdateSequence on such an object returns Null. |
![]() | IsCurrent |
Returns a value indicating whether or not the state of this object is consistent
with its state in the repository.
(Inherited from IIndependentlyPersistableObject.)When one or more of the object's properties are "dirty" (have been marked as changed since the last time they were saved), IsCurrent returns False. You can then do one of the following:
|
![]() | IsLocked |
Queries this object's lock state. This helper method examines the object's lock-related properties and
determines the object's lock state. An alternative approach is to call the LockObject method
and handle any exception thrown if the method fails.
(Inherited from IDocument.)Note that this method returns an approximation of the locked state at the time of the call. Once this method executes and returns the value, the object's lock state could be immediately changed by another application's call to the LockObject method or the lock could expire. Before calling this method, make sure that the object's LockToken, LockTimeout, and DateLastModified properties have relatively fresh values. If any of those properties is missing, they are silently fetched from the server and added to the object's property cache. The IsLocked method returns False if the LockTimeout property is not set or if the lock has expired. The lock is determined to be expired if the DateLastModified property value plus the number of seconds specified by the LockTimeout property is less than the current system time. (All millisecond components are dropped from the calculation.) If the DateLastModified property is not set, this method returns False because the check against the lock timeout value or the lock token will reflect that the object is not locked. As soon as some action locks the object, the DateLastModified property will be updated and can then be used for the expiration calculation. Note To successfully run IsLocked and other cooperative locking methods, system clocks on the IBM FileNet P8 platform engine machines must be synchronized. The calculation performed by the IsLocked() method is done on the client system. If the client and server machine clocks are not synchronized, the result of this calculation might be incorrect. |
![]() | LockObject |
Sets a new lock or updates an existing lock on the object. Calling this method has no effect in
preventing others from updating a locked object (with the exception that others cannot re-lock the locked object).
This lock mechanism is used for custom purposes only and has no bearing on the actual ability to update an object.
(Inherited from IDocument.)To successfully execute this method, the current user must have permission to modify this object's properties. For example, locking a Document object requires the following combination of access rights: AccessRight.CHANGE_STATE | AccessRight.CREATE_INSTANCE | AccessRight.LINK | AccessRight.UNLINK | AccessRight.VIEW_CONTENT | AccessRight.WRITE | AccessRight.READ_ACL | AccessLevel.READ. If the call succeeds:
To update an existing lock, the objects needs to be in the locked state and the current user needs to match the user of the lock. Note that the user is the logged in user, not the owner string. If the call succeeds, then only the LockTimeout property is updated with the timeout value. The owner parameter in this case is ignored. (See the UpdateLock() method instead.) |
![]() | MoveContent |
Moves the content data of an object to a new storage area. For IVersionSeries, this method moves the content for
all associated document versions.
(Inherited from IDocument.)After a successful call to the MoveContent method, the content data is deleted from the original location unless the content data is IBM FileNet Content Federation Services for Image Services federated content. To enable deletion of IBM FileNet Content Federation Services for Image Services federated content from its original location, set the com.filenet.replication.EnableLegacyMoveContentBehaviour JVM parameter to true for your application server. For information about how to assign JVM parameter values for your application server, see Setting JVM parameters. You can force content to be encrypted, re-encrypted, or decrypted based on the current encryption configuration for the destination storage area. Likewise, you can force content to be compressed or decompressed based on the content compression configuration for the destination storage area. For more information, see Content encryption and Content compression. |
![]() | PromoteVersion |
Promotes an unreleased minor version of this document to a released major version. This method changes the current
released major version (if it exists) to a superseded major version, but does not delete any document versions (including content)
from the document's version series, therefore allowing you to continue to have access to all version changes.
Note that you can promote frozen document versions and documents that are not versioning-enabled
(documents whose IsVersioningEnabled property is set to false).
(Inherited from IVersionable.)To successfully promote a document, the following requirements must be met or an error will occur:
After a successful call to PromoteVersion, the Content Engine performs the following steps on the document version that is being promoted:
In addition, the Content Engine performs the following steps on the previous major document version that is being superseded:
|
![]() | Publish |
Publishes this Document object according to the specifications included in the specified
publish template as modified by the contents of the publishOptions parameter. This method
returns the PublishRequest object that is queued for this request. All publish requests are asynchronous,
including copy operations, which do not transform the document. A publish request is always enqueued, and
a copy of the PublishRequest object is always returned to the caller.
(Inherited from IDocument.)The publish template you specify, as well as any objects specified in the publish template itself, must reside on the same object store as this Document object. Note that publishing to a document class containing a required binary- or object-valued property is not supported as there is no way to set these property values during publishing. The publishOptions parameter is a string containing XML that specifies the publish options for the published document. See Publish Options XML for more information. After a successful call to publish, call the Save method of the returned PublishRequest object to submit the request to the publish queue. |
![]() | RaiseEvent |
Raises a custom event for this ISubscribable object.
For example, you can define a custom event class in the Content Engine for an operation
such as publishing a document, then specify the custom event in a call to the raiseEvent
method on a IDocument object after you call the publish method on that document.
(Inherited from ISubscribable.)Before you can use this method, the following conditions must be met:
|
![]() | Refresh | Overloaded. |
![]() | Republish |
Republishes the specified published document. The specified published document must have been
published with a publish template that still exists and had this Document object as its
source document. This method returns the PublishRequest object that is queued for this
request. All publish requests are asynchronous, including copy operations, which do not transform
the document. A publish request is always enqueued, and a copy of the PublishRequest
object is always returned to the caller.
(Inherited from IDocument.)The publishOptions parameter is a string containing XML that specifies the publish options for the republished document. See Publish Options XML for more information. |
![]() | Save | Overloaded. |
![]() | SetUpdateSequenceNumber |
Sets the update sequence number (USN) for this object. You can cause update
sequence checking to be skipped for this object by setting
the USN value to Null.
(Inherited from IIndependentlyPersistableObject.) |
![]() | TakeFederatedOwnership |
For a document that has been federated by Content Federation Services (CFS), grants exclusive
control of this document to the FileNet P8 Content Engine by making the corresponding external
document read-only. (Since the external document ceases to change, no changes exist for CFS to
propagate from the external repository to the Content Engine, and the Content Engine becomes the
sole means for modifying or deleting the document.) For non-federated documents or for documents
for which this method has already been called, this method has no effect.
An error is generated if this document is a reservation object (VersionStatus property is set
to RESERVATION).
(Inherited from IDocument.) |
![]() | Unlock |
Explicitly removes the lock from this object. Only the user who locked the object may remove the
lock. If the current user is not the user of the lock, the current user can still remove the lock provided
that user has AccessRight.WRITE_ACL permission on the object. An exception is thrown
if the above conditions are not met.
Upon successful execution of this method, the values for the object's LockOwner, LockToken, and LockTimeout properties
are removed (set to null). If you do not call Unlock to explicitly remove the lock, the lock is implicitly removed
when the lock's timeout value expires.
If the object is not locked (absence of a LockToken).
(Inherited from IDocument.) |
![]() | UpdateLock |
Adjusts the timeout period of the lock on this object.
(Inherited from IDocument.)This method updates the object's DateLastModified property to the current time and its LockTimeout property to the timeout value. The net effect of this may extend or shorten the original lock's expiration time. Only the user who locked the object can successfully call this method; for any other user, an exception is thrown. There is no limit to the number of times you can call this method. |