oracle.ifs.core.tools.script

Class FolderIndexOperations

java.lang.Object

oracle.ifs.core.tools.script.ScriptOperations

oracle.ifs.core.tools.script.FolderIndexOperations

All Implemented Interfaces:

AttributeValueGetter, Logger

public class FolderIndexOperations
extends ScriptOperations

FolderIndexOperations defines the operations used to create, drop, rebuild, or inspect the Folder Index.

Author:

Dave Long

(Published)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.core.tools.script.ScriptOperations

ScriptOperations.ClassObjectOptions, ScriptOperations.JdbcExecutor, ScriptOperations.SavedSearchResult, ScriptOperations.ServerDefinition, ScriptOperations.ServiceDefinition

Field Summary

Fields inherited from class oracle.ifs.core.tools.script.ScriptOperations

INDENT

Constructor Summary

Constructors

Constructor and Description
FolderIndexOperations(ScriptDriver driver) Constructs an FolderIndexOperations.

Method Summary

Modifier and Type	Method and Description
protected long	applyDeferredUpdates(LibrarySession session, String prefix) Apply deferred updates.
protected void	changeUpdateMode(LibrarySession session, boolean isSync, String prefix) Change update mode to either synchronous or asynchronous.
protected void	completeIndexCreation(LibrarySession session, boolean deferCreate, String prefix) Completes the creation of the folder index.
void	createFolderIndex(AttributeValueTable avt) Create a Folder index.
protected void	createFolderIndexTables(LibrarySession session, int maxLevel, String prefix) Create the tables that comprise the folder index.
protected void	createInitialFolderIndexRows(LibrarySession session, String prefix) Create the initial self-reference rows for the folder index.
void	dropFolderIndex(AttributeValueTable avt) Drop the current Folder index.
protected void	dropIndex(LibrarySession session, String prefix) Drop the folder index.
protected int	getMaxLevel(LibrarySession session) Get the maximum folder index level.
void	identifyFolderIndexPropertyBundle(String pbTag) Identify the "Folder Index PropertyBundle".
protected boolean	isIndexEnabled(LibrarySession session) Return true if there is a folder index enabled currently.
protected boolean	isUpdateModeSynchronous(LibrarySession session) Return true if the update mode of the folder index is synchronous.
protected void	promoteFolder(LibrarySession session, Folder folder, int newLevel, String prefix) Promote a folder to a higher index level.
protected void	promoteFoldersByPath(LibrarySession session, String[] paths, int newLevel, String prefix) Promote folders to a higher index level.
protected void	rebuildIndex(LibrarySession session, String prefix) Rebuild the folder index.
protected void	resetFolderIndexRows(LibrarySession session, String prefix) Delete all rows form the folder index except for the "self" rows used to register each existing folder.
protected void	setUseExistsClause(LibrarySession session, boolean useExists, String prefix) Update the 'UseExistsClause' property on the FolderIndex propertyBundle event target.
void	updateFolderIndex(AttributeValueTable avt) Update the Folder index.

Methods inherited from class oracle.ifs.core.tools.script.ScriptOperations

abortTransaction, acquireLock, acquireManualLock, activateAuditHandlerSpecification, activateAuditSpecification, activateOperationActionSpecification, activateServerSpecification, activateSystemObject, addAttachment, addAttribute, addAuditEventProperty, addAuditType, addAuditTypesForClass, addBooleanHandlerProperty, addCategory, addDefinitionAuditEntryType, addDefinitionAuditEntryTypesForClass, addDefinitionAuditEntryTypesUnderClass, addDefinitionBooleanProperty, addDefinitionDoubleProperty, addDefinitionIntegerProperty, addDefinitionLongProperty, addDefinitionProperties, addDefinitionProperty, addDefinitionStringArrayProperty, addDefinitionStringProperty, addDocumentDefinitionCharacterSet, addDocumentDefinitionContent, addDocumentDefinitionContentBfileReference, addDocumentDefinitionLanguage, addGlobalOperationActionSpecification, addGroupMember, addGroupMembers, addIntegerHandlerProperty, addLifecyclePolicyEntryDefinition, addLifecyclePolicyEntryDefinition, addLongHandlerProperty, addManagedServerDeclaration, addManagedServerDeclaration, addManagedServerDeclaration, addManagedServiceDeclaration, addManagedServiceDeclaration, addPreparedSelectorBindValue, addPreparedSelectorBooleanBindValue, addPreparedSelectorIntegerBindValue, addPreparedSelectorLibraryObjectBindValue, addPreparedSelectorLongBindValue, addPreparedSelectorStringBindValue, addPublicObjectDefinitionCategory, addSchemaObjectDefinitionCategory, addStringArrayHandlerProperty, addStringHandlerProperty, addSystemObjectDefinitionBooleanProperty, addSystemObjectDefinitionCategory, addSystemObjectDefinitionIntegerProperty, addSystemObjectDefinitionLongProperty, addSystemObjectDefinitionStringArrayProperty, addSystemObjectDefinitionStringProperty, addToDocumentDefinition, addToPublicObjectDefinition, applyLogLevelOverride, applyNamedFreezeLock, applySingletonLock, assignClassDomain, assignLifecyclePolicyByCategory, assignValueDefault, assignValueDomain, beginTransaction, businessObjectExists, clearImpersonateUser, clearSharedCaches, cloneCurrentSession, cloneDefinition, cloneDefinition, comment, comment, compareObjects, completeTransaction, concatenateObjectId, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateToLowerStrings, concatenateToLowerStrings, concatenateToLowerStrings, concatenateToUpperStrings, concatenateToUpperStrings, concatenateToUpperStrings, connect, connect, constructAuditEvent, constructPreparedSelectorGenerator, constructPreparedSelectorGenerator, convertPropertyDefinitionsToHashtable, convertStringArray, convertToBoolean, convertToBoolean, convertToDouble, convertToDouble, convertToInteger, convertToInteger, convertToLong, convertToLong, convertToRelativePath, copy, create, createAccessControlList, createAndApplyAuditTypeList, createApplicationToken, createApplicationToken, createAuditSpecification, createAuditSpecification, createAuditSpecification, createAuditSpecification, createAuditTypeList, createAuditTypeList, createAutoFolderingActionSpecification, createAutoFolderingActionSpecification, createCategorizedDocument, createClassDomain, createClassObject, createClassObject, createCustomLockEntry, createCustomMediaDriverSpecification, createCustomMediaDriverSpecification, createDefinition, createDefinitionFromDefinitionObject, createDefinitionFromObject, createDefinitionObject, createDependentView, createDocument, createDocument, createDocument, createDocumentBatch, createDocuments, createEntireAuditSpecification, createExtendedPermission, createExtendedUserProfile, createFolder, createFolder, createFolder, createFolderLink, createFolderTree, createFormat, createGroup, createGuestSession, createLibraryObject, createLibraryObject, createLifecycleDateRuleSpecification, createLifecycleDateRuleSpecification, createLifecyclePolicy, createLifecyclePolicy, createLifecyclePolicyActionSpecification, createLifecyclePolicyActionSpecification, createLifecyclePolicyEntryDefinition, createLink, createLink, createLink, createLockTypeLookupTables, createMedia, createMedia, createNamedFreezeLock, createNamedPropertyBundle, createNodeConfiguration, createNodeConfiguration, createOperationActionSpecification, createOperationActionSpecification, createOrUpdateClassObject, createPermissionBundle, createPolicy, createPolicyList, createPropertyBundle, createQueue, createRetentionPolicy, createServerConfiguration, createServerConfiguration, createServerSpecification, createServiceConfiguration, createServiceConfiguration, createSession, createSession, createSimplePropertyTable, createSimplePropertyTableList, createStorageGroup, createStorageGroup, createSystemLockObject, createUser, createUserSession, createValueDefault, createValueDomain, deactivateAuditHandlerSpecification, deactivateAuditSpecification, deactivateOperationActionSpecification, deactivateServerSpecification, deactivateSystemObject, deactivateUnknownOperationActionSpecifications, defineAttribute, defineAuditHandlerSpecificationDefinition, defineAuditHandlerSpecificationDefinition, defineAuditTargetSpecificationDefinition, defineAuditTypeListDefinition, defineAuditTypeListDefinition, defineClassObject, defineExistingClassObject, definitionExists, deleteAllCategories, deleteAuditSpecification, deleteNamedFreezeLock, deleteRepositoryParameter, deleteUser, deregisterBusinessObject, deregisterCustomLockType, deregisterDefinition, deregisterLockType, deregisterObject, deregisterSession, deregisterTransaction, determinePrimaryObjectColumnAlias, ensureFreed, executeAutocommitSql, executePreparedSelect, executePreparedSelect, executePreparedSelect, executePreparedSelect, executePreparedSelectCount, executePreparedSelectCount, executePreparedSelectCount, executePreparedSelectFromJson, executePreparedSelectResults, exists, existsRelative, extractContentForIndexing, findOrCreateCompositeGroup, freeClassDomain, freeClassObject, freeExtendedPermission, freeFolder, freeFormat, freeNamedPropertyBundle, freeNamedPropertyBundle, freeNodeConfiguration, freeNodeConfiguration, freeObject, freePermissionBundle, freePolicy, freeServerConfiguration, freeServerConfiguration, freeServiceConfiguration, freeServiceConfiguration, freeUnreferencedContent, freeValueDefault, freeValueDomain, generateClassObjectDefinitionTag, getAbsolutePath, getAclValueForConfigurationObjects, getAttributeValue, getAttributeValue, getAttributeValue, getAuditDriverHelper, getAuditEventDispatcher, getAuditingStartingId, getAuxiliaryTargets, getBindValues, getBypassSecurityAliases, getClassObjectCreationMode, getConsoleInputBoolean, getConsoleInputString, getConsoleInputString, getConsoleInputString, getConsoleSecureInputString, getContentPath, getCurrentSession, getDriver, getIncludedFileSettings, getLogWriter, getManagedServerDeclarations, getManagedServiceDeclarations, getParameterTable, getSavedSearchResultPrimaryObjects, getSavedSearchResults, getShowDates, getStringArray, getStringsFromArrayToken, getStripNumbersFromAuditEventProperties, handleEventPostedForCustomAuditHistory, handleTimerExpiredForCustomAuditHistory, identifyAcl, identifyAcl, identifyApplicationToken, identifyAttribute, identifyAttributePropertyBundle, identifyAuditHandlerSpecification, identifyAuditSpecification, identifyAuditTargetSpecification, identifyAuditTypeList, identifyAuditTypeListBySpecification, identifyAutoFolderingActionSpecification, identifyByAttribute, identifyByPath, identifyByRelativePath, identifyCategory, identifyCategory, identifyClassAcl, identifyClassDomain, identifyClassObject, identifyClassPolicyBundle, identifyClassPropertyBundle, identifyCompositeGroup, identifyCustomLock, identifyCustomMediaDriverSpecification, identifyDependentView, identifyExtendedPermission, identifyFormat, identifyGlobalAuditSpecification, identifyGlobalAuditTypeList, identifyGroup, identifyGuestUser, identifyInstancePropertyBundle, identifyLibraryObject, identifyLifecycleDateRuleSpecification, identifyLifecyclePolicy, identifyLifecyclePolicyActionSpecification, identifyLifecyclePolicyEntry, identifyMedia, identifyMessageEntry, identifyMessageList, identifyNamedFreezeLock, identifyNamedPropertyBundle, identifyNodeConfiguration, identifyObjectAuditSpecification, identifyObjectProperty, identifyOperationActionSpecification, identifyPermissionBundle, identifyPolicy, identifyPolicyList, identifyPrimaryUserProfile, identifyPropertyBundle, identifyQueue, identifyQueueTypeMapBundle, identifyRetentionPolicy, identifyServerConfiguration, identifyServerSpecification, identifyServiceConfiguration, identifySingletonLockType, identifyStorageGroup, identifySystemAcl, identifySystemLockObject, identifySystemUser, identifyUser, identifyValueDefault, identifyValueDomain, identifyWorldGroup, impersonateUser, impersonateUser, initializeManualTextIndexingRetainedEvents, isBootstrapModeEnabled, isDomainScopeImpliedForSearch, isInArray, log, log, lookupAcl, lookupApplicationToken, lookupAuditDomainContext, lookupAuditSpecification, lookupAutoFolderingActionSpecification, lookupBusinessObject, lookupBusinessObjectHashtable, lookupBusinessObjectList, lookupClassAcl, lookupDatatype, lookupDatatypeString, lookupDefinition, lookupDefinition, lookupDirectoryObject, lookupDocument, lookupFolder, lookupFormat, lookupFormatFromCollection, lookupGroup, lookupMedia, lookupMessageEntry, lookupObject, lookupObject, lookupObjectAttributeValue, lookupObjectId, lookupOperationActionSpecification, lookupPublicObject, lookupQueue, lookupSessionByTag, lookupSystemAcl, lookupSystemLockObject, lookupTagBySessionId, lookupUser, lookupUserFromCollection, makeDefinitionReadOnly, markCurrentAuditingId, modifyClassObject, move, moveCategory, normalizeBooleanString, notifyCustomAuditHistoryHandler, objectExists, postCustomAuditEvent, postCustomAuditEvent, postCustomAuditEvent, postSystemAuditEvent, postSystemAuditEvent, preprocessDocumentSettings, preprocessPublicObjectSettings, printStackTrace, processManualTextIndexingRetainedEvents, processRawAuditEvents, purgeGlobalAuditHistory, reactivateUnknownOperationActionSpecifications, readDocumentContent, refreshDependentView, registerAllNonCustomAuditTypes, registerAuditEventType, registerAuditEventType, registerBusinessObject, registerCustomAuditType, registerCustomLockType, registerDefinition, registerLockType, registerNewSession, registerObject, registerTransaction, releaseLock, releaseManualLock, removeAcesForFreedGrantees, removeAllAttachments, removeAttachment, removeAttribute, removeClassProperty, removeCustomLockEntry, removeGroupMembers, removeNamedFreezeLock, removeProperties, removeServerFromNodeConfiguration, removeServiceFromNodeConfiguration, removeSession, removeSessionState, removeSingletonLock, removeTag, rename, replaceMediaLookupsByFormat, replaceSession, resetFolderCountInfo, restoreGlobalOperationActionSpecification, runSchemaCreator, runScript, saveGlobalOperationActionSpecification, saveSearchResultPrimaryObjects, saveSearchResults, searchAuditHistory, searchAuditHistory, searchAuditHistory, sessionExists, setAdminMode, setAdminMode, setArrayTokenDelimiter, setAuditingStartingId, setAuditSpecificationAuditHandlerSpecificationDefinition, setAuditSpecificationAuditTargetSpecificationDefinition, setAuditSpecificationAuditTypeListDefinition, setAuditTargetSpecificationDefinitionTarget, setBooleanInstanceProperty, setClassObjectCreationMode, setClassPolicyList, setClassProperty, setCreateCategoriesServerSideOption, setCurrentSession, setCurrentSession, setDateFormat, setDefaultAuditEventSortClause, setDefaultMedia, setDefaultScriptOperationsClass, setDefaultStorageGroup, setDefinitionAttribute, setDefinitionAttribute, setDefinitionBooleanAttribute, setDefinitionClassObjectAttribute, setDefinitionDateAttribute, setDefinitionDirectoryObjectArrayAttribute, setDefinitionDirectoryObjectAttribute, setDefinitionDoubleAttribute, setDefinitionIntegerAttribute, setDefinitionLongAttribute, setDefinitionNullStringAttribute, setDefinitionObjectAttribute, setDefinitionSchemaObjectArrayAttribute, setDefinitionSchemaObjectAttribute, setDefinitionStringArrayAttribute, setDefinitionStringAttribute, setDefinitionSystemObjectAttribute, setDocumentDefinitionContentObjectDefinition, setGlobalAuditTypeList, setGlobalOperationActionSpecifications, setInstallationMode, setInstallationMode, setInstanceProperty, setIntegerInstanceProperty, setLifecyclePolicyDefinitionDeleteEntriesOption, setLocale, setLongInstanceProperty, setLongSessionState, setMainSessionAsCurrentSession, setMediaLookupByFormat, setNumberFormat, setObjectProperty, setPreventSessionTimeouts, setPreventSessionTimeouts, setProperty, setPublicObjectInstanceProperty, setRepositoryParameter, setStringInstanceProperty, setStringSessionState, setSubstitutionPrefix, setSystemAdminMode, setSystemAdminMode, setSystemObjectInstanceProperty, setTimeoutPeriodOption, setTimeZone, setUserCreateOptions, setUserDefaultAcl, setUserDeleteOptions, showAcl, showAggregateAuditEventColumns, showAllAutoFolderingActionSpecifications, showAllClassAcls, showAllClassDomains, showAllClassObjects, showAllCustomAuditSpecifications, showAllCustomMediaDriverSpecifications, showAllDependentViews, showAllExtendedPermissions, showAllExternalRetentionPolicies, showAllFormats, showAllLifecycleDateRuleSpecifications, showAllLifecyclePolicies, showAllLifecyclePolicyActionSpecifications, showAllMedias, showAllNodeConfigurations, showAllNodeConfigurations, showAllOperationActionSpecifications, showAllPermissionBundles, showAllPolicies, showAllPolicyLists, showAllRepositoryParameters, showAllRetentionPolicies, showAllServerConfigurations, showAllServerConfigurations, showAllServerSpecifications, showAllServiceConfigurations, showAllServiceConfigurations, showAllStorageGroups, showAllSystemAcls, showAllValueDefaults, showAllValueDomains, showApplicationToken, showApplicationTokens, showAttachments, showAttribute, showAttribute, showAuditCertificates, showAuditEventOperationTypes, showAuditSpecification, showAuditTypeList, showAuditTypesForClass, showAuditTypesForCreateOperations, showAuditTypesForFreeOperations, showAuditTypesUnderClass, showAutoFolderingActionSpecification, showCapabilities, showClassDomain, showClassDomain, showClassObject, showClassObjectAndSubNames, showClassObjectAndSubs, showCompositeGroup, showCreateClassObjectScript, showCurrentUser, showCustomAuditHistory, showCustomAuditHistory, showCustomAuditTypes, showCustomMediaDriverSpecification, showDefaultMedia, showDefaultStorageGroup, showDefineAttributeScript, showDefinition, showDefinitionObject, showDependentView, showDocument, showDocumentCharacterSet, showDocumentContentInfo, showDocumentContents, showDocumentContents, showDocumentContents, showDocumentLanguage, showDocumentsWithLifecyclePolicy, showExpandedAuditTypeList, showExtendedPermission, showFolder, showFolder, showFolderCountInfo, showFormat, showGlobalAuditHistory, showGlobalAuditHistory, showGlobalAuditSpecification, showGlobalAuditTypeList, showGlobalOperationActionSpecifications, showGroup, showInstanceProperty, showInstancePropertyBundle, showLibraryObject, showLibraryObject, showLifecycleDateRuleSpecification, showLifecyclePolicy, showLifecyclePolicyActionSpecification, showLifecyclePolicyEntry, showLink, showLocalizer, showLockEntry, showLockEntryInfo, showLockTypeLookupTables, showMedia, showMediaLookupByFormatMappings, showMessageEntry, showMessageList, showNamedPropertyBundle, showNodeConfiguration, showNodeConfiguration, showObject, showObjectAuditHistory, showObjectAuditHistory, showObjectAuditSpecification, showOperationActionSpecification, showParsedArrayToken, showParsedOperationString, showPermissionBundle, showPolicy, showPolicyList, showPreparedSelector, showPreparedSelector, showProperty, showPropertyBundle, showRepositoryParameter, showRetentionPolicy, showRuntimeStatistics, showSavedSearchResultPrimaryObjects, showSavedSearchResults, showServerConfiguration, showServerConfiguration, showServerSpecification, showServiceConfiguration, showServiceConfiguration, showServiceStatistics, showSessionCacheStatistics, showSessionState, showSimplePropertyTable, showSimplePropertyTableList, showStorageGroup, showUser, showValueDefault, showValueDefault, showValueDomain, showValueDomain, sleep, syncContentIndex, syncIndex, testJsonString, tokenToDirectoryObjectArray, tokenToDirectoryUserArray, tokenToDocumentArray, transactionExists, unregisterAuditEventType, unregisterCustomAuditType, update, updateAccessControlList, updateClassDomain, updateDefinitionObject, updateLibraryObject, updateLibraryObject, updateLibraryObject, updateNodeConfiguration, updateNodeConfiguration, updateServerConfiguration, updateServerConfiguration, updateServiceConfiguration, updateServiceConfiguration, updateUserPassword, updateValueDefault, updateValueDomain, verifyBusinessObjectTagNotExists, verifyDefinitionTagNotExists, verifyDefinitionWriteable, verifyObjectTagNotExists, writeConsoleOutputString, writeConsoleOutputString, writeDocumentContentToFile, zeroPad

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderIndexOperations

public FolderIndexOperations(ScriptDriver driver)

Constructs an FolderIndexOperations.

Parameters:

driver - the main script driver instance

(Published)

Method Detail

dropFolderIndex

public void dropFolderIndex(AttributeValueTable avt)
                     throws IfsException

Drop the current Folder index.

The keys supported by this operation:

• SKIPIFNOTEXISTS: whether to skip the operation if no index exists (boolean)

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

(Published)

createFolderIndex

public void createFolderIndex(AttributeValueTable avt)
                       throws IfsException

Create a Folder index.

The keys supported by this operation:

• MAXLEVEL: maximum index level
• UPDATEMODE: the update mode: valid values are Sync[hronous] and Async[hronous]
• DEFERTOAGENT: whether to defer most of the index creation to FolderIndexAgent; valid only with UpdateMode set to Asynchronous
• SKIPIFEXISTS: whether to skip the operation if index exists (boolean)

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

(Published)

updateFolderIndex

public void updateFolderIndex(AttributeValueTable avt)
                       throws IfsException

Update the Folder index.

The keys supported by this operation:

• UPDATEMODE: the new update mode: valid values are Sync[hronous] and Async[hronous]
• APPLYDEFERREDUPDATES: whether to apply updates deferred to FolderIndexAgent
• USEEXISTSCLAUSEFORSEARCH: whether to change search setting so that "exists" clause is used in FRQ searches
• USEINCLAUSEFORSEARCH: whether to change search setting so that "in" clause is used in FRQ searches
• SKIPIFNOTEXISTS: whether to skip the operation if index does not exist (boolean)

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

(Published)

identifyFolderIndexPropertyBundle

public void identifyFolderIndexPropertyBundle(String pbTag)
                                       throws IfsException

Identify the "Folder Index PropertyBundle".

Parameters:

pbTag - the tag to use

Throws:

IfsException - if the operation fails

(Published)

isIndexEnabled

protected boolean isIndexEnabled(LibrarySession session)
                          throws IfsException

Return true if there is a folder index enabled currently.

Parameters:

session - the session

Returns:

true if there is a folder index enabled

Throws:

IfsException - if operation fails

(Published)

getMaxLevel

protected int getMaxLevel(LibrarySession session)
                   throws IfsException

Get the maximum folder index level.

Will return -1 if no index exists.

Parameters:

session - the session

Returns:

the max level.

Throws:

IfsException - if operation fails

(Published)

isUpdateModeSynchronous

protected boolean isUpdateModeSynchronous(LibrarySession session)
                                   throws IfsException

Return true if the update mode of the folder index is synchronous.

This also returns true if there is no folder index.

Parameters:

session - the session

Returns:

true if the update mode of the folder index is synchronous.

Throws:

IfsException - if operation fails

(Published)

createFolderIndexTables

protected void createFolderIndexTables(LibrarySession session,
                                       int maxLevel,
                                       String prefix)
                                throws IfsException

Create the tables that comprise the folder index.

Also initialize the table with "self" rows for all existing folders. All entries are initialized at level 0 of the folder index.

Parameters:

session - the session

maxLevel - the max level

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

(Unpublished)

createInitialFolderIndexRows

protected void createInitialFolderIndexRows(LibrarySession session,
                                            String prefix)
                                     throws IfsException

Create the initial self-reference rows for the folder index.

Parameters:

session - the session

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

(Unpublished)

resetFolderIndexRows

protected void resetFolderIndexRows(LibrarySession session,
                                    String prefix)
                             throws IfsException

Delete all rows form the folder index except for the "self" rows used to register each existing folder.

Parameters:

session - the session

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

(Unpublished)

dropIndex

protected void dropIndex(LibrarySession session,
                         String prefix)
                  throws IfsException

Drop the folder index.

This method has no effect if there is no index to drop.

Parameters:

session - the session

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

(Unpublished)

completeIndexCreation

protected void completeIndexCreation(LibrarySession session,
                                     boolean deferCreate,
                                     String prefix)
                              throws IfsException

Completes the creation of the folder index.

This must be called to remove the "partially created" flag on the index.

Parameters:

session - the session

deferCreate - whether creation is being deferred to the agent

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

(Unpublished)

changeUpdateMode

protected void changeUpdateMode(LibrarySession session,
                                boolean isSync,
                                String prefix)
                         throws IfsException

Change update mode to either synchronous or asynchronous.

If the specified mode is the same as the current mode of the index, no change takes place (and no exception is thrown)

Parameters:

session - the session

isSync - the desired update mode: true = synchronous, false = asynchronous

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

(Unpublished)

promoteFolder

protected void promoteFolder(LibrarySession session,
                             Folder folder,
                             int newLevel,
                             String prefix)
                      throws IfsException

Promote a folder to a higher index level.

Parameters:

session - the session

folder - the folder to promote

newLevel - the new level

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

promoteFoldersByPath

protected void promoteFoldersByPath(LibrarySession session,
                                    String[] paths,
                                    int newLevel,
                                    String prefix)
                             throws IfsException

Promote folders to a higher index level.

The folders are specifed by absolute folder path.

Parameters:

session - the session

paths - the paths for the folders to promote

newLevel - the new level

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

rebuildIndex

protected void rebuildIndex(LibrarySession session,
                            String prefix)
                     throws IfsException

Rebuild the folder index.

Assume that the index has been either reset back to a state where only self rows exist, or that a new index has been created, but only self rows currently exist.

Parameters:

session - the session

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

(Unpublished)

applyDeferredUpdates

protected long applyDeferredUpdates(LibrarySession session,
                                    String prefix)
                             throws IfsException

Apply deferred updates.

Parameters:

session - the session

prefix - the indentation prefix for log messages

Returns:

the number of updates applied

Throws:

IfsException - if operation fails

(Unpublished)

setUseExistsClause

protected void setUseExistsClause(LibrarySession session,
                                  boolean useExists,
                                  String prefix)
                           throws IfsException

Update the 'UseExistsClause' property on the FolderIndex propertyBundle event target.

Parameters:

session - the session

useExists - the desired value for the search property

prefix - the indentation prefix for log messages

Throws:

IfsException - if operation fails

(Published)