Relativity.ObjectManager 9.5.169.7

API Differences between 9.5.169.7 and 9.5.41.87

316 Additions 28 Removals

Relativity.Kepler.Services

public class KeplerServiceDependencyAttribute : Attribute
- public KeplerServiceDependencyAttribute()

Relativity.Services

public interface ISortAssociable
- int ArtifactTypeID { get; set; }
- List<Sort> Sorts { get; set; }
public class Query
- public int? ExecutingSavedSearchId { get; set; }
- public string RankSortOrder { get; set; }
public class MoveProcessStateProgress
- public int OperationsCompleted { get; set; }
- public int TotalOperations { get; set; }
- public MoveProcessStateProgress()
- public MoveProcessStateProgress(int totalOperations, int operationsCompleted)

Relativity.Services.Analytics

public class AnalyticsIndex : SearchIndexRef
public class AnalyticsIndexJobParameters
public enum AnalyticsIndexJobType
public class AnalyticsProfileRef
public interface IAnalyticsModule
public interface IIndexManager : IDisposable

Relativity.Services.Batching

public class AutoBatchProgress
- public enum ProgressStatus
- public int? DocumentsToBeBatched { get; set; }
- public string LastReportedError { get; set; }
- public DateTime? LastSuccessfulRun { get; set; }
- public ProgressStatus? Status { get; set; }
- public AutoBatchProgress()
public class AutoBatchSettings
- public int AutoCreateRateInMinutes { get; set; }
- public int MinimumBatchSize { get; set; }
- public AutoBatchSettings()
public class BatchSet : BatchSetRef
- public AutoBatchSettings AutoBatchSettings { get; set; }
- public string BatchPrefix { get; set; }
- public int BatchSize { get; set; }
- public SecurableField BatchUnitField { get; set; }
- public DataSource DataSource { get; set; }
- public SecurableField FamilyField { get; set; }
- public string Keywords { get; set; }
- public string Notes { get; set; }
- public bool PreconvertDocuments { get; set; }
- public SecurableField ReviewedField { get; set; }
- public BatchSet()
public class BatchSetRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public BatchSetRef()
public class DataSource
- public int ArtifactID { get; set; }
- public bool IsSecured { get; set; }
- public string Name { get; set; }
- public DataSource()
public class FullBatchSetAndStatus
- public AutoBatchProgress AutoBatchStatus { get; set; }
- public BatchSet BatchSet { get; set; }
- public FullBatchSetAndStatus()
public class SecurableField : FieldRef
- public bool IsSecured { get; set; }
- public SecurableField()

Relativity.Services.DashboardObject

public class Dashboard
- public int ArtifactID { get; set; }
- public int AssociatedObjectType { get; set; }
- public string DashboardData { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
- public int? Order { get; set; }
- public int[] RelativityApplications { get; set; }
- public Dashboard()

Relativity.Services.DataContracts.DTOs.ItemListView

public class DashboardDataForDropdown
- public List<string> AssociatedLockedApplications { get; set; }

Relativity.Services.Document

public class File : FileRef
- public int FileID { get; set; }
- public string Filename { get; set; }

Relativity.Services.DocumentPrintData

public interface IDocumentPrintDataManager : IDisposable
- Task<string> GetDocumentPrintDataAsync(string printOptions, int workspaceId)
public interface IDocumentPrintDataModule

Relativity.Services.Exceptions

public class InvalidInputException : ValidationException
- public ValidationError[] Errors { get; set; }
- public InvalidInputException()
- public InvalidInputException(string message)
- public InvalidInputException(string message, Exception innerException)
- protected InvalidInputException(SerializationInfo info, StreamingContext context)
public class ValidationError
- public string ErrorMessage { get; set; }
- public string PropertyName { get; set; }
- public ValidationError()

Relativity.Services.Field

public enum FieldUpdateBehavior
- Unknown = 0
public interface IViewFieldAssociable
- int ArtifactTypeID { get; set; }
- List<FieldRef> Fields { get; set; }
public class MultipleObjectFieldUpdateValue
- public IEnumerable<RelativityObjectRef> Objects { get; set; }
- public IEnumerable<RelativityObjectRef> Objects { get; set; }
public class SecurityFieldRef : FieldRef
- public const string SECURITY_FIELD_NAME = "Security"
- public string Name { get; }
- public SecurityFieldRef()
public class SecurityFieldValue
- public bool OverwriteInheritedSecurity { get; set; }
- public bool UserCanEditSecurity { get; set; }
- public SecurityFieldValue()

Relativity.Services.Files

public class FileRef
- public int FileID { get; set; }
- public string Filename { get; set; }
- public FileRef()

Relativity.Services.Folder

public class FolderMoveResultSet : MassProcessResultSetBase
- public FolderMoveResultSet()
public interface IFolderManager : IDisposable
- Task<FolderMoveResultSet> MoveFolderAsync(int workspaceArtifactID, int artifactID, int destinationFolderID)
- Task<FolderMoveResultSet> MoveFolderAsync(int workspaceArtifactID, int artifactID, int destinationFolderID, CancellationToken cancel)
- Task<FolderMoveResultSet> MoveFolderAsync(int workspaceArtifactID, int artifactID, int destinationFolderID, IProgress<MoveProcessStateProgress> progress)
- Task<FolderMoveResultSet> MoveFolderAsync(int workspaceArtifactID, int artifactID, int destinationFolderID, CancellationToken cancel, IProgress<MoveProcessStateProgress> progress)

Relativity.Services.ItemListView

public class ItemListFieldRef : FieldRef
- public bool IsVisible { get; set; }
- public List<Guid> SourceFieldArtifactGuids { get; set; }
public class PermissionResultSet
- public bool CanManageRelativityApplications { get; set; }
- public PermissionSetForObjectType RelativityApplication { get; set; }

Relativity.Services.ObjectQuery

public class Query
- public string RankSortOrder { get; set; }
public class SearchProviderCondition
- public string SortOrder { get; set; }

Relativity.Services.ObjectTypeReference

public class ObjectTypeRef
- public int ArtifactID { get; set; }
- public int DescriptorArtifactTypeID { get; set; }
- public Guid[] Guids { get; set; }
- public string Name { get; set; }
- public ObjectTypeRef()
- public ObjectTypeRef(int descriptorArtifactTypeID)
- public ObjectTypeRef(Guid[] guids)
- public ObjectTypeRef(string name)

Relativity.Services.Objects

public interface IObjectManager : IDisposable
- Task<ObjectQueryResultSet> QueryAsync(int workspaceID, int artifactTypeID, Query query, int start, int length)
- Task<ObjectReadResult> ReadSingleAsync(int workspaceID, int objectID)
- Task<ObjectReadResult> ReadSingleAsync(int workspaceID, Guid objectGuid)
- Task<ObjectReadResult> ReadSingleAsync(int workspaceID, int objectID, IEnumerable<FieldRef> fieldRefs)
- Task<ObjectReadResult> ReadSingleAsync(int workspaceID, Guid objectGuid, IEnumerable<FieldRef> fieldRefs)
- Task<ObjectUpdateResult> UpdateAsync(int workspaceID, int objectID, RelativityObject relativityObject)
public interface IObjectModule

Relativity.Services.Objects.Exceptions

public class EventHandlerFailedException : ServiceException
- public EventHandlerFailedException(string message)
- public EventHandlerFailedException(string message, Exception innerException)

Relativity.Services.Objects.Models

public class RelativityObject : RelativityObjectRef
- public IEnumerable<FieldValuePair> FieldValuePairs { get; set; }
- public int? ParentArtifactID { get; set; }
- public RelativityObject()
public class RelativityObjectRef
- public int ArtifactID { get; set; }
- public string DisplayText { get; set; }
- public IEnumerable<Guid> Guids { get; set; }
- public RelativityObjectRef()
public class EventHandlerStatus
- public string Message { get; set; }
- public bool Success { get; set; }
- public EventHandlerStatus()
public class ObjectQueryResultSet : QueryResultSet<RelativityObject>
- public int CurrentStartIndex { get; set; }
- public IEnumerable<int> IDWindow { get; set; }
- public FieldRef Includes { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public double?[] RankWindow { get; set; }
- public int ResultCount { get; set; }
- public SampleDetails Sample { get; set; }
- public ObjectQueryResultSet()
public class ObjectReadResult
- public string Message { get; set; }
- public RelativityObject RelativityObject { get; set; }
- public ObjectReadResult()
public class ObjectUpdateResult
- public IEnumerable<EventHandlerStatus> EventHandlerStatuses { get; set; }
- public ObjectUpdateResult()
public class Query : Query
- public int? ActiveArtifactID { get; set; }
- public bool? ConvertNumberFieldValuesToString { get; set; }
- public int? ExecutingSavedSearchID { get; set; }
- public int? ExecutingViewID { get; set; }
- public IEnumerable<FieldRef> Fields { get; set; }
- public bool? IncludeDisplayText { get; set; }
- public bool? IsAdhocQuery { get; set; }
- public bool? TruncateTextFields { get; set; }
- public Query()

Relativity.Services.Objects.Serialization

public class FieldRefSerializer : IModelSerializer<FieldRef>, IModelSerializer
- public FieldRefSerializer()
- public FieldRef TransformForDeserialize(object data)
- public object TransformForSerialize(FieldRef model)
public class FieldValuePairSerializer : IModelSerializer<FieldValuePair>, IModelSerializer
- public FieldValuePairSerializer()
- public FieldValuePair TransformForDeserialize(object data)
- public object TransformForSerialize(FieldValuePair model)

Relativity.Services.PivotProfile

public class ObjectTypeRef : ObjectTypeRef
- public int ArtifactID { get; set; }
- public int DescriptorArtifactTypeID { get; set; }
- public Guid[] Guids { get; set; }
- public string Name { get; set; }

Relativity.Services.Proxy.Routing

public class RouteBuilder
- public RouteInfo GetRouteInfoBase(Type serviceModuleIntType, Type serviceIntType, MethodInfo targetIntMethod)

Relativity.Services.RelativityApplication

public interface IRelativityApplicationAssociable
- List<RelativityApplicationRef> RelativityApplications { get; set; }

Relativity.Services.RelativityObject

public class Query : Query
public class RelativityObject : RelativityObjectRef
public class RelativityObjectRef
public class ObjectQueryResultSet : QueryResultSet<RelativityObject>

Relativity.Services.Result

public class MassProcessResultSetBase
- public virtual int OperationsCompleted { get; set; }
- public virtual string ProcessState { get; set; }
- public virtual int TotalOperations { get; set; }
- public MassProcessResultSetBase()

Relativity.Services.Review

public interface IBatchingManager : IDisposable
- Task<BatchSet> CreateBatchSetAsync(int workspaceId, BatchSet batchSet)
- Task<AutoBatchProgress> GetAutoBatchStatusAsync(int workspaceId, int batchSetArtifactID)
- Task<FullBatchSetAndStatus> ReadFullAsync(int workspaceId, int batchSetArtifactID)
- Task<BatchSet> ReadSimpleAsync(int workspaceId, int batchSetArtifactID)
- Task<BatchSet> UpdateBatchSetAsync(int workspaceId, BatchSet batchSet)
public interface IReviewModule

Relativity.Services.Search

public class Criteria : CriteriaBase
- public bool? HasPermission { get; set; }
public interface ISavedSearch : IRelativityApplicationAssociable
- CriteriaCollection SearchCriteria { get; set; }
public interface ISearchCriteriaAssociable
- int ArtifactTypeID { get; set; }
- CriteriaCollection SearchCriteria { get; set; }
public class SearchProviderCondition
- public string SortOrder { get; set; }
public interface IAnalyticsSearchManager : IDisposable
- Task<SavedSearchRef> CopySingleAsync(int workspaceArtifactID, int searchArtifactID)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, IProgress<MoveProcessStateProgress> progress)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel, IProgress<MoveProcessStateProgress> progress)
public interface IDataGridSearchManager : IDisposable
- Task<SavedSearchRef> CopySingleAsync(int workspaceArtifactID, int searchArtifactID)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, IProgress<MoveProcessStateProgress> progress)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel, IProgress<MoveProcessStateProgress> progress)
public interface IdtSearchManager : IDisposable
- Task<SavedSearchRef> CopySingleAsync(int workspaceArtifactID, int searchArtifactID)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, IProgress<MoveProcessStateProgress> progress)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel, IProgress<MoveProcessStateProgress> progress)
public interface IKeywordSearchManager : IDisposable
- Task<SavedSearchRef> CopySingleAsync(int workspaceArtifactID, int searchArtifactID)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, IProgress<MoveProcessStateProgress> progress)
- Task<SavedSearchMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel, IProgress<MoveProcessStateProgress> progress)
public interface ISearchContainerManager : IDisposable
- Task<SearchContainerMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID)
- Task<SearchContainerMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel)
- Task<SearchContainerMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, IProgress<MoveProcessStateProgress> progress)
- Task<SearchContainerMoveResultSet> MoveAsync(int workspaceArtifactID, int artifactID, int destinationContainerID, CancellationToken cancel, IProgress<MoveProcessStateProgress> progress)
public class SavedSearchMoveResultSet : MassProcessResultSetBase
- public SavedSearchMoveResultSet()
public class SearchAccessStatus
- public bool CanViewCriteriaFields { get; set; }
public class SearchContainerMoveResultSet : MassProcessResultSetBase
- public SearchContainerMoveResultSet()

Relativity.Services.Serialization

public class ChoiceRefHelper : IChoiceRefHelper
- public ChoiceRefHelper()
- public ChoiceRef DeserializeChoiceRef(object choiceObject)
- public IEnumerable<ChoiceRef> DeserializeChoiceRefEnumerable(object choiceListObjects)
- public MultipleChoiceFieldUpdateValue DeserializeMulitChoiceFieldUpdateValue(object value)
public class DateHelper : IDateHelper
- public DateHelper()
public class FileRefHelper : IFileRefHelper
- public FileRefHelper()
- public FileRef DeserializeFileRef(object value)
public interface IChoiceRefHelper
- ChoiceRef DeserializeChoiceRef(object choiceObject)
- IEnumerable<ChoiceRef> DeserializeChoiceRefEnumerable(object choiceListObjects)
- MultipleChoiceFieldUpdateValue DeserializeMulitChoiceFieldUpdateValue(object value)
public interface IDateHelper
- DateTime DeserializeDate(object dateObject)
- bool IsValidDate(object dateObject)
public interface IFileRefHelper
- FileRef DeserializeFileRef(object value)
public interface IRelativityObjectRefHelper
- MultipleObjectFieldUpdateValue DeserializeMultiObjectFieldUpdateValue(object value)
- RelativityObjectRef DeserializeRelativityObjectRef(object value)
- IEnumerable<RelativityObjectRef> DeserializeRelativityObjectRefEnumerable(object value)
public interface IUserRefHelper
- UserRef DeserializeUserRef(object value)
public class RelativityObjectRefHelper : IRelativityObjectRefHelper
- public RelativityObjectRefHelper()
- public MultipleObjectFieldUpdateValue DeserializeMultiObjectFieldUpdateValue(object value)
- public RelativityObjectRef DeserializeRelativityObjectRef(object value)
- public IEnumerable<RelativityObjectRef> DeserializeRelativityObjectRefEnumerable(object value)
public class UserRefHelper : IUserRefHelper
- public UserRefHelper()
- public UserRef DeserializeUserRef(object value)

Relativity.Services.StaticObject

public class ProductionQueueItem
- public string CaseName { get; set; }
- public string JobTypeName { get; set; }
- public int Priority { get; set; }
- public string ProductionJobID { get; set; }
- public string ProductionName { get; set; }
- public int RootFolderID { get; set; }
- public int SetArtifactID { get; set; }
- public int SetQueueID { get; set; }
- public string Status { get; set; }
- public string SubmittedBy { get; set; }
- public DateTime SubmittedDate { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public int WorkspaceUpgradeStatus { get; set; }
- public ProductionQueueItem()
public class ProductionQueueQuery
- public string Condition { get; set; }
- public ProductionQueueQuery()
public class PermissionResultSet
- public bool CanChangeQueuePriority { get; set; }
- public PermissionResultSet()
public class ProductionQueueQueryResultSet
- public int CurrentStartIndex { get; set; }
- public IEnumerable<ProductionQueueItem> DataResults { get; set; }
- public int ResultCount { get; set; }
- public int TotalResultCount { get; set; }
- public ProductionQueueQueryResultSet()
public class ProductionSetQueueSubmitter
- public string Name { get; set; }
- public int UserID { get; set; }
- public ProductionSetQueueSubmitter()
public class StartupInfoResultSet
- public PermissionResultSet Permissions { get; set; }
- public object UserPreferences { get; set; }
- public UserSettingsResult UserSettings { get; set; }
- public Dictionary<string, int> ViewFieldWidthCollection { get; set; }
- public StartupInfoResultSet()
public class UserSettingsResult
- public int ItemListPageLength { get; set; }
- public bool ShowFilters { get; set; }
- public UserSettingsResult()

Relativity.Services.View

public class ObjectTypeRef : ObjectTypeRef
- public ObjectTypeRef()
- public ObjectTypeRef(int descriptorArtifactTypeID)
- public ObjectTypeRef(Guid[] guids)
- public ObjectTypeRef(string name)
public class View : ViewRef, IViewFieldAssociable, ISortAssociable, IRelativityApplicationAssociable, ISearchCriteriaAssociable
- public FieldRef Includes { get; set; }
- public string Keywords { get; set; }
- public string Notes { get; set; }
- public int? GroupDefinitionFieldArtifactID { get; set; }
- public bool IsRelationalFieldView { get; set; }
- public bool IsSystemView { get; set; }
- public bool IsVisible { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public bool RequiresManualRun { get; set; }
- public ScopeType Scope { get; set; }
- public SearchContainerRef SearchContainer { get; set; }
- public string SearchText { get; set; }
- public bool SortByRank { get; set; }
public class ViewRef
- public List<Guid> Guids { get; set; }
public interface IViewManager : IDisposable
- Task<int> CreateSingleAsync(int workspaceArtifactID, View viewDTO)
- Task<ViewAccessStatus> GetAccessStatusAsync(int workspaceArtifactID, int artifactID)
- Task<List<ObjectTypeRef>> GetObjectTypesAsync(int workspaceArtifactID)
- Task<List<UserRef>> GetViewOwnersAsync(int workspaceArtifactID)
- Task<View> ReadSingleAsync(int workspaceArtifactID, int viewArtifactID)
- Task UpdateSingleAsync(int workspaceArtifactID, View viewDTO)
public interface IViewModule
public class ViewAccessStatus
- public bool CanView { get; set; }
- public bool CanViewCriteriaFields { get; set; }
- public bool Exists { get; set; }
- public ViewAccessStatus()