IFileSystemServiceDeleteOldEntityData Method |
Deletes data for entities which are not the current revision and were created before the specified date.
Namespace:
Dundas.BI.FileSystem
Assembly:
Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (9.0.0.1000)
SyntaxICollection<IdRevisionPair> DeleteOldEntityData(
Nullable<DateTime> beforeDate,
ICollection<Guid> specificEntityIds,
ICollection<Nullable<Guid>> specificTenantIds
)
Function DeleteOldEntityData (
beforeDate As Nullable(Of DateTime),
specificEntityIds As ICollection(Of Guid),
specificTenantIds As ICollection(Of Nullable(Of Guid))
) As ICollection(Of IdRevisionPair)
ICollection<IdRevisionPair>^ DeleteOldEntityData(
Nullable<DateTime> beforeDate,
ICollection<Guid>^ specificEntityIds,
ICollection<Nullable<Guid>>^ specificTenantIds
)
abstract DeleteOldEntityData :
beforeDate : Nullable<DateTime> *
specificEntityIds : ICollection<Guid> *
specificTenantIds : ICollection<Nullable<Guid>> -> ICollection<IdRevisionPair>
Parameters
- beforeDate
- Type: SystemNullableDateTime
The threshold date, or if no date restriction should be used. - specificEntityIds
- Type: System.Collections.GenericICollectionGuid
A list of specific entity IDs to be processed. If , all entities will be processed. - specificTenantIds
- Type: System.Collections.GenericICollectionNullableGuid
A list of tenant IDs; only entities corresponding to the specified tenants will be processed. If all tenants will be processed.
Return Value
Type:
ICollectionIdRevisionPairA list of ID/revision pairs representing the revisions which were deleted.
Exceptions| Exception | Condition |
|---|
| ArgumentException | beforeDate does not have a specified DateTimeKind. |
| NoPrivilegeException | The caller does not have system administration privileges. |
| InvalidSessionException | The caller context is not associated with a valid session. |
Remarks
If an entity is inactive, and meets all other criteria, the entire entity will be deleted, rather than just individual revisions.
This is indicated in the result by a value of -1 in the revision property.
A revision of an entity will be selected for deletion by this method if all of the following are true:
1) The revision is not the current (latest) revision of the entity;
2) The revision does not represent the "checked out" version of the entity;
3) The revision was created before the specified date.
See Also