Interface IDBAccess

Unit

DBInterfaces

Declaration

type IDBAccess = interface(IInterface)

Description

Attributes

GUID['{E9B55F6D-0CCB-418B-BD15-068D2D1AE7B2}']

Hierarchy

• IInterface
• IDBAccess

Overview

Methods

	function CreateBackend: IDBBackend;
	function GetBackend: IDBBackend;
	function ProcessRequest(const iMethod, iURL: string; iParameters: IStrings = nil; iUploadDocument: IPersistentStorage = nil; iProgressIndicator: IProgressIndicator = nil): IPersistentStorage;
	function ProcessRequestForStation(const iMethod, iURL, iStation: string; iParameters: IStrings = nil; iUploadDocument: IPersistentStorage = nil; iProgressIndicator: IProgressIndicator = nil): IPersistentStorage;
	function GetDatabaseCaption: string;
	function GetDatabaseID: string;
	function GetDatabaseUniqueID: string;
	function GetDefaultStation: string;
	function GetInboxFolder: string;
	function GetStations: TDBStationInfoArray;
	function GetStorages: TDBStorageInfoArray;
	function GetStandardAttributes: IStandardAttributeList;
	function GetPlaylistStandardAttributes: IStandardAttributeList;
	function GetSubPlaylists: TDBSubPlaylistInfoArray;
	function GetPermissions: IDBPermissions;
	function GetOptions: TDBOptions;
	function GetFirstDayOfWeek: integer;
	function AdjustSingleFilenameForward(const iFilename: string): string;
	function AdjustSingleFilenameBackward(const iFilename: string): string;
	procedure TranslateFilenamesForward(const iItem: IPlaylistItem);
	procedure TranslateFilenamesBackwards(const iItem: IPlaylistItem);
	function DeserializePlaylistItem(iObject: IPersistentObject): IPlaylistItem;
	function GetStorageLocation(const iID: string): string;
	function ReverseLookup(const iFilename: string): IPlaylistItem;
	function GetAllConfigValues: IConfigValues;
	function GetConfigValue(const iName: string; const iDefault: string): string;
	procedure SetConfigValue(const iName: string; const iValue: string);
	function GetAllStationConfigValues(iStation: string): IConfigValues;
	function GetStationConfigValue(iStation: string; iName: string; iDefault: string): string;
	procedure SetStationConfigValue(iStation: string; iName: string; iValue: string);
	function GetPlaylistItemDataMulti(iIDs: IStrings; iWithIcons: boolean; iPI: IProgressIndicator = nil): IPersistentArray;
	function GetPlaylistItemDataAll(iWithIcons: boolean; iPI: IProgressIndicator = nil): IPersistentArray;
	function CreatePlaylistItem(const iID: string; iExternal: boolean): IPlaylistItem;
	function CreatePlaylistItemMulti(iIDs: IStrings; iWithIcons: boolean; iPI: IProgressIndicator = nil): IPlaylist;
	function CreatePlaylistItemAll(iWithIcons: boolean; iPI: IProgressIndicator = nil): IPlaylist;
	function AddPlaylistItem(iItem: IPlaylistItem; const iFolder: string = ''): string;
	procedure UpdatePlaylistItem(iItem: IPlaylistItem);
	procedure UpdatePlaylistItems(iItems: IPlaylist; iPI: IProgressIndicator = nil);
	function DeletePlaylistItem(const iID: string): string;
	function GetPlaylist(iSlot: TDateTime; const iStation: string; iSubPlaylist: integer; var oVersionInfo: IPlaylistVersionInfo): IPlaylist;
	function GetPlaylistVersionInfo(const iStation: string; iSlot: TDateTime; iSubPlaylist: integer): IPlaylistVersionInfo;
	procedure SavePlaylistEx(const iStation: string; iSlot: TDateTime; iSubPlaylist: integer; iData: IPlaylist; iVersionInfo: IPlaylistVersionInfo; iForce: boolean);
	procedure SavePlaylist(const iStation: string; iSlot: TDateTime; iSubPlaylist: integer; iData: IPlaylist);
	function GetPlaylistAttributes(const iStation: string; iSlot: TDateTime): IStrings;
	procedure SavePlaylistAttributes(const iStation: string; iSlot: TDateTime; iAttributes: IStrings);
	function GetFolders(const iParent: string = ''): IPersistentArray;
	function CreateFolder(const iName: string; const iParent: string): string;
	function GetFolderContent(const iID: string): IPlaylist;
	procedure AddItemToFolder(const iItem: string; const iFolder: string);
	procedure MoveItemToFolder(const iItem: string; const iFolder: string);
	procedure DeleteAllItemsFromFolder(const iFolder: string);
	function GeneratePlaylist(iStation: string; iTemplateID: string; iMusicTemplateID: string; iTransitionTemplateID: string; iTargetDuration: TTimeValue): IPlaylist;
	function ImportFile(const iLocalFilename: string; iItem: IFilePlaylistItem; const iStation: string; const iFolder: string; const iReplaceID: string; iImportSettings: IDBImportSettings = nil; iProgressIndicator: IProgressIndicator = nil): IFilePlaylistItem;
	function UploadFile(iLocalFilename: string; iItem: IFilePlaylistItem; iStorage: string; iFilename: string; iFolder: string; iReplaceID: string; iOverwritePolicy: TDBOverwritePolicy; iProgressIndicator: IProgressIndicator): IFilePlaylistItem;
	function UploadFileFromStream(iStream: TStream; iLength: int64; iItem: IFilePlaylistItem; iStorage: string; iFilename: string; iFolder: string; iReplaceID: string; iOverwritePolicy: TDBOverwritePolicy; iProgressIndicator: IProgressIndicator): IFilePlaylistItem;
	procedure DeleteFile(const iFilename: string);
	function GetFileDate(const iFilename: string; out oDate: TDateTime): boolean;
	procedure ScanStorage(const iStorage: string; out oNewFiles, oMissingFiles: TDBSyncItemArray; iPI: IProgressIndicator = nil);
	procedure AddStorageItems(const iStorage: string; var iItems: TDBSyncItemArray; const iSettings: TDBSyncSettings; iPI: IProgressIndicator = nil);
	procedure AutoSyncStorage(const iStorage: string; const iSettings: TDBSyncSettings; const iAdd: boolean = true; const iDelete: boolean = true);
	function LookupByID(const iID: string): IPlaylistItem;
	function LookupByInternalID(const iID: string): IPlaylistItem;
	function LookupByExternalID(const iID: string): IPlaylistItem;
	function LookupByFilename(const iFilename: string): IPlaylistItem;

Description

Methods

	function CreateBackend: IDBBackend;

	function GetBackend: IDBBackend;

	function ProcessRequest(const iMethod, iURL: string; iParameters: IStrings = nil; iUploadDocument: IPersistentStorage = nil; iProgressIndicator: IProgressIndicator = nil): IPersistentStorage;

	function ProcessRequestForStation(const iMethod, iURL, iStation: string; iParameters: IStrings = nil; iUploadDocument: IPersistentStorage = nil; iProgressIndicator: IProgressIndicator = nil): IPersistentStorage;

	function GetDatabaseCaption: string;

	function GetDatabaseID: string;

	function GetDatabaseUniqueID: string;

	function GetDefaultStation: string;

	function GetInboxFolder: string;

	function GetStations: TDBStationInfoArray;

	function GetStorages: TDBStorageInfoArray;

	function GetStandardAttributes: IStandardAttributeList;

	function GetPlaylistStandardAttributes: IStandardAttributeList;

	function GetSubPlaylists: TDBSubPlaylistInfoArray;

	function GetPermissions: IDBPermissions;

	function GetOptions: TDBOptions;

	function GetFirstDayOfWeek: integer;

	function AdjustSingleFilenameForward(const iFilename: string): string;

	function AdjustSingleFilenameBackward(const iFilename: string): string;

	procedure TranslateFilenamesForward(const iItem: IPlaylistItem);

	procedure TranslateFilenamesBackwards(const iItem: IPlaylistItem);

	function DeserializePlaylistItem(iObject: IPersistentObject): IPlaylistItem;

	function GetStorageLocation(const iID: string): string;

	function ReverseLookup(const iFilename: string): IPlaylistItem;

	function GetAllConfigValues: IConfigValues;

	function GetConfigValue(const iName: string; const iDefault: string): string;

	procedure SetConfigValue(const iName: string; const iValue: string);

	function GetAllStationConfigValues(iStation: string): IConfigValues;

	function GetStationConfigValue(iStation: string; iName: string; iDefault: string): string;

	procedure SetStationConfigValue(iStation: string; iName: string; iValue: string);

	function GetPlaylistItemDataMulti(iIDs: IStrings; iWithIcons: boolean; iPI: IProgressIndicator = nil): IPersistentArray;

	function GetPlaylistItemDataAll(iWithIcons: boolean; iPI: IProgressIndicator = nil): IPersistentArray;

	function CreatePlaylistItem(const iID: string; iExternal: boolean): IPlaylistItem;

	function CreatePlaylistItemMulti(iIDs: IStrings; iWithIcons: boolean; iPI: IProgressIndicator = nil): IPlaylist;

	function CreatePlaylistItemAll(iWithIcons: boolean; iPI: IProgressIndicator = nil): IPlaylist;

	function AddPlaylistItem(iItem: IPlaylistItem; const iFolder: string = ''): string;

	procedure UpdatePlaylistItem(iItem: IPlaylistItem);

	procedure UpdatePlaylistItems(iItems: IPlaylist; iPI: IProgressIndicator = nil);

	function DeletePlaylistItem(const iID: string): string;

	function GetPlaylist(iSlot: TDateTime; const iStation: string; iSubPlaylist: integer; var oVersionInfo: IPlaylistVersionInfo): IPlaylist;

	function GetPlaylistVersionInfo(const iStation: string; iSlot: TDateTime; iSubPlaylist: integer): IPlaylistVersionInfo;

	procedure SavePlaylistEx(const iStation: string; iSlot: TDateTime; iSubPlaylist: integer; iData: IPlaylist; iVersionInfo: IPlaylistVersionInfo; iForce: boolean);

	procedure SavePlaylist(const iStation: string; iSlot: TDateTime; iSubPlaylist: integer; iData: IPlaylist);

	function GetPlaylistAttributes(const iStation: string; iSlot: TDateTime): IStrings;

	procedure SavePlaylistAttributes(const iStation: string; iSlot: TDateTime; iAttributes: IStrings);

	function GetFolders(const iParent: string = ''): IPersistentArray;

	function CreateFolder(const iName: string; const iParent: string): string;

	function GetFolderContent(const iID: string): IPlaylist;

	procedure AddItemToFolder(const iItem: string; const iFolder: string);

	procedure MoveItemToFolder(const iItem: string; const iFolder: string);

	procedure DeleteAllItemsFromFolder(const iFolder: string);

	function GeneratePlaylist(iStation: string; iTemplateID: string; iMusicTemplateID: string; iTransitionTemplateID: string; iTargetDuration: TTimeValue): IPlaylist;

	function ImportFile(const iLocalFilename: string; iItem: IFilePlaylistItem; const iStation: string; const iFolder: string; const iReplaceID: string; iImportSettings: IDBImportSettings = nil; iProgressIndicator: IProgressIndicator = nil): IFilePlaylistItem;

	function UploadFile(iLocalFilename: string; iItem: IFilePlaylistItem; iStorage: string; iFilename: string; iFolder: string; iReplaceID: string; iOverwritePolicy: TDBOverwritePolicy; iProgressIndicator: IProgressIndicator): IFilePlaylistItem;

	function UploadFileFromStream(iStream: TStream; iLength: int64; iItem: IFilePlaylistItem; iStorage: string; iFilename: string; iFolder: string; iReplaceID: string; iOverwritePolicy: TDBOverwritePolicy; iProgressIndicator: IProgressIndicator): IFilePlaylistItem;

	procedure DeleteFile(const iFilename: string);

	function GetFileDate(const iFilename: string; out oDate: TDateTime): boolean;

	procedure ScanStorage(const iStorage: string; out oNewFiles, oMissingFiles: TDBSyncItemArray; iPI: IProgressIndicator = nil);

	procedure AddStorageItems(const iStorage: string; var iItems: TDBSyncItemArray; const iSettings: TDBSyncSettings; iPI: IProgressIndicator = nil);

	procedure AutoSyncStorage(const iStorage: string; const iSettings: TDBSyncSettings; const iAdd: boolean = true; const iDelete: boolean = true);

	function LookupByID(const iID: string): IPlaylistItem;
from IItemLookup

	function LookupByInternalID(const iID: string): IPlaylistItem;

	function LookupByExternalID(const iID: string): IPlaylistItem;

	function LookupByFilename(const iFilename: string): IPlaylistItem;

---

Generated by PasDoc 0.16.0.