Containable
subclasses, but cannot have content data of its own. Although Folder
objects and their subclasses can be referentially contained, they are the only Containable subclass that can be directly contained (in a Folder
). All other Containable
subclasses are referentially contained using the ReferentialContainmentRelationship
or DynamicReferentialContainmentRelationship
classes. Note: Folders that are referentially contained cannot participate in hierarchy index searches.
The container hierarchy is a one-to-many relationship: a folder can have many child folders, but a child folder can have only one parent folder. At the top of the container hierarchy is an automatically-created root folder. Use
Folders are not versionable.
The following tables list the members exposed by IFolder.
Public Properties
Name | Description | |
---|---|---|
![]() | ContainedDocuments | A collection object containing the objects contained within this folder. |
![]() | Containees | A collection object containing the objects contained within this folder. |
![]() | FolderName | The name of the folder. This cannot be an empty string. The following characters are not allowed:
|
![]() | IndexationId | The object ID (GUID) of the Verity collection used. This will be for objects that were full text indexed prior to the 4.0 release. This property must be set if the property is to be CBR enabled (the |
![]() | InheritParentPermissions | Defines whether a given folder can inherit permissions from its parent folder. |
![]() | Parent | The object for the folder that directly contains this folder. |
![]() | PathName | The full path name of the folder. |
![]() | SubFolders | A collection object containing the objects for the directly-contained child folders of this . Any referentially-contained child folders are not included in the collection. |
![]() | WorkflowSubscriptions | The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription objects whose target is this object. |
Public Methods
Name | Description | |
---|---|---|
![]() | ApplySecurityTemplate | Applies a security policy template to the given object. The specified value for the parameter must match the value of the ApplyStateID property of one of the templates in the security policy for the object. For a versioning security template, the apply state ID can be one of the following: For an application security template, the apply state ID is defined by your application. |
![]() | ChangeClass | Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:
When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's
|
![]() | CreateSubFolder | Creates a directly-contained subfolder of this folder. |
![]() | File | |
![]() | IsLocked | Queries this object's lock state. This helper method examines the object's lock-related properties and determines the object's lock state. An alternative approach is to call the method and handle any exception thrown if the method fails. Note that this method returns an approximation of the locked state at the time of the call. Once this method executes and returns the value, the object's lock state could be immediately changed by another application's call to the Before calling this method, make sure that the object's LockToken, LockTimeout, and DateLastModified properties have relatively fresh values. If any of those properties is missing, they are silently fetched from the server and added to the object's property cache. The Note: Note: To successfully run |
![]() | LockObject | Sets a new lock or updates an existing lock on the object. Calling this method has no effect in preventing others from updating a locked object (with the exception that others cannot re-lock the locked object). This lock mechanism is used for custom purposes only and has no bearing on the actual ability to update an object. To successfully execute this method, the current user must have permission to modify this object's properties. For example, locking a If the call succeeds:
To update an existing lock, the objects needs to be in the locked state and the current user needs to match the user of the lock. Note that the user is the logged in user, not the |
![]() | Move | Moves this folder and all of its subfolders and contents from its current parent folder to the target parent folder specified. Note: You cannot move the root folder for the object store. |
![]() | Unfile | Overloaded. Removes the specified containee from this folder. This does not delete the containee object from the object store. You then need to call the |
![]() | Unlock | Explicitly removes the lock from this object. Only the user who locked the object may remove the lock. If the current user is not the user of the lock, the current user can still remove the lock provided that user has permission on the object. An exception is thrown if the above conditions are not met. Upon successful execution of this method, the values for the object's LockOwner, LockToken, and LockTimeout properties are removed (set to ). If you do not call to explicitly remove the lock, the lock is implicitly removed when the lock's timeout value expires. |
![]() | UpdateLock | Adjusts the timeout period of the lock on this object. This method updates the object's DateLastModified property to the current time and its LockTimeout property to the timeout value. The net effect of this may extend or shorten the original lock's expiration time. Only the user who locked the object can successfully call this method; for any other user, an exception is thrown. There is no limit to the number of times you can call this method. |