Represents a batch set, which contains multiple groups of documents called batches.
Inheritance Hierarchy
kCura.Relativity.Client.DTOs.Artifact
kCura.Relativity.Client.DTOs.BatchSet
Namespace: kCura.Relativity.Client.DTOs
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The BatchSet type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | BatchSet() |
Initializes a new instance of the BatchSet class.
|
| BatchSet(Int32) |
Initializes a new instance of the BatchSet class with the given ArtifactID.
|
Properties
| Name | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
 | ArtifactID |
Represents a unique identifier for an Artifact.
(Inherited from Artifact.) | ||||||||||
| ArtifactTypeGuids |
Provides a list of GUIDs defined for the ArtifactType.
(Inherited from Artifact.) | ||||||||||
| ArtifactTypeID |
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.) | ||||||||||
| ArtifactTypeName |
Indicates name of the ArtifactType used to define the Artifact.
(Inherited from Artifact.) | ||||||||||
| AutoBatch |
Indicates whether the batch set automatically generates batches.
| ||||||||||
| AutoCreateRateMinutes |
Represents how frequently (in minutes) the system will attempt to create batches.
| ||||||||||
| BatchDataSource |
Represents a saved search containing documents to batch.
| ||||||||||
| BatchPrefix |
Represents a batch prefix for this batch set.
The name of a batch contains this prefix followed by the batch numbering.
| ||||||||||
| BatchUnitField |
Represents an optional field used for grouping similar documents in the same batch.
| ||||||||||
| DocumentsToBeBatched |
Represents the remaining documents submitted for batching, which do not meet the minimum batch size.
| ||||||||||
| FamilyField |
Represents the workspace group identifier.
| ||||||||||
| Fields |
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.) | ||||||||||
| Guids |
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.) | ||||||||||
| Item[Guid] |
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.) | ||||||||||
| Item[Int32] |
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.) | ||||||||||
| Item[String] |
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.) | ||||||||||
| LastErrorReported |
Indicates the last error reported for a batch set. This field is read-only.
| ||||||||||
| LastSuccessfulRun |
Indicates the last successful run for a batch set. This field is read-only.
| ||||||||||
| MaximumBatchSize |
Determines the maximum number of documents in a single batch.
| ||||||||||
| MinimumBatchSize |
Determines the smallest number of documents in a single batch.
| ||||||||||
| Name |
Represents the name of a batch set as a string.
| ||||||||||
| ParentArtifact |
Indicates the parent of an Artifact.
(Inherited from Artifact.) | ||||||||||
| PreconvertDocuments |
Indicates whether a batch set should have its documents converted upon batching.
| ||||||||||
| ReviewedField |
Indicates the Yes/No, Single-Choice, or Multi-Choice field that
Relativity monitors during a review.
A count is incremented for each document in a batch coded with a value for the specified field.
| ||||||||||
| Status |
Represents the status of a batch set.
| ||||||||||
| SystemCreatedBy |
Identifies the User who created the Artifact. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) | ||||||||||
| SystemCreatedOn |
Represents the DateTime in UTC when the Artifact was created. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) | ||||||||||
| SystemLastModifiedBy |
Identifies the User who last modified the Artifact. This property is available in the Fields property of the Artifact.
(Inherited from Artifact.) | ||||||||||
| SystemLastModifiedOn |
Represents the DateTime in UTC when the Artifact was last modified. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) | ||||||||||
| TextIdentifier |
Indicates the value of the IdentifierFieldName field available in Fields property of the Artifact.
This field may also be available as a Name property for many Artifacts.
(Inherited from Artifact.) |
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Returns a string that represents the current Artifact.
(Inherited from Artifact.) |
Remarks
See Also