The Folder class has been added to the DOCUMENTS PortalScripting API to gain full access to the DOCUMENTS folders by scripting means. More...

Public Member Functions
boolean	addAccessProfile (String accessProfileName, boolean allowInsertFiles, boolean allowRemoveFiles)
	Add a folder access right for the user group defined by an access profile to the folder. More...

boolean	addFile (DocFile docFile)
	Store a reference to a desired DocFile object in the current Folder. More...

boolean	addFilterEDAServer (String serverName)
	Add an EDA server to the filter of the folder. More...

boolean	addFilterEEiArchive (String archiveKey)
	Add an EE.i archive to the filter of the folder. More...

boolean	addFilterEExView (String viewKey)
	Add an EE.x view to the filter of the folder. More...

boolean	addFilterFileType (String fileType)
	Add a file type to the filter of the folder. More...

boolean	addSystemUser (String loginName, boolean allowInsertFiles, boolean allowRemoveFiles)
	Add a folder access right for a system user to the folder. More...

boolean	addToOutbar (String outbarName)
	Add the folder to an outbar. More...

Folder	copyFolder (boolean includeSubFolders, boolean copyRights, boolean copyActions)
	The current Folder object is duplicated to create a new Folder object. More...

Folder	createSubFolder (String name, String type)
	Create a new subfolder of the specified folder type. More...

boolean	deleteFolder ()
	Delete the folder in DOCUMENTS. More...

UserAction	getActionByName (String actionName)
	Retrieve a user-defined action of the Folder. More...

String	getAttribute (String attribute)
	Get the String value of an attribute of the Folder. More...

FileResultset	getFiles ()
	Retrieve a FileResultset of all the DocFile objects stored in the Folder. More...

Array	getFilterFileTypes ()
	Retrieve the filter file types of the folder. More...

HitResultset	getHitResultset ()
	Create a HitResultset, which summarizes all DocFiles in the folder. More...

String	getLastError ()
	Function to get the description of the last error that occurred. More...

String	getLocaleLabel (String locale)
	Get the ergonomic label of the Folder. More...

String	getOID (boolean oidLow=false)
	Returns the object-id. More...

int	getPosition (Folder subFolder)
	Retrieve the position of a subfolder within the subfolder list. More...

FolderIterator	getSubFolders ()
	Retrieve a FolderIterator containing all Folder objects which represent subfolders of the given Folder. More...

boolean	hasFiles ()
	Retrieve information whether the Folder is empty or not. More...

boolean	removeAccessProfile (String accessProfileName)
	Remove all folder access rights of the user group defined by an access profile from the folder. More...

boolean	removeFile (DocFile docFile)
	Remove the reference to a desired DocFile object out of the current Folder. More...

boolean	removeFilterEDAServer (String serverName)
	Remove an EDA server from the filter of the folder. More...

boolean	removeFilterEEiArchive (String archiveKey)
	Remove an EE.i archive from the filter of the folder. More...

boolean	removeFilterEExView (String viewKey)
	Remove an EE.x view from the filter of the folder. More...

boolean	removeFilterFileType (String fileType)
	Remove a file type from the filter of the folder. More...

boolean	removeFromOutbar (String outbarName)
	Remove the folder from an outbar. More...

boolean	removeSystemUser (String loginName)
	Remove all folder access rights of a system user from the folder. More...

boolean	setAllowedActionScript (String scriptName)
	Set the script containing the allowed user-defined actions. More...

boolean	setAttribute (String attribute, String value)
	Set the String value of an attribute of the Folder to the desired value. More...

boolean	setParentFolder (Folder parentFolder)
	Set the parent folder of the current folder. More...

boolean	setPosition (Folder subFolder, int position)
	Place a subfolder at the given position in the subfolder list. More...

Public Attributes
boolean	allowArchive
	This property specifies whether the action 'Archive' is available for the folder. More...

boolean	allowCopyTo
	This property specifies whether the action 'Copy to' is available for the folder. More...

boolean	allowCreatePDF
	This property specifies whether the action 'PDF creation (Print)' is available for the folder. More...

boolean	allowDelete
	This property specifies whether the action 'Delete' is available for the folder. More...

boolean	allowExport
	This property specifies whether the action 'Export' is available for the folder. More...

boolean	allowForward
	This property specifies whether the action 'Forward' is available for the folder. More...

boolean	allowMoveTo
	This property specifies whether the action 'Store in' is available for the folder. More...

String	comparator1
	The comparator for the first filter of the Folder object. More...

String	comparator2
	The comparator for the second filter of the Folder object. More...

String	comparator3
	The comparator for the third filter of the Folder object. More...

String	filterExpression
	The expression of the filter of the folder. More...

String	filterfieldname1
	The field to use for the first filter of the Folder object. More...

String	filterfieldname2
	The field to use for the second filter of the Folder object. More...

String	filterfieldname3
	The field to use for the third filter of the Folder object. More...

String	filterStyle
	The filter style of the folder. More...

String	icon
	The icon to use in the folder tree. More...

String	id
	The internal id of the Folder object. More...

boolean	invisible
	This property specifies whether the folder is invisible to the users. More...

String	label
	The entire label defined for the Folder object. More...

String	name
	The technical name of the Folder object. More...

boolean	released
	This property specifies whether the folder is available to the users. More...

String	sortColumn
	The column used to sort the entries in the folder. More...

boolean	sortDescending
	This property specifies the sort order of the entries in the folder. More...

String	sortFieldName
	The technical name of the custom field used to sort the entries in the folder. More...

SystemUser	systemUser
	Returns the owner of a private folder. More...

String	type
	The type of the Folder object. More...

String	value1
	The desired field value to use for the first filter of the Folder object. More...

String	value2
	The desired field value to use for the second filter of the Folder object. More...

String	value3
	The desired field value to use for the third filter of the Folder object. More...

Detailed Description

The Folder class has been added to the DOCUMENTS PortalScripting API to gain full access to the DOCUMENTS folders by scripting means.

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

Member Function Documentation

◆ addAccessProfile()

boolean Folder::addAccessProfile	(	String	accessProfileName,
		boolean	allowInsertFiles,
		boolean	allowRemoveFiles
	)

Add a folder access right for the user group defined by an access profile to the folder.

Parameters

accessProfileName	The technical name of the access profile.
allowInsertFiles	Flag indicating whether inserting files into the folder is allowed.
allowRemoveFiles	Flag indicating whether removing files from the folder is allowed.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "public");
var success = folder.addAccessProfile("AccessProfile1", true, false);
if (!success)
util.out(folder.getLastError());

◆ addFile()

boolean Folder::addFile ( DocFile docFile )

Store a reference to a desired DocFile object in the current Folder.

Note: This only works in case the Folder is a real public Folder. The Folder must not represent a dynamic folder, since a dynamic folder is sort of a hardcoded search, not a "real" folder.

Parameters

docFile DocFile object which shall be available in the given Folder

Returns: true if successful, false in case of any error

Since: ELC 3.51h / otrisPORTAL 5.1h

◆ addFilterEDAServer()

boolean Folder::addFilterEDAServer ( String serverName )

Add an EDA server to the filter of the folder.

Note: This function is only available for a Folder of type 'dynamicpublic'.

Parameters

serverName The technical name of the desired EDA server.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var success = folder.addFilterEDAServer("eas1");
if (!success)
util.out(folder.getLastError());

◆ addFilterEEiArchive()

boolean Folder::addFilterEEiArchive ( String archiveKey )

Add an EE.i archive to the filter of the folder.

Note: This function is only available for a Folder of type 'dynamicpublic'.

Parameters

archiveKey The key of the desired EE.i archive.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var archiveKey = "$(#STANDARD)\\REGTEST@eei1";
var success = folder.addFilterEEiArchive(archiveKey);
if (!success)
util.out(folder.getLastError());

◆ addFilterEExView()

boolean Folder::addFilterEExView ( String viewKey )

Add an EE.x view to the filter of the folder.

Note: This function is only available for a Folder of type 'dynamicpublic'.

Parameters

viewKey The key of the desired EE.x view.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var viewKey = "Unit=Default/Instance=Default/View=REGTEST";
var success = folder.addFilterEExView(viewKey);
if (!success)
util.out(folder.getLastError());

◆ addFilterFileType()

boolean Folder::addFilterFileType ( String fileType )

Add a file type to the filter of the folder.

Note: This function is only available for a Folder of type 'dynamicpublic'.

Parameters

fileType The technical name of the desired file type.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var success = folder.addFilterFileType("Filetype1");
if (!success)
util.out(folder.getLastError());

◆ addSystemUser()

boolean Folder::addSystemUser	(	String	loginName,
		boolean	allowInsertFiles,
		boolean	allowRemoveFiles
	)

Add a folder access right for a system user to the folder.

Parameters

loginName	The login name of the system user.
allowInsertFiles	Flag indicating whether inserting files into the folder is allowed.
allowRemoveFiles	Flag indicating whether removing files from the folder is allowed.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "public");
var success = folder.addSystemUser("user1", true, false);
if (!success)
util.out(folder.getLastError());

◆ addToOutbar()

boolean Folder::addToOutbar ( String outbarName )

Add the folder to an outbar.

Parameters

outbarName The technical name of the outbar.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0d HF2

Example:: var folder = context.createFolder("testFolder", "public");
var success = folder.addToOutbar("testOutbar");
if (!success)
util.out(folder.getLastError());

◆ copyFolder()

Folder Folder::copyFolder	(	boolean	includeSubFolders,
		boolean	copyRights,
		boolean	copyActions
	)

The current Folder object is duplicated to create a new Folder object.

The new Folder object is placed at the same hierarchical stage as the Folder used as its source object. After the duplication of the Folder you can change all its public attributes, e.g. to modify the filter definition of a dynamic public folder.

Parameters

includeSubFolders	boolean whether to duplicate any subfolders contained in the source folder as well
copyRights	boolean whether to assign the same access privileges as those assigned to the source Folder
copyActions	boolean whether to duplicate any userdefined actions attached to the source folder as well

Returns: Folder object generated by the function call

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

◆ createSubFolder()

Folder Folder::createSubFolder	(	String	name,
		String	type
	)

Create a new subfolder of the specified folder type.

Note

There are three possible types available:

public
dynamicpublic
onlysubfolder

Parameters

name	The technical name of the subfolder to be created.
type	The desired type of the subfolder.

Returns: New created subfolder as Folder object or null if failed.

Since: DOCUMENTS 4.0c

Example:: var parentFolder = context.createFolder("parentFolder", "public");
if (parentFolder)
{
var subFolder = parentFolder.createSubFolder("subFolder", "dynamicpublic");
if (subFolder)
util.out(subFolder.type);
else
util.out(parentFolder.getLastError());
}

See also: Context.createFolder(String name, String type);

◆ deleteFolder()

boolean Folder::deleteFolder ( )

Delete the folder in DOCUMENTS.

Note: All subfolders are also deleted recursively.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "onlysubfolder");
if (folder)
{
var success = folder.deleteFolder();
if (success)
{
var itFolder = context.getFoldersByName("testFolder", "onlysubfolder");
util.out(itFolder.size() == 0);
}
}

See also: Context.deleteFolder(Folder folderObj)

◆ getActionByName()

UserAction Folder::getActionByName ( String actionName )

Retrieve a user-defined action of the Folder.

Parameters

actionName String value containing the desired action name.

Returns: UserAction object representing the user-defined action.

Since: DOCUMENTS 4.0d

Example:: var it = context.getFoldersByName("testFolder");
var folder = it.first();
if (folder)
{
var action = folder.getActionByName("testAction");
if (action)
{
action.type = "PortalScript";
action.setPortalScript("testScript");
}
else
util.out(folder.getLastError());
}

◆ getAttribute()

String Folder::getAttribute ( String attribute )

Get the String value of an attribute of the Folder.

Parameters

attribute String containing the name of the desired attribute

Returns: String containing the value of the desired attribute

Since: ELC 3.51b / otrisPORTAL 5.1b

◆ getFiles()

FileResultset Folder::getFiles ( )

Retrieve a FileResultset of all the DocFile objects stored in the Folder.

Note: It does not matter whether the Folder is a real public folder or a dynamic folder.

Returns: FileResultset containing a list of all DocFile objects stored in the Folder

Since: ELC 3.51b / otrisPORTAL 5.1b

◆ getFilterFileTypes()

Array Folder::getFilterFileTypes ( )

Retrieve the filter file types of the folder.

Returns: Array of strings containing the technical names of the file types.

Since: DOCUMENTS 5.0a HF2

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var success = folder.addFilterFileType("Filetype1");
if (!success)
util.out(folder.getLastError());
var fileTypes = folder.getFilterFileTypes();
if (fileTypes)
{
for (var i=0; i < fileTypes.length; i++)
{
util.out(fileTypes[i]);
}
}
else
util.out(folder.getLastError());

◆ getHitResultset()

HitResultset Folder::getHitResultset ( )

Create a HitResultset, which summarizes all DocFiles in the folder.

This function executes an empty (=unfiltered) search in the folder. It creates a HitResultset, which summarizes all the Folder's files. The Resultset contains the same columns as the folder's default web view.

Note: The function operates on dynamic and on static folders, but not on the special folders "tasks" and "resubmission".

Remarks: Reading from a lean HitResultset with only a few columns can be faster than reading from a FileResultset. Sometimes this effect outweighs the time-related costs of a search. If the folder addresses an archive, the time needed to create temporary DocFiles can be saved with this function. On a failed search request the function does not throw errors. To detect this kind of errors scripts should call HitResultset.getLastErrorCode() or HitResultset.getLastError() on the returned object.

Returns: A HitResultset, which contains column headers and a list of DocHit objects.

See also: getFiles()

Since: DOCUMENTS 5.0c

◆ getLastError()

String Folder::getLastError ( )

Function to get the description of the last error that occurred.

Returns: Text of the last error as String

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

See also: DocFile.getLastError()

◆ getLocaleLabel()

String Folder::getLocaleLabel ( String locale )

Get the ergonomic label of the Folder.

Parameters

locale Optional String value with the locale abbreviation (according to the principal's configuration); if omitted, the current user's portal language is used automatically.

Returns: String containing the ergonomic label of the Folder in the appropriate portal language.

Since: DOCUMENTS 4.0b HF2

◆ getOID()

String Folder::getOID ( boolean oidLow = false )

Returns the object-id.

Parameters

oidLow Optional flag:
If true only the id of the Folder object (m_oid) will be returned.
If false the id of the Folder object will be returned together with the id of the corresponding class in the form class-id:m_oid.
The default value is false.

Returns: String with the object-id

Since: ELC 3.60c / otrisPORTAL 6.0c; DOCUMENTS 5.0 (new parameter oidLow)

◆ getPosition()

int Folder::getPosition ( Folder subFolder )

Retrieve the position of a subfolder within the subfolder list.

Parameters

subFolder Folder object whose position to be retrieved.

Returns: The zero-based position of the subfolder as integer or -1 in case of any error.

Since: DOCUMENTS 4.0c

Example:: var parentFolder = context.createFolder("parentFolder", "public");
if (parentFolder)
{
var subFolder1 = parentFolder.createSubFolder("subFolder1", "dynamicpublic");
var subFolder2 = parentFolder.createSubFolder("subFolder2", "onlysubfolder");
if (subFolder1 && subFolder2)
{
var pos = parentFolder.getPosition(subFolder2);
util.out(pos == 1);
}
}

See also: Folder.setPosition(Folder subFolder, int position) Context.getFolderPosition(Folder folder)
Context.setFolderPosition(Folder folder, int position)

◆ getSubFolders()

FolderIterator Folder::getSubFolders ( )

Retrieve a FolderIterator containing all Folder objects which represent subfolders of the given Folder.

Returns: FolderIterator with all subfolders one hierarchical level below the given Folder

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

◆ hasFiles()

boolean Folder::hasFiles ( )

Retrieve information whether the Folder is empty or not.

Returns: true if DocFile objects available inside the Folder, false in case the Folder is empty

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

◆ removeAccessProfile()

boolean Folder::removeAccessProfile ( String accessProfileName )

Remove all folder access rights of the user group defined by an access profile from the folder.

Parameters

accessProfileName The technical name of the access profile.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "public");
var success = folder.addAccessProfile("AccessProfile1", true, false);
if (success)
{
success = folder.removeAccessProfile("AccessProfile1");
if (!success)
util.out(folder.getLastError());
}

◆ removeFile()

boolean Folder::removeFile ( DocFile docFile )

Remove the reference to a desired DocFile object out of the current Folder.

Note: This only works in case the Folder is a real public Folder. The Folder must not represent a dynamic folder, since a dynamic folder is sort of a hardcoded search, not a "real" folder.

Parameters

docFile DocFile object which shall be removed from the given Folder

Returns: true if successful, false in case of any error

Since: ELC 3.51h / otrisPORTAL 5.1h

◆ removeFilterEDAServer()

boolean Folder::removeFilterEDAServer ( String serverName )

Remove an EDA server from the filter of the folder.

Note: This function is only available for a Folder of type 'dynamicpublic'.

Parameters

serverName The technical name of the desired EDA server.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var success = folder.addFilterEDAServer("eas1");
if (success)
{
success = folder.removeFilterEDAServer("eas1");
if (!success)
util.out(folder.getLastError());
}

◆ removeFilterEEiArchive()

boolean Folder::removeFilterEEiArchive ( String archiveKey )

Remove an EE.i archive from the filter of the folder.

Note: This function is only available for a Folder of type 'dynamicpublic'.

Parameters

archiveKey The key of the desired EE.i archive.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var archiveKey = "$(#STANDARD)\\REGTEST@eei1";
var success = folder.addFilterEEiArchive(archiveKey);
if (success)
{
success = folder.removeFilterEEiArchive(archiveKey);
if (!success)
util.out(folder.getLastError());
}

◆ removeFilterEExView()

boolean Folder::removeFilterEExView ( String viewKey )

Remove an EE.x view from the filter of the folder.

Note: This function is only available for a Folder of type 'dynamicpublic'.

Parameters

viewKey The key of the desired EE.x view.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var viewKey = "Unit=Default/Instance=Default/View=REGTEST";
var success = folder.addFilterEExView(viewKey);
if (success)
{
success = folder.removeFilterEExView(viewKey);
if (!success)
util.out(folder.getLastError());
}

◆ removeFilterFileType()

boolean Folder::removeFilterFileType ( String fileType )

Remove a file type from the filter of the folder.

Note: This function is only available for a Folder of type 'dynamicpublic'.

Parameters

fileType The technical name of the desired file type.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "dynamicpublic");
var success = folder.addFilterFileType("Filetype1");
if (success)
{
success = folder.removeFilterFileType("Filetype1");
if (!success)
util.out(folder.getLastError());
}

◆ removeFromOutbar()

boolean Folder::removeFromOutbar ( String outbarName )

Remove the folder from an outbar.

Parameters

outbarName The technical name of the outbar.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0d HF2

Example:: var itFolder = context.getFoldersByName("testFolder", "public");
var folder = itFolder.first();
if (folder)
{
var success = folder.removeFromOutbar("testOutbar");
if (!success)
util.out(folder.getLastError());
}

◆ removeSystemUser()

boolean Folder::removeSystemUser ( String loginName )

Remove all folder access rights of a system user from the folder.

Parameters

loginName The login name of the system user.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "public");
var success = folder.addSystemUser("user1", true, false);
if (success)
{
success = folder.removeSystemUser("user1");
if (!success)
util.out(folder.getLastError());
}

◆ setAllowedActionScript()

boolean Folder::setAllowedActionScript ( String scriptName )

Set the script containing the allowed user-defined actions.

Parameters

scriptName The name of the desired script; use empty string ('') if you want to remove the associated action script.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var folder = context.createFolder("testFolder", "public");
var success = folder.setAllowedActionScript("testScript");
if (!success)
util.out(folder.getLastError());
// We can remove the action script as follows:
success = folder.setAllowedActionScript('');

◆ setAttribute()

boolean Folder::setAttribute	(	String	attribute,
		String	value
	)

Set the String value of an attribute of the Folder to the desired value.

Parameters

attribute	String containing the name of the desired attribute
value	String containing the desired value of the attribute

Returns: true if successful, false in case of any error

Since: ELC 3.51b / otrisPORTAL 5.1b

◆ setParentFolder()

boolean Folder::setParentFolder ( Folder parentFolder )

Set the parent folder of the current folder.

Parameters

parentFolder optional Folder object being the parent folder of the current folder. If no parent folder is defined, the current folder will be moved to the top level.

Returns: true if successful, false in case of any error

Since: DOCUMENTS 4.0c

Example:: var parentFolder = context.createFolder("parentFolder", "public");
if (parentFolder)
{
var subFolder = context.createFolder("subFolder", "dynamicpublic");
if (subFolder)
{
var success = subFolder.setParentFolder(parentFolder);
if (!success)
util.out(subFolder.getLastError());
// We can move subFolder to the top level as follows:
success = subFolder.setParentFolder();
}
}

◆ setPosition()

boolean Folder::setPosition	(	Folder	subFolder,
		int	position
	)

Place a subfolder at the given position in the subfolder list.

Note: 0 at the beginning and -1 at the end.

Parameters

subFolder	Folder object to be placed at the given position.
position	The 0-based position for the subfolder.

Returns: true if successful, false in case of any error.

Since: DOCUMENTS 4.0c

Example:: var parentFolder = context.createFolder("parentFolder", "public");
if (parentFolder)
{
var subFolder1 = parentFolder.createSubFolder("subFolder1", "dynamicpublic");
var subFolder2 = parentFolder.createSubFolder("subFolder2", "onlysubfolder");
if (subFolder1 && subFolder2)
{
var pos = parentFolder.getPosition(subFolder2);
util.out(pos == 1);
parentFolder.setPosition(subFolder1, -1);
pos = parentFolder.getPosition(subFolder2);
util.out(pos == 0);
}
}

See also: Folder.getPosition(Folder subFolder) Context.getFolderPosition(Folder folder)
Context.setFolderPosition(Folder folder, int position)

Member Data Documentation

◆ allowArchive

boolean Folder::allowArchive

This property specifies whether the action 'Archive' is available for the folder.

Returns: boolean value whether the action 'Archive' is allowed.

Since: DOCUMENTS 4.0c

◆ allowCopyTo

boolean Folder::allowCopyTo

This property specifies whether the action 'Copy to' is available for the folder.

Returns: boolean value whether the action 'Copy to' is allowed.

Since: DOCUMENTS 4.0c

◆ allowCreatePDF

boolean Folder::allowCreatePDF

This property specifies whether the action 'PDF creation (Print)' is available for the folder.

Returns: boolean value whether the action 'PDF creation (Print)' is allowed.

Since: DOCUMENTS 4.0c

◆ allowDelete

boolean Folder::allowDelete

This property specifies whether the action 'Delete' is available for the folder.

Returns: boolean value whether the action 'Delete' is allowed.

Since: DOCUMENTS 4.0c

◆ allowExport

boolean Folder::allowExport

This property specifies whether the action 'Export' is available for the folder.

Returns: boolean value whether the action 'Export' is allowed.

Since: DOCUMENTS 4.0c

◆ allowForward

boolean Folder::allowForward

This property specifies whether the action 'Forward' is available for the folder.

Returns: boolean value whether the action 'Forward' is allowed.

Since: DOCUMENTS 4.0c

◆ allowMoveTo

boolean Folder::allowMoveTo

This property specifies whether the action 'Store in' is available for the folder.

Returns: boolean value whether the action 'Store in' is allowed.

Since: DOCUMENTS 4.0c

◆ comparator1

String Folder::comparator1

The comparator for the first filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns

String containing the first comparator of the Folder. There are the following comparators available:

= equal
!= unequal
< smaller than
> greater than
~ contains
|~ starts with

◆ comparator2

String Folder::comparator2

The comparator for the second filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns

String containing the second comparator of the Folder. There are the following comparators available:

= equal
!= unequal
< smaller than
> greater than
~ contains
|~ starts with

◆ comparator3

String Folder::comparator3

The comparator for the third filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns

String containing the third comparator of the Folder. There are the following comparators available:

= equal
!= unequal
< smaller than
> greater than
~ contains
|~ starts with

◆ filterExpression

String Folder::filterExpression

The expression of the filter of the folder.

Note: This property is only available if the Folder represents a dynamic folder and the filter style 'Extended' is used.

Returns: String containing the filter expression.

Since: DOCUMENTS 4.0c

See also: Filter Expressions

◆ filterfieldname1

String Folder::filterfieldname1

The field to use for the first filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns: String containing the technical field name of the Folder's first filter.

◆ filterfieldname2

String Folder::filterfieldname2

The field to use for the second filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns: String containing the technical field name of the Folder's second filter.

◆ filterfieldname3

String Folder::filterfieldname3

The field to use for the third filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns: String containing the technical field name of the Folder's third filter.

◆ filterStyle

String Folder::filterStyle

The filter style of the folder.

There are two filter styles available:

Standard
Extended

Returns: String containing the filter style of the folder.

Since: DOCUMENTS 4.0c

◆ icon

String Folder::icon

The icon to use in the folder tree.

Returns: String containing the file name of the icon used in the folder tree.

Since: DOCUMENTS 4.0c

◆ id

String Folder::id

The internal id of the Folder object.

Returns: String containing the internal id of the Folder.

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

◆ invisible

boolean Folder::invisible

This property specifies whether the folder is invisible to the users.

Note: This property is not operative if the folder is not released.

Returns: boolean value whether the folder is invisible to the users.

Since: DOCUMENTS 4.0c

◆ label

String Folder::label

The entire label defined for the Folder object.

Returns: String containing the entire label of the Folder.

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

See also: Folder.getLocaleLabel(String locale)

◆ name

String Folder::name

The technical name of the Folder object.

Returns: String containing the technical name of the Folder.

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

◆ released

boolean Folder::released

This property specifies whether the folder is available to the users.

Returns: boolean value whether the folder is released.

Since: DOCUMENTS 4.0c

◆ sortColumn

String Folder::sortColumn

The column used to sort the entries in the folder.

The following sort columns are available:

Title
LastModifiedAt
LastEditor
CreateAt
Owner
CustomField

Returns: String containing the identifier of the selected sort column.

Since: DOCUMENTS 4.0c

◆ sortDescending

boolean Folder::sortDescending

This property specifies the sort order of the entries in the folder.

Returns: boolean value whether the entries in the folder are sorted by the Folder.sortColumn in descending order.

Since: DOCUMENTS 4.0c

◆ sortFieldName

String Folder::sortFieldName

The technical name of the custom field used to sort the entries in the folder.

Note: This field is only available if the Folder.sortColumn is set to 'CustomField'.

Returns: String containing the technical name of the field used to sort the entries in the folder.

Since: DOCUMENTS 4.0c

◆ systemUser

SystemUser Folder::systemUser

Returns the owner of a private folder.

Note: If the folder is a private folder (e.g. inbox) this property returns the owning SystemUser

Returns: SystemUser or null.

Since: DOCUMENTS 5.0d

◆ type

String Folder::type

The type of the Folder object.

Returns

String containing the type of the Folder. There are three possible types available:

public
dynamicpublic
onlysubfolder

Since: ELC 3.50l01 / otrisPORTAL 5.0l01

◆ value1

String Folder::value1

The desired field value to use for the first filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns: String containing the desired field value of the Folder's first filter.

◆ value2

String Folder::value2

The desired field value to use for the second filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns: String containing the desired field value of the Folder's second filter.

◆ value3

String Folder::value3

The desired field value to use for the third filter of the Folder object.

Note: This attribute only exists if the Folder represents a dynamic folder

Returns: String containing the desired field value of the Folder's third filter.

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addAccessProfile()

◆ addFile()

◆ addFilterEDAServer()

◆ addFilterEEiArchive()

◆ addFilterEExView()

◆ addFilterFileType()

◆ addSystemUser()

◆ addToOutbar()

◆ copyFolder()

◆ createSubFolder()

◆ deleteFolder()

◆ getActionByName()

◆ getAttribute()

◆ getFiles()

◆ getFilterFileTypes()

◆ getHitResultset()

◆ getLastError()

◆ getLocaleLabel()

◆ getOID()

◆ getPosition()

◆ getSubFolders()

◆ hasFiles()

◆ removeAccessProfile()

◆ removeFile()

◆ removeFilterEDAServer()

◆ removeFilterEEiArchive()

◆ removeFilterEExView()

◆ removeFilterFileType()

◆ removeFromOutbar()

◆ removeSystemUser()

◆ setAllowedActionScript()

◆ setAttribute()

◆ setParentFolder()

◆ setPosition()

Member Data Documentation

◆ allowArchive

◆ allowCopyTo

◆ allowCreatePDF

◆ allowDelete

◆ allowExport

◆ allowForward

◆ allowMoveTo

◆ comparator1

◆ comparator2

◆ comparator3

◆ filterExpression

◆ filterfieldname1

◆ filterfieldname2

◆ filterfieldname3

◆ filterStyle

◆ icon

◆ id

◆ invisible

◆ label

◆ name

◆ released

◆ sortColumn

◆ sortDescending

◆ sortFieldName

◆ systemUser

◆ type

◆ value1

◆ value2

◆ value3