Folder

Represents a repository for a Document, MailmergeTemplate, EmailTemplate, or report. Only one type of item can be contained in a folder.

Supported Calls

create(), update(), delete(), describeSObjects(), query(), retrieve(), getDeleted(), getUpdated()

Special Access Rules

You must have the “Modify All Data” permission to create, update, or delete document folders, email template folders, or report folders.
To query Folders, no special permissions are needed.
Customer Portal users cannot access this object.

Fields

Field	Field Type	Field Properties	Description
AccessType	picklist	Create Filter Restricted picklist Update	Required. Indicates who can access the Folder. Available values include: Hidden—Folder is hidden from everyone. Public—Folder is accessible by all users. Shared—Folder is accessible only by Users in a particular Group or UserRole. The API does not allow you to view, insert, or update which group or Role the Folder is shared with.
DeveloperName	string	Create Filter Nillable Update	The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object's name in a managed package and the changes are reflected in a subscriber's organization. Label is Folder Unique Name.
IsReadOnly	boolean	Create Defaulted on create Filter Update	Indicates whether this Folder is read-only (`true`) or editable (`false`). Label is Read Only.
Name	string	Create Filter idLookup Nillable Update	Label of the folder as it appears in the Salesforce.com user interface. Label is Document Folder Label.
NamespacePrefix	string	Filter Nillable	The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. The limit is 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects. This field cannot be accessed unless the logged-in user has the “Customize Application” permission.
Type	picklist	Create Filter Restricted picklist	Required. Type of objects contained in the Folder. This field cannot be updated. Available values include: Dashboard Document Email template Report

Usage

Only one type of item can be contained in a folder, either Document, MailmergeTemplate, EmailTemplate, or report.

© Copyright 2000-2009 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.