com.filenet.api.query

Interface StoredSearch

All Superinterfaces:

CmHoldable, Containable, Document, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable, Versionable

public interface StoredSearch
extends RepositoryObject, Document

Represents the search criteria for a stored search or search template. These search criteria are persisted to an object store. Note: StoredSearch instances are available for use only when the Stored Search Extensions add-on is installed.

A StoredSearch object is identified as a stored search or a search template through the setting of the SearchType property. A stored search or search template can be used to query for the object types: Document, CustomObject, or Folder. The SearchingObjectType property identifies the object type for the query.

Only one object type can be specified per search clause. Each search clause specified in the XML must be handled as an individual query, requiring a separate call to the SearchScope method to execute each search clause.

Metadata

Auditable: undefined
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: DocumentClassDefinition
IsDependent: false
IsHidden: false
Searchable: true
StorageType: ObjectStore
SuperclassName: Document

See Also:

SearchScope

Method Summary

Methods

Modifier and Type	Method and Description
java.io.InputStream	accessContentStream() Obtains read access, via an input stream, to the content data of this ContentTransfer object.
java.lang.String	get_ApplicationName() Returns the value of the ApplicationName property.
java.lang.Integer	get_CmSearchSchemaVersion() Returns the value of the CmSearchSchemaVersion property.
java.lang.String	get_Description() Returns the value of the Description property.
java.lang.String	get_SearchingObjectStores() Returns the value of the SearchingObjectStores property.
java.lang.Integer	get_SearchingObjectType() Returns the value of the SearchingObjectType property.
java.lang.Integer	get_SearchType() Returns the value of the SearchType property.
void	set_ApplicationName(java.lang.String value) Sets the value of the ApplicationName property.
void	set_CmSearchSchemaVersion(java.lang.Integer value) Sets the value of the CmSearchSchemaVersion property.
void	set_Description(java.lang.String value) Sets the value of the Description property.
void	set_SearchingObjectStores(java.lang.String value) Sets the value of the SearchingObjectStores property.
void	set_SearchingObjectType(java.lang.Integer value) Sets the value of the SearchingObjectType property.
void	set_SearchType(java.lang.Integer value) Sets the value of the SearchType property.

Methods inherited from interface com.filenet.api.core.Document

accessContentStream, applySecurityTemplate, changeState, checkin, get_ChildDocuments, get_ChildRelationships, get_ClassificationStatus, get_CmIndexingFailureCode, get_CmRetentionDate, get_CmThumbnails, get_CompoundDocumentState, get_ContentElements, get_ContentElementsPresent, get_ContentRetentionDate, get_ContentSize, get_CurrentState, get_CurrentVersion, get_DateContentLastAccessed, get_DependentDocuments, get_DestinationDocuments, get_DocumentLifecyclePolicy, get_IndexationId, get_IsInExceptionState, get_MimeType, get_OwnerDocument, get_ParentDocuments, get_ParentRelationships, get_PublicationInfo, get_PublishingSubsidiaryFolder, get_ReleasedVersion, get_SecurityParent, get_SourceDocument, get_StorageArea, get_StorageLocation, get_StoragePolicy, get_WorkflowSubscriptions, getPublicationStatus, isLocked, lock, moveContent, publish, republish, set_CmRetentionDate, set_CompoundDocumentState, set_ContentElements, set_DocumentLifecyclePolicy, set_MimeType, set_OwnerDocument, set_PublicationInfo, set_PublishingSubsidiaryFolder, set_SecurityParent, set_SourceDocument, set_StorageArea, set_StoragePolicy, takeFederatedOwnership, unlock, updateLock

Methods inherited from interface com.filenet.api.core.RepositoryObject

getObjectStore

Methods inherited from interface com.filenet.api.core.Versionable

cancelCheckout, changeClass, checkout, createAnnotation, demoteVersion, freeze, get_CmIsMarkedForDeletion, get_DateCheckedIn, get_FoldersFiledIn, get_IsCurrentVersion, get_IsFrozenVersion, get_IsReserved, get_IsVersioningEnabled, get_MajorVersionNumber, get_MinorVersionNumber, get_Reservation, get_ReservationType, get_SecurityFolder, get_Versions, get_VersionSeries, get_VersionStatus, promoteVersion, set_DateCheckedIn, set_SecurityFolder

Methods inherited from interface com.filenet.api.core.Containable

get_ActiveMarkings, get_Annotations, get_AuditedEvents, get_Containers, get_CoordinatedTasks, get_Creator, get_DateCreated, get_DateLastModified, get_Id, get_LastModifier, get_LockOwner, get_LockTimeout, get_LockToken, get_Name, get_Owner, get_Permissions, get_SecurityPolicy, set_Creator, set_DateCreated, set_DateLastModified, set_LastModifier, set_Owner, set_Permissions, set_SecurityPolicy

Methods inherited from interface com.filenet.api.admin.CmHoldable

get_CmHoldRelationships

Methods inherited from interface com.filenet.api.replication.Replicable

get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup

Methods inherited from interface com.filenet.api.core.Subscribable

raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject

fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_Description

java.lang.String get_Description()

Returns the value of the Description property. For more information, see Description Property.

set_Description

void set_Description(java.lang.String value)

Sets the value of the Description property. For more information, see Description Property.

get_SearchType

java.lang.Integer get_SearchType()

Returns the value of the SearchType property. For more information, see SearchType Property.

set_SearchType

void set_SearchType(java.lang.Integer value)

Sets the value of the SearchType property. For more information, see SearchType Property.

get_SearchingObjectType

java.lang.Integer get_SearchingObjectType()

Returns the value of the SearchingObjectType property. For more information, see SearchingObjectType Property.

set_SearchingObjectType

void set_SearchingObjectType(java.lang.Integer value)

Sets the value of the SearchingObjectType property. For more information, see SearchingObjectType Property.

get_ApplicationName

java.lang.String get_ApplicationName()

Returns the value of the ApplicationName property. For more information, see ApplicationName Property.

set_ApplicationName

void set_ApplicationName(java.lang.String value)

Sets the value of the ApplicationName property. For more information, see ApplicationName Property.

get_SearchingObjectStores

java.lang.String get_SearchingObjectStores()

Returns the value of the SearchingObjectStores property. For more information, see SearchingObjectStores Property.

set_SearchingObjectStores

void set_SearchingObjectStores(java.lang.String value)

Sets the value of the SearchingObjectStores property. For more information, see SearchingObjectStores Property.

get_CmSearchSchemaVersion

java.lang.Integer get_CmSearchSchemaVersion()

Returns the value of the CmSearchSchemaVersion property. For more information, see CmSearchSchemaVersion Property.

set_CmSearchSchemaVersion

void set_CmSearchSchemaVersion(java.lang.Integer value)

Sets the value of the CmSearchSchemaVersion property. For more information, see CmSearchSchemaVersion Property.

accessContentStream

java.io.InputStream accessContentStream()

Obtains read access, via an input stream, to the content data of this ContentTransfer object. The content data is fetched from the server. The Content Engine will not automatically close the stream after access has finished; unless you want the stream to remain open, your application should close the stream after it has finished reading the content data.

Returns:

An InputStream object for reading content data.

See Also:

ContentAccessRecordingLevel property, DateContentLastAccessed property