oracle.ifs.beans

Class SearchObject

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.SearchObject

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieSearchObject

Deprecated.

CM SDK 10g: Class is deprecated and will be deleted in a future release.

public class SearchObject
extends TiePublicObject

The SearchObject class provides a facility to store searches persistently across sessions. A SearchObject is a serialized version of the SearchSpecification that is saved in CM SDK. The serialized object is only guaranteed to work within the same version of the CM SDK.

An example when using a SearchObject would applicable would be modeling a "Search Folder". This search is defined by the user and should be executed each time the user "clicks" on the "folder". The search is dymamic so the user can modify it at any time, but also needs to be persist across sessions.

Another example when to use a SearchObject is if a search is very complex to build each time. It can be saved as a SearchObject avoiding the task of rebuilding it.

Since SearchObjects are PublicObjects, any action performed on a PublicObject can be also be performed on a SearchObject. They can be foldered, versioned, and be secured by an AccessControlList (ACL).

Author:

Vijayanth Devadhar

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.
protected SearchSpecification	m_SearchSpecification Deprecated. SearchSpecification associated with SearchObject.
static String	SEARCHCONTENT_ATTRIBUTE Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SearchObject(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Deprecated. Construct a Search Object, standard variant.

Method Summary

Modifier and Type	Method and Description
protected static SearchObject	constructSearchObject(LibrarySession sess, S_LibraryObjectData data) Deprecated. Internal function used for constructing SearchObject
protected static Vector	constructSearchObjectVector(LibrarySession sess, Vector vector) Deprecated. Helper function, for converting a Vector of LODatas into a Vector of SearchObjects.
Search	getSearch() Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.
SearchSpecification	getSearchSpecification() Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.
void	handleEvent(IfsEvent event) Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.
void	setSearch(Search srch) Deprecated. Specify the contained SearchSpecification using a Search.
void	setSearchSpecification(SearchSpecification spec) Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, auditPublicObjectLocked, auditPublicObjectUnlocked, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postCreate, postSecurityChangedEvent, postUpdate, preCopy, preCreate, preFree, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

SEARCHCONTENT_ATTRIBUTE

public static final String SEARCHCONTENT_ATTRIBUTE

Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.

The serialized form of a search used for persistent storage is stored in this attribute.

See Also:

Constant Field Values

(Published)

m_SearchSpecification

protected SearchSpecification m_SearchSpecification

Deprecated.

SearchSpecification associated with SearchObject.

(Unpublished)

Constructor Detail

SearchObject

protected SearchObject(LibrarySession session,
                       Long id,
                       Long classId,
                       S_LibraryObjectData data)
                throws IfsException

Deprecated.

Construct a Search Object, standard variant. Does nothing, calls super

Parameters:

session - current LibSession

id - object ID

classId - class ID

data - structure details of object

Throws:

IfsException

(Unpublished)

Method Detail

setSearch

public void setSearch(Search srch)
               throws IfsException

Deprecated.

Specify the contained SearchSpecification using a Search. Calls setSearchSpecification

Parameters:

srch - Search object used to specify SearchSpecification

Throws:

IfsException - if SearchSpecification is not valid

(Unpublished)

setSearchSpecification

public void setSearchSpecification(SearchSpecification spec)
                            throws IfsException

Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.

Sets the search specification for the SearchObject.

Throws:

IfsException - if the operation fails

(Published)

getSearchSpecification

public SearchSpecification getSearchSpecification()
                                           throws IfsException

Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.

Returns the SearchSpecification.

Returns:

SearchSpecification of the SearchObject

Throws:

IfsException - if retrival fails.

(Published)

getSearch

public Search getSearch()
                 throws IfsException

Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.

Returns a Search from the SearchObject. The Search returned is lightweight. It just has a reference to the SearchObject. This facilitates the SearchSpecification not being transferred to beans side until explicitly requested by user. When executing Saved Searches, call Search.getSearchSpecification() only when needed. The Search execution will work without the SearchSpecification being transported to the beans side.

Returns:

Search that corresponds to the persistent SearchObject.

Throws:

IfsException - if Search Object creation fails

(Published)

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Deprecated. CM SDK 10g: Class is deprecated and will be deleted in a future release.

Handles the specified event.

Specified by:

handleEvent in interface IfsEventHandler

Overrides:

handleEvent in class LibraryObject

Parameters:

event - the event

Throws:

IfsException - if the operation fails

(Published)

constructSearchObjectVector

protected static Vector constructSearchObjectVector(LibrarySession sess,
                                                    Vector vector)
                                             throws IfsException

Deprecated.

Helper function, for converting a Vector of LODatas into a Vector of SearchObjects.

Parameters:

sess - session used for creating SearchObject objects

vector - vector of LODatas

Returns:

vector of SearchObjects

Throws:

IfsException - if SearchObject construction fails.

(Unpublished)

constructSearchObject

protected static SearchObject constructSearchObject(LibrarySession sess,
                                                    S_LibraryObjectData data)
                                             throws IfsException

Deprecated.

Internal function used for constructing SearchObject

Parameters:

sess - the session

data - the SearchObject data

Returns:

the SearchObject

Throws:

IfsException - if an error occurs

(Unpublished)