Class SearchParameter

Represents a generic search parameter.

Class SearchParameter

Namespace: Gedcomx\Rs\Client\Util
Package: Gedcomx\Rs\Client\Util
Located at Rs/Client/Util/SearchParameter.php

Methods summary

`public`	# `__construct( $prefix, $name, $value, $exact )` Constructs a new search parameter using the specified parameters. Constructs a new search parameter using the specified parameters. Parameters `$prefix` `$name` `$value` `$exact` Throws `Gedcomx\Rs\Client\Exception\NullValueException`
`public mixed`	# `getPrefix( )` Gets the prefix to apply to the search parameter. This is used for controlling whether a parameter is required or not. The prefix can take on three forms: "+": The parameter search value should be found in the search results null: The parameter search filter is optional "-": The parameter search value should not found in the search results (i.e., perform a NOT seaarch) Gets the prefix to apply to the search parameter. This is used for controlling whether a parameter is required or not. The prefix can take on three forms: "+": The parameter search value should be found in the search results null: The parameter search filter is optional "-": The parameter search value should not found in the search results (i.e., perform a NOT seaarch) Returns mixed
`public mixed`	# `getName( )` Gets the name of the current search parameter. Gets the name of the current search parameter. Returns mixed
`public mixed`	# `getValue( )` Gets the value of the current search parameter. Gets the value of the current search parameter. Returns mixed
`public mixed`	# `isExact( )` Gets a value indicating whether the current search parameter requires exact value match results. If this value is true, search results will only return values that exactly match the search parameter value. Gets a value indicating whether the current search parameter requires exact value match results. If this value is true, search results will only return values that exactly match the search parameter value. Returns mixed
`public string`	# `__toString( )` Returns a string that is a syntactically conformant search query that can be used in REST API search requests. Returns a string that is a syntactically conformant search query that can be used in REST API search requests. Returns string