SavedQuery

Represents a saved search.

Properties

Name	Type	Description
becomesRemoved	`Boolean`	When `true`, the entity is removed in the current transaction. Otherwise, `false`. Available since 2017.4.37915
isNew	`Boolean`	When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351
name	`String`	The name of the tag or saved search.
owner	`User`	The user who created the saved search.
query	`String`	The search query.
shareGroup	`UserGroup`	The group of users for whom the tag or saved search is visible. If the tag or the saved search is only visible to its owner, the value for this property is `null`.
updateShareGroup	`UserGroup`	The group of users who are allowed to update the settings for the tag or saved search. If the tag or the saved search can only be updated by its owner, the value for this property is `null`.

Methods

findByName

static findByName(name)

Finds a list of saved searches with the specified name. The list only includes saved searches that are visible to the current user. The saved searches that were created by the current user are returned at the top of the list.

Parameters

Name	Type	Description
name	`String`	The name of the saved search to search for.

Return Value

	Type	Description
	`Set.<SavedQuery>`	A list of saved searches that match the specified name.

findQueryByName

static findQueryByName(name)

Finds the most relevant saved search with the specified name that is visible to the current user.

Parameters

Name	Type	Description
name	`String`	The name of the saved search to search for.

Return Value

	Type	Description
	`SavedQuery`	The most relevant saved search.

becomes

becomes(fieldName, expected)

Checks whether a field is set to an expected value in the current transaction.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.
expected	`string`	The expected value.

Return Value

	Type	Description
	`boolean`	If the field is set to the expected value, returns `true`.

canBeReadBy

canBeReadBy(fieldName, user)

Checks whether a user has permission to read the field.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.
user	`User`	The user for whom the permission to read the field is checked.

Return Value

	Type	Description
	`boolean`	If the user can read the field, returns `true`.

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks whether a user has permission to update the field.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.
user	`User`	The user for whom the permission to update the field is checked.

Return Value

	Type	Description
	`boolean`	If the user can update the field, returns `true`.

isChanged

isChanged(fieldName)

Checks whether the value of a field is changed in the current transaction.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.

Return Value

	Type	Description
	`boolean`	If the value of the field is changed in the current transaction, returns `true`.

oldValue

oldValue(fieldName)

Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, returns null.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.

Return Value

	Type	Description
	`Object`	If the field is changed in the current transaction, the previous value of the field. Otherwise, null.

required

required(fieldName, message)

Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.
message	`string`	The message that is displayed to the user that describes the field requirement.

Last modified: 7 March 2019