Class ObjectSearchOptions
- Namespace
- ArcanaDevelopment.adTempus.Shared
- Assembly
- ArcanaDevelopment.adTempus.Shared.dll
[DataContract]
public class ObjectSearchOptions
- Inheritance
-
objectObjectSearchOptions
Constructors
ObjectSearchOptions()
public ObjectSearchOptions()
Fields
Action
[DataMember]
public SearchReplaceType Action
Field Value
ChangeLogOptions
[DataMember]
public ChangeLogParameters ChangeLogOptions
Field Value
ReplacementText
[DataMember]
public string ReplacementText
Field Value
- string
ReturnObjects
Determines whether the objects will be returned by a search operation.
[DataMember]
public bool ReturnObjects
Field Value
- bool
Remarks
If ReturnObjects is False, the objects will not be returned by the search option but can be fetched individually by the client when needed. If ReturnObjects is True, all objects with matches will be returned.
If Action==SearchReplaceType.ReplaceAndReturn, the objects are returned regardless of this setting.
SearchCapturedFileContents
Search contents of captured files based on file Patterns in IncludeFilePatterns and ExcludeFilePatterns.
[DataMember]
public bool SearchCapturedFileContents
Field Value
- bool
Remarks
If SearchCapturedFileContents is not checked, only file names/descriptions are searched.
SearchCapturedFiles
[DataMember]
public bool SearchCapturedFiles
Field Value
- bool
SearchJobHistory
Search job history (instances, log messages, captured files).
[DataMember]
public bool SearchJobHistory
Field Value
- bool
SearchJobLogMessages
[DataMember]
public bool SearchJobLogMessages
Field Value
- bool
SearchServerMessages
Search server-level Log Messages
[DataMember]
public bool SearchServerMessages
Field Value
- bool
Remarks
ClassID.LogMessage must be included in IncludeClasses.
SearchSubGroups
[DataMember]
public bool SearchSubGroups
Field Value
- bool
TextToFind
[DataMember]
public string TextToFind
Field Value
- string
UseRegularExpressions
[DataMember]
public bool UseRegularExpressions
Field Value
- bool
Properties
ExcludeClasses
[DataMember]
public List<ClassID> ExcludeClasses { get; }
Property Value
- List<ClassID>
ExcludeFields
[DataMember]
public List<string> ExcludeFields { get; }
Property Value
- List<string>
ExcludeFilePatterns
public List<string> ExcludeFilePatterns { get; }
Property Value
- List<string>
ExcludeObjects
[DataMember]
public List<OID> ExcludeObjects { get; }
Property Value
- List<OID>
ExcludeTags
[DataMember]
public List<string> ExcludeTags { get; }
Property Value
- List<string>
IncludeClasses
[DataMember]
public List<ClassID> IncludeClasses { get; }
Property Value
- List<ClassID>
IncludeFields
[DataMember]
public List<string> IncludeFields { get; }
Property Value
- List<string>
IncludeFilePatterns
List of file patterns to include when searching CapturedFile contents.
[DataMember]
public List<string> IncludeFilePatterns { get; }
Property Value
- List<string>
Remarks
For example, "*.txt" to search all files with .txt extension
IncludeObjects
[DataMember]
public List<OID> IncludeObjects { get; }
Property Value
- List<OID>
IncludeTags
[DataMember]
public List<string> IncludeTags { get; }
Property Value
- List<string>
Methods
IncludeField(string)
public bool IncludeField(string fieldName)
Parameters
| Name | Type | Description |
|---|---|---|
fieldName |
string |
Returns
- bool
IncludeTag(string)
public bool IncludeTag(string tag)
Parameters
| Name | Type | Description |
|---|---|---|
tag |
string |
Returns
- bool