MultiChoiceUpdateValue Class

Relativity Services API
Describes the value and behavior used to update a MultiChoice field.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.MultiChoiceUpdateValue

Namespace:  kCura.Relativity.Client
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class MultiChoiceUpdateValue

The MultiChoiceUpdateValue type exposes the following members.

Constructors

  NameDescription
Public methodMultiChoiceUpdateValue()
Default constructor for the Field class. It creates an empty object.
Public methodMultiChoiceUpdateValue(List<List<Guid>>)
Creates a new MultiChoiceUpdateValue object.
Public methodMultiChoiceUpdateValue(List<Guid>)
Creates a new MultiChoiceUpdateValue object.
Public methodMultiChoiceUpdateValue(List<Int32>)
Creates a new MultiChoiceUpdateValue object.
Public methodMultiChoiceUpdateValue(MultiChoiceUpdateBehavior)
Creates a new MultiChoiceUpdateValue object.
Public methodMultiChoiceUpdateValue(List<List<Guid>>, MultiChoiceUpdateBehavior)
Creates a new MultiChoiceUpdateValue object.
Public methodMultiChoiceUpdateValue(List<Guid>, MultiChoiceUpdateBehavior)
Creates a new MultiChoiceUpdateValue object.
Public methodMultiChoiceUpdateValue(List<Int32>, MultiChoiceUpdateBehavior)
Creates a new MultiChoiceUpdateValue object.
Top
Properties

  NameDescription
Public propertyBehavior
Provides the MultiChoiceUpdateBehavior Enum indicating the behavior (Replace or Merge) used to update a Field.
Public propertyValue
Indicates the value applied to MultiChoice Field.
Public propertyValueAsGuid
Provides a list of identifiers for new choice values used for updating a MultiChoice Field. Each List of GUID must represent a Choice Artifact.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

The MultiChoiceUpdateValue object is used as a parameter when creating or updating a MultiChoice field. It takes a Value property as a List of ArtifactID objects or ValueAsGuid as a List of GUIDs, which representing a Choice Artifacts. This class also includes constructors for instantiating objects with single GUIDS representing different Choice Artifacts. The Behavior property specifies the use of Replace or Merge operations for updating values. The Merge behavior adds a new value to the MultiChoice field, while Replace overrides them. For example, when the MultiChoiceUpdateValue object has a Value of yellow, and a Behavior of Merge, a document with MultiChoice field called color with a value of Red will be updated to include Red and Yellow values. When the MultiChoiceUpdateValue object has a Value of Green, and a Behavior of Replace, the same document with a value of Red will be updated to have only the value Green because the previous values are overwritten.
See Also

Reference