com.sovren.models.api.matching.ui

Class UIOptions

java.lang.Object

com.sovren.models.api.matching.ui.UIOptions

public class UIOptions
extends Object

Options for creating the Matching UI

Field Summary

Fields

Modifier and Type	Field and Description
boolean	ExecuteImmediately true to execute the query as soon as the page loads (default = false).
UserActionHookCollection	Hooks Contains all the User Action Hooks for the Match UI session.
boolean	ShowBanner true to show the banner containing your account logo inside the matching UI (default = true).
boolean	ShowDetailsButton true to show a button that opens the 'details' popup containing detailed job/resume info (default = true).
boolean	ShowFilterCriteria true to allow the user to see/modify the filter criteria (default = true).
boolean	ShowFindSimilar true to add a button in the Actions menu that matches other jobs/resumes similar to the current one (default = true).
boolean	ShowJobBoards true to include job boards in search/match results.
boolean	ShowSavedSearches true to allow the user to save custom searches or select from pre-made criteria templates (default = false).
boolean	ShowWebSourcing true to include Sovren custom web sourcing in search/match results.
boolean	ShowWeights true to allow the user to see/modify the category weights (default = true).
List<String>	SkillsAutoCompleteCustomSkillsList If you are using custom skills, provide your custom skills list names here.
List<UserDefinedTagsPicklist>	UserDefinedTagsPicklists Picklists shown in the UI for your users to filter on your user-defined tags.
String	Username The username of the user for which you are generating a Matching UI session.

Constructor Summary

Constructors

Constructor and Description
UIOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

Username

public String Username

The username of the user for which you are generating a Matching UI session.
If you do not provide this, the user will be required to login when they view the page

ShowFilterCriteria

public boolean ShowFilterCriteria

true to allow the user to see/modify the filter criteria (default = true).

ExecuteImmediately

public boolean ExecuteImmediately

true to execute the query as soon as the page loads (default = false). This is only applicable for Searching. All matches/bimetric scoring are executed immediately even if this is false.

ShowBanner

public boolean ShowBanner

true to show the banner containing your account logo inside the matching UI (default = true).

ShowWeights

public boolean ShowWeights

true to allow the user to see/modify the category weights (default = true).

ShowDetailsButton

public boolean ShowDetailsButton

true to show a button that opens the 'details' popup containing detailed job/resume info (default = true).

ShowFindSimilar

public boolean ShowFindSimilar

true to add a button in the Actions menu that matches other jobs/resumes similar to the current one (default = true).

ShowWebSourcing

public boolean ShowWebSourcing

true to include Sovren custom web sourcing in search/match results. Cannot be used for bimetric scoring (default = false).

ShowJobBoards

public boolean ShowJobBoards

true to include job boards in search/match results. Cannot be used for bimetric scoring (default = true). Must add credentials in the Sovren Portal

ShowSavedSearches

public boolean ShowSavedSearches

true to allow the user to save custom searches or select from pre-made criteria templates (default = false).

Hooks

public UserActionHookCollection Hooks

Contains all the User Action Hooks for the Match UI session. These are used to make a seamless integration between your system and the Sovren Matching UI.

UserDefinedTagsPicklists

public List<UserDefinedTagsPicklist> UserDefinedTagsPicklists

Picklists shown in the UI for your users to filter on your user-defined tags.
See also: https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/user-defined-tags/

SkillsAutoCompleteCustomSkillsList

public List<String> SkillsAutoCompleteCustomSkillsList

If you are using custom skills, provide your custom skills list names here. The builtin Sovren skills lists are always included.

Constructor Detail

UIOptions

public UIOptions()