Namespace: Consultingwerk.Framework.Server.FilePicker
Class 
FilePickerService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Server.FilePicker.FilePickerService

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.Server.FilePicker.IFilePickerService


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# LOGICAL CanBrowseFiles (character, IConfigurationProvider) Returns if the scope allows browsing files
# CheckCreateFolderRestriction (character) Checks whether the user ir restricted from creating folders in the given scope
# CheckFolderScopeRestriction (character) Checks whether the user ir restricted from accessing the given scope
+ CreateFolder (character, integer, character, character) Creates a folder
# CHARACTER GetDirectoryPath (character, integer, character, IConfigurationProvider) Returns the directory path build from the given scopes root directory and an optional subfolder
+ GetFilePatterns (character, table) Returns a list of File Patterns
+ GetFiles (character, integer, character, character, table) Returns a list of Files
+ GetFolders (character, integer, character, table) Returns a list of Folders
- GetFolders (character, table) Returns a list of Folders
+ GetRootFolders (character, table) Returns a list of Root Folders
# LOGICAL IsRestricted (character, character) Returns if the token is restricted


Method Detail
Top

PROTECTED LOGICAL CanBrowseFiles (character, IConfigurationProvider)
Purpose: Returns if the scope allows browsing files
Notes:

Parameters:
pcFolderScope CHARACTER
The folder scope
poConfigurationProvider Consultingwerk.Framework.IConfigurationProvider
The configuration provider
Returns LOGICAL
true if the scope allows browsing files
Top

PROTECTED CheckCreateFolderRestriction (character)
Purpose: Checks whether the user ir restricted from creating folders in the given scope
Notes: Throws a NotAuthorizedException if the user is restricted.

Parameters:
pcFolderScope CHARACTER
The folder scope
Top

PROTECTED CheckFolderScopeRestriction (character)
Purpose: Checks whether the user ir restricted from accessing the given scope
Notes: Throws a NotAuthorizedException if the user is restricted.

Parameters:
pcFolderScope CHARACTER
The folder scope
Top

PUBLIC CreateFolder (character, integer, character, character)
Purpose: Creates a folder
Notes:

Parameters:
pcFolderScope CHARACTER
The folder scope
piRootIndex INTEGER
The root folders index
pcSubFolder CHARACTER
The optional sub folder
pcFolderName CHARACTER
The name of the new folder
Top

PROTECTED CHARACTER GetDirectoryPath (character, integer, character, IConfigurationProvider)
Purpose: Returns the directory path build from the given scopes root directory and an optional subfolder
Notes:

Parameters:
pcFolderScope CHARACTER
The folder scope
piRootIndex INTEGER
The root folders index
pcSubFolder CHARACTER
The optional sub folder
poConfigurationProvider Consultingwerk.Framework.IConfigurationProvider
The configuration provider
Returns CHARACTER
The constructed directory path
Top

PUBLIC GetFilePatterns (character, table)
Purpose: Returns a list of File Patterns
Notes:

Parameters:
pcFolderScope CHARACTER
The folder scope
ttFilePatterns TEMP-TABLE ttFilePatterns
The list of File Patterns
Top

PUBLIC GetFiles (character, integer, character, character, table)
Purpose: Returns a list of Files
Notes:

Parameters:
pcFolderScope CHARACTER
The folder scope
piRootIndex INTEGER
The root folders index
pcSubFolder CHARACTER
The optional sub folder
pcFilePatterns CHARACTER
The list of indizes of the file patterns to match
ttFiles TEMP-TABLE ttFiles
The list of Files
Top

PUBLIC GetFolders (character, integer, character, table)
Purpose: Returns a list of Folders
Notes:

Parameters:
pcFolderScope CHARACTER
The folder scope
piRootIndex INTEGER
The root folders index
pcSubFolder CHARACTER
The optional sub folder
ttFolders TEMP-TABLE ttFolders
The list of Folders
Top

PRIVATE GetFolders (character, table)
Purpose: Returns a list of Folders
Notes:

Parameters:
pcDirectory CHARACTER
The directory
ttFolders TEMP-TABLE ttFolders
The list of Folders
Top

PUBLIC GetRootFolders (character, table)
Purpose: Returns a list of Root Folders
Notes:

Parameters:
pcFolderScope CHARACTER
The folder scope
ttRootFolders TEMP-TABLE ttRootFolders
The list of Root Folders
Top

PROTECTED LOGICAL IsRestricted (character, character)
Purpose: Returns if the token is restricted
Notes:

Parameters:
pcTokenType CHARACTER
The token type
pcFolderScope CHARACTER
The folder scope
Returns LOGICAL
true if the token is restricted


Temp-Table Detail

Temp-Table ttFilePatterns

Defined in:

Temp-Table ttFiles

Defined in:

Temp-Table ttFolders

Defined in:

Temp-Table ttRootFolders

Defined in:


©2006-2025 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       22.04.2025 11:18:43