com.filenet.api.core

Interface Folder

    • Method Detail

      • get_Parent

        Folder get_Parent()
        Returns the value of the Parent property. For more information, see Parent Property.

      • set_Parent

        void set_Parent(Folder value)
        Sets the value of the Parent property. For more information, see Parent Property.

      • get_FolderName

        java.lang.String get_FolderName()
        Returns the value of the FolderName property. For more information, see FolderName Property.

      • set_FolderName

        void set_FolderName(java.lang.String value)
        Sets the value of the FolderName property. For more information, see FolderName Property.

      • get_PathName

        java.lang.String get_PathName()
        Returns the value of the PathName property. For more information, see PathName Property.

      • get_InheritParentPermissions

        java.lang.Boolean get_InheritParentPermissions()
        Returns the value of the InheritParentPermissions property. For more information, see InheritParentPermissions Property.

      • set_InheritParentPermissions

        void set_InheritParentPermissions(java.lang.Boolean value)
        Sets the value of the InheritParentPermissions property. For more information, see InheritParentPermissions Property.

      • get_IndexationId

        Id get_IndexationId()
        Returns the value of the IndexationId property. For more information, see IndexationId Property.

      • get_CmIndexingFailureCode

        java.lang.Integer get_CmIndexingFailureCode()
        Returns the value of the CmIndexingFailureCode property. For more information, see CmIndexingFailureCode Property.

      • get_CmRetentionDate

        java.util.Date get_CmRetentionDate()
        Returns the value of the CmRetentionDate property. For more information, see CmRetentionDate Property.

      • set_CmRetentionDate

        void set_CmRetentionDate(java.util.Date value)
        Sets the value of the CmRetentionDate property. For more information, see CmRetentionDate Property.

      • get_CmIsMarkedForDeletion

        java.lang.Boolean get_CmIsMarkedForDeletion()
        Returns the value of the CmIsMarkedForDeletion property. For more information, see CmIsMarkedForDeletion Property.

      • unfile

        ReferentialContainmentRelationship unfile(IndependentlyPersistableObject containee)
        Removes the specified containee from this folder. This does not delete the containee object from the object store.

        The method returns a ReferentialContainmentRelationship (RCR) object. You must call the save method on the returned RCR. This method is equivalent to getting the RCR and deleting it.

        A UnFileEvent is triggered by the deletion of a RCR object. The source object of the event is the Folder object on which the unfile method was invoked.

        Parameters:
        containee - The containment name of the object to remove.
        Returns:
        The ReferentialContainmentRelationship object for the containee to remove.
        See Also:
        file

      • isLocked

        java.lang.Boolean 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 lock 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 lock method or the lock could expire.

        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 isLocked method returns false if the LockTimeout property is not set or if the lock has expired. The lock is determined to be expired if the DateLastModified property value plus the number of seconds specified by the LockTimeout property is less than the current system time. (All millisecond components are dropped from the calculation.) If the DateLastModified property is not set, this method returns false because the check against the lock timeout value or the lock token will yield null, meaning that the object is not locked. As soon as some action locks the object, the DateLastModified property will be updated and can then used for the expiration calculation.

        Note To successfully run isLocked and other cooperative locking methods, system clocks on the IBM FileNet P8 platform engine machines must be synchronized. The calculation performed by the isLocked() method is done on the client system. If the client and server machine clocks are not synchronized, the result of this calculation might be incorrect.

        Returns:
        true if this object is locked; otherwise, returns false.

      • changeClass

        void changeClass(java.lang.String className)
        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 changeClass 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:
        • Any user-defined properties that exist in the new class but not in the original class are set to the default value defined by the new class (or to null if there is no default defined).
        • Any user-defined properties that exist in both the original and the new class that are writable and have the same value (including null) as the default value defined in the original class will be set to the default value defined by the new class. However, any user-defined property that has had its value modified from the default value will retain that modified value in the new class.
        • Any user-defined properties whose definitions exist in the original class but not in the new class will no longer exist on the object when its class is changed.
        • Property constraints for the new class (for example, required values, choice lists, ranges) are not enforced.

        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 DocumentLifecyclePolicy property if both of the following scenarios occur:

        • The document has no current lifecycle policy.
        • The document is either a reservation object, or is the current version object and is not reserved.

        Changing the document class of a document object has no effect on the storage location of the document�s content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer�s Guide.

        Parameters:
        className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.
        Throws:
        E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.

      • move

        void move(Folder targetFolder)
        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.

        Parameters:
        targetFolder - A Folder object for the intended parent folder for this instance. The target folder must already exist.
        Throws:
        EngineRuntimeException - Thrown if the target folder is this instance or one of its subfolders.

      • lock

        void lock(int timeout,
        java.lang.String owner)
        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 Document object requires the following combination of access rights: AccessRight.CHANGE_STATE | AccessRight.CREATE_INSTANCE | AccessRight.LINK | AccessRight.UNLINK | AccessRight.VIEW_CONTENT | AccessRight.WRITE | AccessRight.READ_ACL | AccessLevel.READ.

        If the call succeeds:

        • The object's LockOwner property is populated with the user name specified in the owner parameter. (New lock only.)
        • The value specified by timeout is applied to the object's LockTimeout property.
        • A LockToken (GUID) is internally created by the server. (New lock only.)

        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 owner string. If the call succeeds, then only the LockTimeout property is updated with the timeout value. The owner parameter in this case is ignored. (See the updateLock() method instead.)

        Parameters:
        timeout - An integer that represents the number of seconds after which the lock will expire. The range of values is 0 to 2147483647 (Integer.MAX_VALUE) seconds.
        owner - A String representing the user name to be assigned as the owner of the lock on this object. Defaults to the short principal name of the requesting user. The value is strictly advisory and is not validated against user or group names known to the Content Engine. The value can be used by client applications to identify the user who has locked the object.
        Throws:
        E_OBJECT_LOCKED - If the object is already locked and the current user does not match the user of the lock.
        E_OBJECT_NOT_LOCKED - If the user tries to update an existing lock but the object is not locked (absence of a LockToken).

      • createSubFolder

        Folder createSubFolder(java.lang.String name)
        Creates a directly-contained subfolder of this folder.

        A FileEvent is triggered by the creation of a subfolder. The source object of the event is the Folder object on which this method is invoked.

        Parameters:
        name - A String containing the name to assign to the new child folder.
        Returns:
        A Folder object for the new child folder.

      • updateLock

        void updateLock(long timeout)
        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.

        Parameters:
        timeout - The changed timeout value, in seconds, for this object's lock. The range of values is 0 to 2147483647 (Integer.MAX_VALUE) seconds.

      • file

        ReferentialContainmentRelationship file(IndependentlyPersistableObject containee,
                                      AutoUniqueName autoUniqueName,
                                      java.lang.String containmentName,
                                      DefineSecurityParentage defineSecurityParentage)
        Files an instance of a Containable subclass to this folder. Depending on the Containable subclass filed, a ReferentialContainmentRelationship (RCR) object (for custom objects and folders) or a DynamicReferentialContainmentRelationship (DRCR) object (for documents) is created to reference this folder and the containee (instance filed). A FileEvent is triggered by the creation of a RCR or DRCR object. The source object of the event is the Folder object on which the file method was invoked.
        Parameters:
        containee - An IndependentlyPersistableObject object for the Containable subclass instance to be filed.
        autoUniqueName - An AutoUniqueName object indicating whether to detect and resolve naming collisions of containment names. If no value is provided for the containmentName parameter, the server will derive one as described in ContainmentName, and the server will default to the AUTO_UNIQUE value for this parameter.
        containmentName - A String containing the containment name to assign to the new object. By default, this is the file name of the object. The following characters are not allowed: 
            \  /  :  *  ?  "  <  >  |
        defineSecurityParentage - A DefineSecurityParentage object indicating whether the containing folder is to be used as a security parent. If so, the SecurityFolder property of the object being added is automatically set to this folder.
        Returns:
        A ReferentialContainmentRelationship object where this folder is the tail and the object filed (containee) is the head.
        See Also:
        unfile

      • applySecurityTemplate

        void applySecurityTemplate(Id applyStateId)
        Applies a security policy template to the given object. The specified value for the applyStateId 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:
        • VersionStatusId.IN_PROCESS
        • VersionStatusId.RELEASED
        • VersionStatusId.RESERVATION
        • VersionStatusId.SUPERSEDED
         For an application security template, the apply state ID is defined by your application.
        Parameters:
        applyStateId - An Id object representing the unique identifier of the security template to apply.

      • unlock

        void 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 tht user has AccessRight.WRITE_ACL 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 null). If you do not call unlock to explicitly remove the lock, the lock is implicitly removed when the lock's timeout value expires.
        Throws:
        E_OBJECT_NOT_LOCKED - If the object is not locked.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2013. All rights reserved.