Folder Class Properties
In this section, we discuss the Folder class properties. The properties are discussed in alphabetical order.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return a string representing the node on which the SmartNavigation content resides.
This property is read/write.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return a string indicating whether the SmartNavigation data source is a tree ("T") or a rowset ("R").
This property is read/write.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return a string representing the path and PeopleCode object to execute when processing this SmartNavigation folder.
For example, if the PeopleCode program to execute is a method, then AbnPeopleCode property would be constructed from these elements:
APP_PACKAGE_NAME.Class_Path.MethodFor example, if the PeopleCode program to execute is an iScript, then AbnPeopleCode property would be constructed from these elements:
RECORD_NAME.FIELD_NAME.PC_Event.FunctionThis property is read/write.
Description
This property returns an Attribute Collection containing the AttributeValue objects for this folder.
This property is read-only.
Related Links
Description
This property returns the author (PeopleSoft user ID) for this folder as a string.
This property is read-only.
Description
This property specifies whether the author of the folder has access to the folder. This property takes a Boolean value. The default value for this property for a newly created object is True. This property is not cascaded.
This property is read/write.
Description
This property specifies whether the user is authorized to view this Folder.
This property is used when you access a particular Folder using FindFolderByName. If you've specified a valid Folder with this method, a Folder is always returned, whether you are authorized to view it or not. This is the only property you can view from an object that you are not authorized to.
The initial value of this property depends on the other permission properties (PublicAccess and AuthorAccess) and the permission list values in the PermissionValue object associated with this folder.
This property is read-only.
Related Links
Description
This property returns a PermissionValue Collection. This collection contains the value of the non role-based permissions for all the child and parent objects (up to the root folder). To determine only the permissions of the object use the Permission property instead. To determine the role-based permissions of the object use the CascadedRolePermissions property instead.
Note: You cannot add any PermissionValue objects to a collection returned by the CascadedPermissions property. You can add values only to the collection returned by the Permissions or RolePermissions property.
This property is read-only.
Related Links
CascadedRolePermissions, PermissionValue Collection, Permissions
Description
This property returns a RolePermissionValue Collection. This collection contains the value of the role-based permissions for all the child and parent objects (up to the root folder). To determine only the role-based permissions of the object use the RolePermission property instead. To determine the non role-based permissions of the object use the CascadedPermissions property.
Note: You cannot add any PermissionValue objects to a collection returned by the CascadedRolePermissions property. You can add values only to the collection returned by the Permissions or RolePermissions property.
This property is read-only.
Related Links
CascadedPermissions RolePermissions RolePermissionValue Collection
Description
This property returns the ContentReference Collection for this folder.
This property is read-only.
Related Links
Description
This property returns the creation date for this folder as a string.
This property is read-only.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return a Boolean value indicating whether the default PeopleTools chart navigation page (PT_ABN_ORGCHART) is to be used for this folder: True, use the default PeopleTools chart navigation page; False, use the folder specified by the value Folder Navigation Object Name field (from the Folder Administration page) as the navigation object.
This property is read/write.
Description
This property returns or sets the description for this folder as a string.
The length of this property is 256 characters. This property is translatable.
This property is read/write.
Description
This property returns a reference to the Folder Collection for this folder.
This property is read-only.
Related Links
Description
Note: PeopleSoft Mobile Agent is a deprecated product. This mobile property currently exists for backward compatibility only.
This property returns True if the folder is used with mobile applications, False otherwise.
This property is read/write.
Description
This property returns True if the Hide from Portal Navigation check box is not selected when the folder is created. If the folder is hidden from portal navigation, this property returns False.
Considerations Using IsVisible
If you do not specifically set this property on a new or copied folder, the IsVisible property is set as follows:
If the ValidFrom date is less then or equal to that day's date, the IsVisible property is set to True.
If there is no ValidTo date the IsVisible property is set to True.
If the ValidTo date is greater then or equal to that day's date, the IsVisible property is set to True.
This property is read-only.
Description
This property returns or sets the label for this folder as a string.
The length of this property is 30 characters.
This property is translatable.
This property is read/write.
Description
This property returns the name for this folder as a sting. The name is a unique identifier for each folder.
Every folder name must be unique across the portal, not just in the parent folder.
This property is not translatable. However, the values for the Label and Description properties are translatable.
This property is read-only.
Related Links
Description
This property returns the name of the owner for this folder as a string.
This property is read/write.
Description
This property returns the parent folder name for this folder as a string. This property is valid only if the folder is contained within another folder. If the folder using this property is the root folder, this property returns an empty string.
This property is read-only.
Description
The Path property returns a path to this folder, with each element of the path separated by a period. The path has the following syntax:
FolderLabel{Name}.[ChildFolderLabel{Name}.]. . .This property is read-only.
Example
Departments{PORTA_ROOT_OBJECT}.HR{EastCoast}.AdministerWorkforce{Global}Description
This property returns a PermissionValue Collection. This collection contains the value of the non role-based permissions for this folder. To determine the permissions for all the parent objects (up to the root folder) use the CascadedPermissions property. To access the role-based permissions, use the RolePermissions property.
This property is read-only.
Description
This property returns or sets the PeopleSoft product for this folder as a string.
The length of this property is 4 characters.
This property is read/write.
Description
This property indicates whether a folder is generally accessible, that is, if this property is set to True, any user can access the folder. This property is not cascaded.
This property takes a Boolean value.
The default value for this property for a newly created object is False.
This property is read/write.
Description
This property returns a RolePermissionValue Collection. This collection contains the value of the role-based permissions for this folder. To determine the role-based permissions for all the parent objects (up to the root folder) use the CascadedRolePermissions property. To access the non role-based permissions, use the Permissions property.
This property is read-only.
Related Links
CascadedRolePermissions Permissions RolePermissionValue Collection
Description
The sequence number is used when returning a collection. The default order of the returned folders is based on the sequence number. Use this property to reorder folders.
If there are duplicates in the sequence number, the folders are returned alphabetically.
The length of this property is 4 characters.
This property is read/write.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return the effective date for the tree to be used as the SmartNavigation data source as a string.
Note: If the SmartNavigation data source is a rowset, this property is set to the Null string.
This property is read/write.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return the name for the tree to be used as the SmartNavigation data source as a string.
Note: If the SmartNavigation data source is a rowset, this property is set to the Null string.
SmartNavigation passes the values of several tree-specific fields to the application via URL. Certain characters are inappropriate for use in a URL and must be avoided. When using a tree as a SmartNavigation data source, do not use any of the following characters in the tree name, setID, user key value, and tree branch values:
|
pound (#) |
percent (%) |
dollar ($) |
|
ampersand (&) |
plus (+) |
comma (,) |
|
forward slash/virgule (/) |
colon (:) |
semi-colon (;) |
|
equals (=) |
question mark (?) |
at symbol (@) |
|
space ( ) |
quotation marks(") |
less than symbol (<) |
|
greater than symbol (>) |
left curly brace ({) |
right curly brace (}) |
|
vertical bar/pipe (|) |
backslash (\) |
caret (^) |
|
tilde (~) |
left square bracket ([) |
right square bracket (]) |
|
grave accent (`) |
This property is read/write.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return the setID for the tree to be used as the SmartNavigation data source as a string.
Note: If the SmartNavigation data source is a rowset, this property is set to the Null string.
SmartNavigation passes the values of several tree-specific fields to the application via URL. Certain characters are inappropriate for use in a URL and must be avoided. When using a tree as a SmartNavigation data source, do not use any of the following characters in the tree name, setID, user key value, and tree branch values:
|
pound (#) |
percent (%) |
dollar ($) |
|
ampersand (&) |
plus (+) |
comma (,) |
|
forward slash/virgule (/) |
colon (:) |
semi-colon (;) |
|
equals (=) |
question mark (?) |
at symbol (@) |
|
space ( ) |
quotation marks(") |
less than symbol (<) |
|
greater than symbol (>) |
left curly brace ({) |
right curly brace (}) |
|
vertical bar/pipe (|) |
backslash (\) |
caret (^) |
|
tilde (~) |
left square bracket ([) |
right square bracket (]) |
|
grave accent (`) |
This property is read/write.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return the branch for the tree to be used as the SmartNavigation data source as a string.
Note: If the SmartNavigation data source is a rowset, this property is set to the Null string.
SmartNavigation passes the values of several tree-specific fields to the application via URL. Certain characters are inappropriate for use in a URL and must be avoided. When using a tree as a SmartNavigation data source, do not use any of the following characters in the tree name, setID, user key value, and tree branch values:
|
pound (#) |
percent (%) |
dollar ($) |
|
ampersand (&) |
plus (+) |
comma (,) |
|
forward slash/virgule (/) |
colon (:) |
semi-colon (;) |
|
equals (=) |
question mark (?) |
at symbol (@) |
|
space ( ) |
quotation marks(") |
less than symbol (<) |
|
greater than symbol (>) |
left curly brace ({) |
right curly brace (}) |
|
vertical bar/pipe (|) |
backslash (\) |
caret (^) |
|
tilde (~) |
left square bracket ([) |
right square bracket (]) |
|
grave accent (`) |
This property is read/write.
Description
Note: SmartNavigation has been deprecated. This property remains for backward compatibility only.
Use this property to set or return the user key value (also known as the set control value) for the tree to be used as the SmartNavigation data source as a string.
Note: If the SmartNavigation data source is a rowset, this property is set to the Null string.
SmartNavigation passes the values of several tree-specific fields to the application via URL. Certain characters are inappropriate for use in a URL and must be avoided. When using a tree as a SmartNavigation data source, do not use any of the following characters in the tree name, setID, user key value, and tree branch values:
|
pound (#) |
percent (%) |
dollar ($) |
|
ampersand (&) |
plus (+) |
comma (,) |
|
forward slash/virgule (/) |
colon (:) |
semi-colon (;) |
|
equals (=) |
question mark (?) |
at symbol (@) |
|
space ( ) |
quotation marks(") |
less than symbol (<) |
|
greater than symbol (>) |
left curly brace ({) |
right curly brace (}) |
|
vertical bar/pipe (|) |
backslash (\) |
caret (^) |
|
tilde (~) |
left square bracket ([) |
right square bracket (]) |
|
grave accent (`) |
This property is read/write.
Description
This property returns or sets the date this folder is valid from as a string.
This property is read/write.
Description
This property returns or sets the date this folder is valid until as a string.
This property is read/write.
Note: The portal registry API never uses the ValidTo and ValidFrom fields to determine what to return in a collection. You must check for these values in your application.