SY_SearchData

Class SY_SearchData_Role

Dynamic full-text search for Role Maintenance: Tasks, Security Events, and Module Options

Constructor

Initialize a Sage.Data.Search object

Parameter	Description
coSession	[input, object, required] Reference to the SY_Session object
bIgnoreNoData	[input, boolean, optional] When set, will skip the check for data in the data index used for the search.
bIsRolePlus	[input, boolean, optional] When set to true denotes that the search is being done from the Role Plus task

The constructor will fail if the DLL cannot be located.

Inherits

SY_OpenObject, SY_SearchData

Properties

LOCAL cTaskTypeMenu$="07"

LOCAL cTaskTypeSecurity$="04"

LOCAL cTaskTypeApplication$="08"

Methods

FUNCTION BuildIndex()

Build the search index

Returns

[boolean] 0 - Cannot build index, 1 - build successful

FUNCTION GetDataIOL$()

Get IOList to use for separating the search data stored in the DocData field in the search index into fields.

Returns

[string] IOLIST to use for DocData field in the search Index

FUNCTION GetResultsFormat$()

Get format definition to use for the display of the search results in the Report-View of the Advanced Search

Returns

[string] Format definition used to display search results in Advanced Search dialog

FUNCTION GetResultsIOL$()

Get IOList to use for data to load into the Report View when using the Advanced Search

Returns

[string] IOLIST to use for data to load into Reort View to display the search results in Advanced Search dialog

FUNCTION GetStoredIOL$()

Get IOList to use for separating the stored data stored in the DocStored field in the search index into fields.

Returns

[string] IOLIST to use for DocStored field in the search Index

This method can be implemented in child class to define IOLIST for data to be stored in the search index but not included as part of a search

FUNCTION ReturnSearchData(index, folderTab$, itemDesc$, itemModule$)

Get data returned by search

Parameter	Description
index	[input / output, number] Index to returned value in the list of search results
folderTab$	[output, string] Folder Name associated the selected row from result set
itemDesc$	[output, string] Description for the selected row from result set
itemModule$	[output, string] Module for the selected row from result set

Returns

[boolean] 0 - No Data Found, 1 - Data Found

Properties inherited from: SY_OpenObject

cLockInfoNOKEY$

Properties inherited from: SY_SearchData

cIndexFieldEntityKey$, cIndexFieldEntityName$, cIndexFieldDocKey$, cIndexFieldDocData$, cIndexFieldDocStored$, cDefaultFieldSep$, cIndexName$, cIndexAlternateSep$, EntityName$, LastSearchValue$, RebuildMsg$, ResultCount, SearchResultLimit

Methods inherited from: SY_OpenObject

CheckWhoHasLock(), CreateLockInfo(), RemoveLockInfo(), OpenTable(), OpenTempFile()

Methods inherited from: SY_SearchData

AdvancedSearch(), BuildIndex(), CheckBuildLockFile(), CheckIndexData(), CreateIndex(), DeleteDocument(), GetDataIOL$(), GetIndexName$(), GetIndexPassword$(), GetMlacExpressions(), GetResultsFormat$(), GetResultsIOL$(), GetStoredIOL$(), GetStoredValue$(), IsIndexEncrypted(), IsIndexUpdateInProgress(), MarkIndexRebuildRequired(), OpenIndex(), ResetIndex(), ReturnSearch(), SearchIndex(), SetEntityKeyValue(), SetEntityName(), SetSkipProgessBar(), UpdateDocument(), FreeIndexDocumentObjects(), GetEntityKeyValue$(), InitSearchObject(), IsRebBuildRequired(), ShowProgressBar(), TranslateIndexData$(), TranslateSearchData$(), UpdateIndex(), UpdateProgressBar(), WriteBuildIndexLog()