IFileSystemService Interface

Provides methods for accessing the application file system.

Namespace:  Dundas.BI.FileSystem
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax
public interface IFileSystemService

The IFileSystemService type exposes the following members.

Methods
  NameDescription
Public methodAddToMostRecentlyUsed
Adds the specified entry to the most-recently-used list for the caller's account.
Public methodCallerHasPrivilege
Check if the caller has the object privilege specified by objectPrivilegeId.
Public methodCheckIn(ICollectionGuid, String)
Checks in entities with the specified IDs.
Public methodCheckIn(Guid, String)
Checks in the entity or folder with the specified ID.
Public methodCheckOut(ICollectionGuid)
Checks out entities and/or folders with the specified IDs.
Public methodCheckOut(Guid)
Checks out the entity or folder with the specified ID.
Public methodClearMostRecentlyUsed(NullableGuid) Obsolete.
Clears the most recently used list for the specified account.
Public methodClearMostRecentlyUsed(NullableGuid, NullableGuid)
Clears the most recently used list for the specified account.
Public methodCopyEntry(EntryCopyOptions)
Creates a copy of a file system entry.
Public methodCopyEntry(Guid, Guid, String, EntryCreationOptions)
Creates a copy of the entry with the specified ID.
Public methodCopyEntry(Guid, Guid, String, EntryCreationOptions, IDictionaryGuid, Guid)
Creates a copy of the entry with the specified ID.
Public methodCreateFolder
Creates a folder in the application's file system.
Public methodDelete(ICollectionGuid, DeleteOptions)
Deletes entries with the specified IDs.
Public methodDelete(Guid, DeleteOptions)
Deletes the entry with the specified ID.
Public methodDeleteOldEntityData
Deletes data for entities which are not the current revision and were created before the specified date.
Public methodDemandCallerCanAdministerEntry
Require the caller to have administrative privileges on the specified entry.
Public methodDemandCallerPrivilege
Require the caller to have the privilege specified by objectPrivilegeId.
Public methodEnsureVisible
Ensures that a particular entity is visible to the specified accounts and groups.
Public methodEntryExists(Guid)
Determines whether an entry with the specified ID exists.
Public methodEntryExists(Guid, Boolean)
Determines whether an entry with the specified ID exists.
Public methodEntryExists(String, Guid)
Determines whether an entry with the specified name exists in the specified folder.
Public methodFileSystemQuery(Int32, Int32, ICollectionGuid, FileSystemQueryOptions, IListTupleFileSystemQueryField, SortDirection, ICollectionFileSystemQueryFilterRule)
Queries file system entries corresponding to the specified criteria.
Public methodFileSystemQuery(Int32, Int32, Guid, FileSystemQueryOptions, IListTupleFileSystemQueryField, SortDirection, ICollectionFileSystemQueryFilterRule)
Queries file system entries corresponding to the specified criteria.
Public methodFileSystemQuery(Int32, Int32, ICollectionGuid, FileSystemQueryOptions, IListTupleFileSystemQueryField, SortDirection, ICollectionFileSystemQueryFilterRule, Guid, Guid)
Queries file system entries corresponding to the specified criteria.
Public methodGetCheckedOutReferences(ICollectionGuid)
Gets items which are currently checked-out to the caller and referenced by at least one of the specified items.
Public methodGetCheckedOutReferences(Guid)
Gets referenced items which are currently checked-out to the caller.
Public methodGetDownstreamReferenceExplosion(Guid)
Recursively gets the IDs of all entries which reference the specified entity.
Public methodGetDownstreamReferenceExplosion(Guid, ICollectionObjectType)
Recursively gets the IDs of all entries which reference the specified entity.
Public methodGetEffectiveCallerPrivileges
Gets the effective granted caller privileges for an entry.
Public methodGetEntries
Gets file system entries in bulk.
Public methodGetEntry(Guid)
Gets a FileSystemEntry specified by its ID.
Public methodGetEntry(Guid, GetEntryOptions)
Gets a FileSystemEntry specified by its ID.
Public methodGetEntry(String, Guid)
Gets a FileSystemEntry specified by its name and parent folder.
Public methodGetEntry(String, Guid, GetEntryOptions)
Gets a FileSystemEntry specified by its name and parent folder.
Public methodGetFile(Guid)
Gets a File specified by its ID.
Public methodGetFile(Guid, GetEntryOptions)
Gets a File specified by its ID.
Public methodGetFile(String, Guid)
Gets a File specified by its name and parent folder.
Public methodGetFile(String, Guid, GetEntryOptions)
Gets a File specified by its name and parent folder.
Public methodGetFolder(Guid)
Gets a Folder specified by its ID.
Public methodGetFolder(Guid, GetEntryOptions)
Gets a Folder specified by its ID.
Public methodGetFolder(String, Guid)
Gets a Folder specified by its name and parent folder.
Public methodGetFolder(String, Guid, GetEntryOptions)
Gets a Folder specified by its name and parent folder.
Public methodGetInheritedTags
Gets the inherited tags of the specified entry.
Public methodGetMostRecentlyUsed
Gets the list of most-recently-used entries for the caller's account.
Public methodGetMostRecentlyUsed(ICollectionObjectType)
Gets the list of most-recently-used entries for the caller's account.
Public methodGetProjectRepresentation(ICollectionGuid)
Gets the specified entries organized with their ancestors in Project objects.
Public methodGetProjectRepresentation(ICollectionGuid, Boolean)
Gets the specified entries organized with their ancestors in Project objects.
Public methodGetRecycleBinFolderId(NullableGuid) Obsolete.
Gets the recycle bin folder identifier for the given account.
Public methodGetRecycleBinFolderId(NullableGuid, NullableGuid, Boolean)
Gets the recycle bin folder identifier for the given account.
Public methodGetReferencedBy
Gets the IDs of all entities which are referenced by the caller's effective revision of the specified entity.
Public methodGetReferencesTo
Gets the IDs of all entities which reference the specified entity (according to the caller).
Public methodGetTagUsage
Gets the explicit tags used by existing file system entries.
Public methodGetUnreferencedEntities
Gets the IDs of any entities in the specified project which are not referenced.
Public methodGetUpstreamReferenceExplosion(Guid)
Recursively gets the IDs of all entries which are referenced by the specified entity.
Public methodGetUpstreamReferenceExplosion(Guid, ICollectionObjectType)
Recursively gets the IDs of all entries which are referenced by the specified entity.
Public methodMoveEntry
Moves the entry with the specified ID.
Public methodPromoteTransient
Promotes a transient entry to a real one.
Public methodRenameEntry
Renames the entry with the specified ID.
Public methodRestore(ICollectionGuid)
Restores recycled entries with the specified IDs.
Public methodRestore(Guid)
Restores the recycled entry with the specified ID.
Public methodRevisionExists
Determines whether a revision of an entry with the specified ID and revision number exists.
Public methodRevisionQuery
Queries file system revision history corresponding to the specified criteria.
Public methodRollback
Rollback the entity with the specified ID to a previous revision.
Public methodSetDescription
Sets the description property of an entry.
Public methodSetPrivileges(Guid, ICollectionPrivilegeAssignment, PrivilegeInheritanceBehavior)
Set an entry's access privileges.
Public methodSetPrivileges(Guid, ICollectionPrivilegeAssignment, PrivilegeInheritanceBehavior, PrivilegePropagationBehavior)
Set an entry's access privileges.
Public methodSetTags
Sets the explicit tags of an entry.
Public methodTouchEntry(ICollectionGuid)
Updates the last modified time of the entries with the specified IDs.
Public methodTouchEntry(Guid)
Updates the last modified time of the entry with the specified ID.
Public methodTransferCheckOut
Change the account to which an entity is checked-out.
Public methodUndoCheckOut(ICollectionGuid)
Discards the changes to the checked-out entities and/or folders with the specified IDs, and cancels the check-out(s).
Public methodUndoCheckOut(Guid)
Discards the changes to the checked-out entity or folder with the specified ID, and cancels the check-out(s).
Top
See Also