public interface StoredSearch extends RepositoryObject, Document
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.
SearchScope
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.
|
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
getObjectStore
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
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
get_CmHoldRelationships
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
raiseEvent
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
java.lang.String get_Description()
void set_Description(java.lang.String value)
java.lang.Integer get_SearchType()
void set_SearchType(java.lang.Integer value)
java.lang.Integer get_SearchingObjectType()
void set_SearchingObjectType(java.lang.Integer value)
java.lang.String get_ApplicationName()
void set_ApplicationName(java.lang.String value)
java.lang.String get_SearchingObjectStores()
void set_SearchingObjectStores(java.lang.String value)
java.lang.Integer get_CmSearchSchemaVersion()
void set_CmSearchSchemaVersion(java.lang.Integer value)
java.io.InputStream accessContentStream()
ContentTransfer
object.
The content data is fetched from the server.
The Content Platform 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.InputStream
object for reading content data. To retrieve content at arbitrary positions within the stream, cast the returned InputStream
to ExtendedInputStream
and use the methods on ExtendedInputStream
.© Copyright IBM Corporation 2006, 2015. All rights reserved.