Skip to content

Commit 908a1fe

Browse files
committed
Documenting new ISearchFactory methods
1 parent c085d5b commit 908a1fe

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

src/NHibernate.Search/ISearchFactory.cs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,31 @@ public interface ISearchFactory
3737
/// <param name="entityType"></param>
3838
void Optimize(System.Type entityType);
3939

40+
/// <summary>
41+
/// Gets a FilterDef object by name from the ISearchFactory implementation.
42+
/// A return value indicates if a matching FilterDef was found
43+
/// </summary>
44+
/// <param name="name"></param>
45+
/// <param name="filter"></param>
46+
/// <returns>True/false whether or not a FilterDef exists for the name.</returns>
4047
bool TryGetFilterDefinition(string name, out FilterDef filter);
4148

49+
/// <summary>
50+
/// Gets a FilterDef object by name from the ISearchFactory implementation.
51+
/// Throws an exception if one does not exist.
52+
/// </summary>
53+
/// <param name="name"></param>
54+
/// <returns>A FilterDef object associated with the included name parameter.</returns>
4255
FilterDef GetFilterDefinition(string name);
4356

57+
/// <summary>
58+
/// Adds a FilterDef object to the ISearchFactory implementation with the given name.
59+
/// In most cases, FilterDefs should be added during mapping configuration in a
60+
/// custom ISearchMapping implementation. This method enables FilterDefs to be added
61+
/// after mapping at run-time anytime an IFullTextSession is available.
62+
/// </summary>
63+
/// <param name="name"></param>
64+
/// <param name="filter"></param>
4465
void AddFilterDefinition(string name, FilterDef filter);
4566
}
4667
}

0 commit comments

Comments
 (0)