The IStoredSearch type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | ActiveMarkings |
The list of ActiveMarking objects currently applied to a given object.
Each ActiveMarking object represents a marking that is in a MarkingSet associated
with a property on the object.
(Inherited from IContainable.) |
![]() | Annotations |
Specifies an AnnotationSet object that contains the annotations associated with this object.
(Inherited from IContainable.) |
![]() | ApplicationName |
Identifies the client application used to create the object.
|
![]() | AuditedEvents |
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from IContainable.) |
![]() | ChildDocuments |
A DocumentSet collection object that contains the child Document objects bound to
this parent document. The collection contains only those child documents for which the user has read access.
For each ComponentRelationship object that references this document as the parent
component document, the collection contains the version of the child component document that is bound
to this parent document. The same child document can be in the collection more than once.
(Inherited from IDocument.)For information on the ordering of the collection, see the ComponentSortOrder property. |
![]() | ChildRelationships |
A ComponentRelationshipSet collection object that contains the ComponentRelationship
objects referencing this document as the parent component document.
(Inherited from IDocument.)For information on the ordering of the collection, see the ComponentSortOrder property. |
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ClassificationStatus |
Specifies a DocClassificationStatus constant that indicates the auto-classification status for this document.
The ClassificationStatus property is used to provide client applications a means of discovering whether a particular
(Inherited from IDocument.)document is subject to auto-classification, and if so, whether or not the operation was successful. This property can hold one of the following values:
|
![]() | CmHoldRelationships |
An enumeration of ICmHoldRelationship objects associated with this object.
(Inherited from ICmHoldable.) |
![]() | CmIndexingFailureCode |
A bitmask of IndexingFailureCode constants that identify the types of indexing failures that have occurred
as a result of an index request for a CBR-enabled object. If there are no indexing failures, the CmIndexingFailureCode
property returns a value of zero.
(Inherited from IDocument.)If you set the value of the IndexingFailureRecordingLevel property of an ObjectStore object to PROPAGATE_TO_SOURCE, the error information is propagated to the CmIndexingFailureCode property of all CBR-enabled objects. |
![]() | CmIsMarkedForDeletion |
Indicates whether the object is marked (flagged) for deletion. If true, the object
is the original object explicitly marked for deletion by a user, or the object is referenced by the
original object through an object-valued property (OVP), and, therefore, was marked for
deletion by the server.
(Inherited from IVersionable.)Objects marked for deletion are represented by a ICmRecoveryItem object, through which the objects can be either recovered or purged (removed from the object store database). See Recovery Bin Concepts. |
![]() | CmRetentionDate |
The retention expiration date and time of this object. This object can be deleted only
after the expiration date and time has passed. If this property is null,
this object is not held under retention and there are no restrictions on when it can be deleted.
(Inherited from IDocument.)When you create an object, the Content Engine server automatically sets the CmRetentionDate property to the default retention date and time. The Content Engine server calculates the default retention date and time by adding the retention period (DefaultRetentionPeriod property of the object's class definition) expressed in the selected duration units (RetentionPeriodUnits property of the object's class definition) to the date and time when the object was created. Alternatively, you can override the default value by setting the CmRetentionDate property of the object to a specific date and time. Once an object has been created, you cannot change the value of its CmRetentionDate property to a smaller value; that is, the retention period of the object cannot be shortened. An object that has related objects under retention cannot be deleted until all of its related objects have been deleted. For example, a document with annotations cannot be deleted until all of its annotations have been deleted. The retention dates of a document and its annotations are independent of each other. When a document is checked out, its CmRetentionDate property value is not applied to the resulting reservation object. If you set the CmRetentionDate property of the reservation object, the property value is applied to the new document version when you check in the reservation object. Note that setting the CmRetentionDate property of the reservation object does not prevent the reservation object from being deleted. If you do not set the CmRetentionDate property of the reservation object when you check it in, the CmRetentionDate property of the new document version is automatically set to the default retention date and time. The CmRetentionDate property can be set to a specific date and time, or it can be set to one of the following RetentionConstants constants:
To set the CmRetentionDate property value on an object, you must have the following permissions:
|
![]() | CmSearchSchemaVersion |
Identifies the stored search schema version used to specify the XML query for the StoredSearch object.
|
![]() | CmThumbnails |
Contains the set of thumbnail images corresponding to this document.
Deleting the document deletes all of the thumbnails associated with it.
(Inherited from IDocument.) |
![]() | CompoundDocumentState |
The setting that determines whether a document can be a parent component in a compound document. The
CompoundDocumentState enumeration
has constants defined for the compound document state settings.
(Inherited from IDocument.)Valid settings are:
|
![]() | Containers |
A ReferentialContainmentRelationshipSet collection object containing the
ReferentialContainmentRelationship objects that identify the containers of this object.
(Inherited from IContainable.) |
![]() | ContentElements |
Specifies a ContentElementList object containing the list of content elements associated with
this document or annotation. Each content element represents content data, which can either be local
to an object store and stored in a file store or database (represented by a ContentTransfer object)
or external to an object store and therefore outside the control of the Content Engine server
(represented by a ContentReference object).
(Inherited from IDocument.) |
![]() | ContentElementsPresent |
Specifies a StringList object containing the MIME type of each content element
(Inherited from IDocument.) |
![]() | ContentRetentionDate |
Specifies the date until which this checked-in document must be retained, as determined by the content storage
subsystem. This document can be deleted only after this date has passed.
(Inherited from IDocument.)This property is maintained for compatibility with earlier versions and is automatically populated by the server with the same value as the document’s CmRetentionDate property. |
![]() | ContentSize |
Specifies the size in bytes of the content data associated with this document, annotation, or
ContentTransfer object. Note that if the document or annotation has more than one content element,
then the size is the sum of all of the content elements.
(Inherited from IDocument.) |
![]() | CoordinatedTasks |
The enumeration of tasks coordinated by the IContainable object.
Each ICmTask object in the enumeration represents a single piece of work in a business process.
A ICmTask object with a Coordinator
property set to this IContainable object is added to the enumeration value of this property.
(Inherited from IContainable.) |
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from IContainable.)Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users. |
![]() | CurrentState |
Specifies the name of the current lifecycle state of this document as defined by its document
lifecycle policy. Each document lifecycle policy defines a set of states through which a
StateName property of the DocumentState object representing the document can
transition into during its lifecycle. This property is equal to the value of the current
lifecycle state of this document.
(Inherited from IDocument.) |
![]() | CurrentVersion |
Specifies a document version that represents the latest checked-in version associated with
this document or version series. The current version can be either a major version or a
minor version.
(Inherited from IVersionable.) |
![]() | DateCheckedIn |
Specifies the date and time that this document was checked in. The Content Engine stores
dates and times using Coordinated Universal Time (UTC).
For more information, see
Timestamps.
(Inherited from IVersionable.)The server sets this property on a document version when it is checked in and it remains set throughout the life of the document version. When a document is checked out, the server sets this property on the document's reservation object to null. Settability of this property is read-only for most users. Users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE) can set this property on a document while it is being checked in. Note that although the settability of this property for users with privileged write access is SETTABLE_ONLY_BEFORE_CHECKIN, those users can not set this property on a document prior to check in; it can be set only while a document is being checked in. |
![]() | DateContentLastAccessed |
Specifies the date and time when the content data (represented by a ContentTransfer object) associated
with this document or annotation was last accessed. The Content Engine stores dates and times using
Coordinated Universal Time (UTC). For more information, see
Timestamps.
(Inherited from IDocument.)The recording granularity of the date and time returned by this property is determined by the setting of the object store's ContentAccessRecordingLevel property. The content data associated with a document or annotation object is considered to be accessed when one of the following events occur:
|
![]() | DateCreated |
Indicates the date and time the object was created. The Content Engine server stores dates and times using
Coordinated Universal Time (UTC). For more information, see
Timestamps.
(Inherited from IContainable.)Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users. |
![]() | DateLastModified |
Indicates the date and time the object was last modified. The Content Engine server stores dates and times
using Coordinated Universal Time (UTC). For more information, see
Timestamps.
(Inherited from IContainable.)Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store). |
![]() | DependentDocuments |
Specifies a DocumentSet collection object that contains all of the publication documents to which
this document is the owner document.
(Inherited from IDocument.) |
![]() | Description |
Specifies a string that describes this object.
|
![]() | DestinationDocuments |
Specifies documents that are publications of this document. This property is a reflective property of
the SourceDocument property.
(Inherited from IDocument.) |
![]() | DocumentLifecyclePolicy |
Specifies the DocumentLifecyclePolicy object that represents the lifecycle policy that has been applied
to this document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the
changes of those states, and specifies the actions to be taken when a document's lifecycle state changes.
(Inherited from IDocument.) |
![]() | ExternalReplicaIdentities |
Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects
that represent the identities of replicas of this object in external repositories.
(Inherited from IReplicable.) |
![]() | FoldersFiledIn |
A FolderSet collection object containing the Folder objects in which this document is filed.
(Inherited from IVersionable.) |
![]() | Id |
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created.
When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following
format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.
(Inherited from IContainable.)For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server. For a given property representation, the Id property has the following characteristics:
For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time. |
![]() | IndexationId |
The object ID (GUID) of the IBM® Content Search Services index that is used for this object.
This value is null for objects that are full-text indexed prior to the 4.0 release.
(Inherited from IDocument.)The server sets this property if this object is CBR-enabled. An object is considered to be CBR-enabled if you set the PropertyDefinitionString.IsCBREnabled property of the property definition of one of the object's string-valued properties to true. |
![]() | IsCurrentVersion |
Specifies whether this document version is the current (latest) version object of a document's version series
(true) or not (false). The current version can be a major version or a minor version.
(Inherited from IVersionable.) |
![]() | IsFrozenVersion |
Specifies whether this document version is a frozen version (true) or not (false).
If a document version is frozen, you cannot modify its custom properties. However, you may be
able to modify the custom properties of other versions of that document, provided they have not been frozen.
Note that the modifiability of a document's system properties is not affected by a document version's frozen status.
(Inherited from IVersionable.) |
![]() | IsInExceptionState |
Specifies whether the lifecycle state of this document is in an exception state (true) or not (false).
As long as a document is in an exception state, its lifecycle state can neither be promoted nor demoted.
To clear a document from an exception state, you must call its ChangeState method and set the
LifecycleChangeFlags parameter to CLEAR_EXCEPTION.
(Inherited from IDocument.) |
![]() | IsReserved |
For a Document object, specifies whether a user has reserved the right to check in the next version following
this document version (true) or not (false). For a VersionSeries object, specifies whether the
current version in this version series is checked out (true) or not (false).
(Inherited from IVersionable.) |
![]() | IsVersioningEnabled |
Specifies whether you can create a new version of this object (True) or not (False).
(Inherited from IVersionable.) |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from IContainable.)Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store). |
![]() | LockOwner |
Identifies the owner that exclusively holds the advisory lock on the object.
This property is populated as a result of a successful call to the LockObject method.
The value of this property is simply a custom string that has no real effect in determining the user of the lock.
The owner specified by this property is not validated against any user or group known to the Content Engine.
This property is set to null if the Unlock method is called; if the lock expires naturally,
then the value remains unchanged.
(Inherited from IContainable.) |
![]() | LockTimeout |
The number of seconds beyond the last modified date that the server will retain a lock.
This property's value is used to calculate a lock's expiration time. The property's value is populated as a result
of a successful call to the LockObject method; however, the value can be updated by a call to UpdateLock.
The property value is the number of seconds beyond the value in the object's DateLastModified property that
the user of the lock can hold the lock on the object. The result of the calculation is measured against the current
system time. The lock is considered expired when the value of the object's DateLastModified property
plus the value of the LockTimeout property is less than the current system time. (All millisecond
components are dropped from the calculation.) This property is set to null if the Unlock
method is called; if the lock expires naturally, then the value remains unchanged.
(Inherited from IContainable.) |
![]() | LockToken |
Identifies the token used to signal that a lock exists on an object. The token is a unique identifier (GUID) that
represents the lock. When the lock on the object is released (via Unlock), the value of LockToken is set to null.
(If the lock expires naturally, then the value remains unchanged.)
(Inherited from IContainable.) |
![]() | MajorVersionNumber |
Specifies the major version number of this document version. A document's major version number is set to 1 the
first time that you check it in as a major version and then incremented by 1 for each additional time that you check it
in as a major version.
(Inherited from IVersionable.) |
![]() | MimeType |
Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data
carried by this document, annotation, or document classification action.
MIME is a communications protocol that allows for the transmission of data in many forms,
such as audio, binary, or video.
(Inherited from IDocument.)For Document objects, you can set the MimeType property for a specific document version while it is a reservation object (at creation time and on subsequent check-outs). However, every time you check in a document, its MimeType property value reverts to its system-assigned value unless you explicitly set it again. For Annotation and CmThumbnail objects, you can set this property at any time. For DocumentClassificationAction objects, the MimeType property specifies the type of content that a document must hold in order to allow it to be auto-classified; you can set this property at any time. Each content element that is attached to a document or annotation has its own MIME type, which is specified by its ContentType property. If you do not specify the MimeType property for a document or annotation, it is automatically set by the Content Platform Engine to the value of the first content element, regardless of whether it is a ContentTransfer or ContentReference object. Although Content Platform Engine does not enforce the format of this property's value, a MIME format string consists of a content type, a content subtype, and an optional parameter in the format: "content type/subtype[;parameter]", for example, "text/html". MIME defines the following content types:
The following MIME types are specific to FileNet:
|
![]() | MinorVersionNumber |
Specifies the minor version number of this document version. A document's minor version number is set to 1 the
first time that you check it in as a minor version and then incremented by 1 for each additional time that you check it
in as a minor version. Note that if you check in a document as a major version, its minor version number will be reset to 0.
(Inherited from IVersionable.) |
![]() | Name |
The name for this object.
(Inherited from IContainable.)For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string. For a ComponentRelationship object, this property is read/write and specifies the name of the object. |
![]() | Owner |
Manages the security owner assigned to the object.
(Inherited from IContainable.) |
![]() | OwnerDocument |
For a published document, contains a reference to the Document object representing the
owner document associated with the published document. If this document is a publication and there
is a cascade delete relationship with the source, then this property will specify the publication
source document (the OwnerDocument and PublicationSource properties
will reference the same document).
(Inherited from IDocument.) |
![]() | ParentDocuments |
A DocumentSet collection object that contains the parent Document objects bound to this
child document. The collection contains only those parent documents for which the user has read access.
For each ComponentRelationship object that references this document as the child component
document, the collection contains the parent component document. The same parent document can be in the collection more than once.
(Inherited from IDocument.) |
![]() | ParentRelationships |
A ComponentRelationshipSet collection object that contains the ComponentRelationship
objects referencing this document as the child component document. The collection contains only
those parent relationship objects for which the user has read access.
(Inherited from IDocument.) |
![]() | Permissions |
Manages the discretionary permissions assigned to the object.
(Inherited from IContainable.) |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | PublicationInfo |
Specifies the parameters (formatted as XML) that were used to publish a document. The parameters, which
are used to republish the document, include the original output folder ID, style template ID, publish
template ID, and publish template version series ID. For example:
(Inherited from IDocument.)<publicationinfo> <styletemplateid>{14917CF3-4D5F-499D-BA38-8E010199745E}</styletemplateid> <publishtemplateid>{4D696690-EEBB-4341-9FE7-A8F715BAE96D}</publishtemplateid> <pubtemplversionseriesid>{459A0D5A-5B44-4AD1-B15C-91D7B773B3DD}</pubtemplverseriesid> <outputfolderid>{4EF26F2E-61D8-47FD-8201-EE81C3AA75FA}</outputfolderid> </publicationinfo> If the document is not a publication, the property is empty. |
![]() | PublishingSubsidiaryFolder |
Specifies a folder which contains the subsidiary documents of an HTML publication (for example,
image, audio, and style sheet files).
(Inherited from IDocument.) |
![]() | ReleasedVersion |
Specifies a document version that represents the latest released version associated with this
document or version series. A released version is a major version that has a VersionStatus
property value of RELEASED. Note that only one document version at a time in a given
version series can be in the released state.
(Inherited from IDocument.) |
![]() | ReplicationGroup |
A ReplicationGroup object representing the replication group to
which this replicable object belongs.
(Inherited from IReplicable.)For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs. |
![]() | Reservation |
Specifies the reservation object of this object's version series, which has a VersionStatus property
value of RESERVATION. A reservation object is created by the server when you check out a document,
which you can modify and check in as a new version of that document.
(Inherited from IVersionable.) |
![]() | ReservationType |
A ReservationType constant that specifies the type of this document reservation
(collaborative or exclusive) or whether its reservation type is the same as the default object store setting.
A collaborative reservation is a reservation that any user with the appropriate permissions can check in, modify, or delete.
An exclusive reservation is a reservation that only the user who checked out the document can check in.
This user and a user with Full Control access can delete the reservation.
(Inherited from IVersionable.) |
![]() | SearchingObjectStores |
Deprecated
Identifies the object stores to search. This setting will be overriden by the object store specified for the SearchScope instance. |
![]() | SearchingObjectType |
Deprecated
Identifies the object type to be queried. This setting will be overriden by the value of the SearchScope method's searchFromClause parameter. The following types can be used (one type per search clause):
|
![]() | SearchType |
Identifies an object as either a stored search or search template. This setting is currently not referenced, and is an indicator only of the search type used to
validate the MIME type of a document as acceptable for a stored search. The corresponding values are:
|
![]() | SecurityFolder |
Indicates a Folder object from which the object inherits security (a security parent).
(Inherited from IVersionable.)This value is indirectly set when DefineSecurityParentage is specified as the value of the defineSecurityParentage parameter for the IFolder.File method. The value, in this case, is the folder in which the object is filed. You can designate multiple security parents for an object by using one or more object-valued properties and setting the SecurityProxyType value for these properties to INHERITANCE. |
![]() | SecurityParent | Obsolete.
Specifies the object from which a given object inherits security. The value of this property
is a ReferentialContainmentRelationship (or DynamicReferentialContainmentRelationship)
that represents the object from which security is inherited.
(Inherited from IDocument.)An object can inherit its permissions from its security parent. For example, a Document object can inherit the permissions of the Folder in which it is filed. A Folder object always inherits its permissions from its parent folder. An object's security parent is reflected in the value of its SecurityParent property. You can explicitly set the security parent of an object at the time it is filed into a folder by specifing the defineSecurityParentage parameter of the Folder.File method. |
![]() | SecurityPolicy |
Specifies the SecurityPolicy associated with the given object. The SecurityPolicy
contains one or more SecurityTemplate objects that define the permissions to assign to a given
object. A security template can be one of two types: a VersioningSecurityTemplate or an
ApplicationSecurityTemplate. A VersioningSecurityTemplate defines permissions that will be
automatically assigned to the object when its version state changes. An ApplicationSecurityTemplate
defines permissions that will be assigned to the object upon an explicit call to do so by an application
program. For information on each of these types of templates, refer to their interface descriptions.
(Inherited from IContainable.)Assigning a security policy to a Document, CustomObject, or Folder object (or their subclasses) is optional. |
![]() | SourceDocument |
Specifies the source document for a published document.
(Inherited from IDocument.) |
![]() | StorageArea |
Specifies the storage area for a content-carrying object.
(Inherited from IDocument.) |
![]() | StorageLocation | Obsolete.
Specifies the storage location for an object's content. This property is deprecated in FileNet P8 4.0
and is only set in upgraded object stores. It has been replaced by the StorageArea property.
(Inherited from IDocument.) |
![]() | StoragePolicy |
Specifies the document's storage policy, which identifies the set of available storage areas that are
considered equivalent based on common, user-specified criteria. Assigning a storage policy to a document
is the recommended method of selecting a storage area. The alternative is to directly assign the storage
area (specify the StorageArea property).
(Inherited from IDocument.)When a document is created, the order of precedence for setting the storage on the Document instance is (from highest to lowest):
The default ClassDefinition for a document sets the StorageArea to Database Storage Area and the StoragePolicy to All Storage Areas. Therefore, if you create a new Document instance of the default Document ClassDefinition with only the StoragePolicy property set, the document will use the class default for the StorageArea property (Database Storage Area). To avoid this situation, you must set the instance value for the document's StorageArea property to null. Because the instance value for StorageArea is set, but has no value, the StoragePolicy property will be evaluated and used. In general, storage policies should be used to allow administrators to properly administer their storage systems. They can assign multiple storage areas to be load balanced, and also assign standby storage areas to be used if any of the current storage areas become full. |
![]() | Versions |
Specifies a VersionableSet object that contains all of the document versions associated with
this document or version series.
(Inherited from IVersionable.) |
![]() | VersionSeries |
Specifies a VersionSeries object that contains all of the document versions associated with this
document or DynamicReferentialContainmentRelationship object.
(Inherited from IVersionable.) |
![]() | VersionStatus |
Specifies a VersionStatus constant that indicates the current version status of this document version.
(Inherited from IVersionable.)The VersionStatus property can have one of the following values:
|
![]() | WorkflowSubscriptions |
The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription
objects whose target is this object.
(Inherited from IDocument.) |