Class ObjectSearchOptions
- Namespace
- ArcanaDevelopment.adTempus.Shared
- Assembly
- ArcanaDevelopment.adTempus.Shared.dll
Options for a search/replace operation
[DataContract]
public class ObjectSearchOptions- Inheritance
-
objectObjectSearchOptions
Constructors
ObjectSearchOptions()
public ObjectSearchOptions()Fields
Action
The type of operation to perform
[DataMember]
public SearchReplaceType ActionField Value
ChangeLogOptions
Options for recording Change Log entries for modified objects
[DataMember]
public ChangeLogParameters ChangeLogOptionsField Value
ReplacementText
The replacement text, when performing a replacement operation
[DataMember]
public string ReplacementTextField Value
- string
ReturnObjects
Determines whether the objects will be returned by a search operation.
[DataMember]
public bool ReturnObjectsField 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 is 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 SearchCapturedFileContentsField Value
- bool
Remarks
If SearchCapturedFileContents is not checked, only file names/descriptions are searched.
SearchCapturedFiles
Search captured file names and/or contents
[DataMember]
public bool SearchCapturedFilesField Value
- bool
- See Also
SearchJobHistory
Search job history (instances, log messages, captured files).
[DataMember]
public bool SearchJobHistoryField Value
- bool
SearchJobLogMessages
Search log messages for jobs
[DataMember]
public bool SearchJobLogMessagesField Value
- bool
SearchServerMessages
Search server-level Log Messages
[DataMember]
public bool SearchServerMessagesField Value
- bool
Remarks
ClassID.LogMessage must be included in IncludeClasses.
SearchSubGroups
Whether to search sub groups of specified groups
[DataMember]
public bool SearchSubGroupsField Value
- bool
TextToFind
The text or pattern to find
[DataMember]
public string TextToFindField Value
- string
- See Also
UseRegularExpressions
Indicates whether the TextToFind is a regular expression or simple text
[DataMember]
public bool UseRegularExpressionsField Value
- bool
Properties
ExcludeClasses
Exclude objects of the specified class(es)
[DataMember]
public List<ClassID> ExcludeClasses { get; }Property Value
- List<ClassID>
ExcludeFields
Do not search the specified field(S)
[DataMember]
public List<string> ExcludeFields { get; }Property Value
- List<string>
ExcludeFilePatterns
List of file patterns to exclude when searching CapturedFile contents.
[DataMember]
public List<string> ExcludeFilePatterns { get; }Property Value
- List<string>
ExcludeObjects
Do not search the specified objects
[DataMember]
public List<OID> ExcludeObjects { get; }Property Value
- List<OID>
ExcludeTags
Exclude objects with the specified tag(s)
[DataMember]
public List<string> ExcludeTags { get; }Property Value
- List<string>
IncludeClasses
Include only objects of the specified class(es)
[DataMember]
public List<ClassID> IncludeClasses { get; }Property Value
- List<ClassID>
IncludeFields
Only search the specified field(s)
[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
Search only the specified objects
[DataMember]
public List<OID> IncludeObjects { get; }Property Value
- List<OID>
IncludeTags
Only include objects with the specified tag(s)
[DataMember]
public List<string> IncludeTags { get; }Property Value
- List<string>