com.filenet.api.sweep

Interface CmSweepResult

  • All Superinterfaces:
    EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable
    All Known Subinterfaces:
    CmJobSweepResult, CmPolicySweepResult

    public interface CmSweepResult
extends RepositoryObject, IndependentlyPersistableObject
    Represents a result record for an object selected by a sweep. The implementations of this abstract base class define result records for continuously running policy sweeps and for run-once job sweeps. Results include the controlling sweep, the source object, the time of processing, and the type of result record, either failure or preview.

    A sweep can run in either normal or preview mode, which determines the type of result record. In normal mode, a sweep performs an action on the selected candidate objects. If a processing error occurs on a swept object, the sweep generates a result record of type FAILURE. This type of result record describes the failure.

    In preview mode, a sweep only selects candidate objects for processing; it does not actually perform an action on the selected objects. For each candidate object, the sweep generates a result record of type PREVIEW. This type of result record identifies the object as one that would be processed if the sweep were operating in normal mode.

    To determine result record type, get the SweepResultType property.

    You can retrieve result records from a sweep policy or sweep job object, or from an SQL search. You can also delete result records, either manually or through a disposal policy. Permissions on result records are determined by the security defined on the controlling object, that is, the sweep policy or sweep job.

    Metadata

    Auditable: false
    AllowsInstances: false
    AllowsSubClasses: false
    ClassDefinitionName: ClassDefinition
    IsDependent: false
    IsHidden: true
    Name: Id
    Searchable: true
    StorageType: ObjectStore
    SuperclassName: GenericObject
    See Also:
    CmSweepJob, CmSweepPolicy

    • Method Detail

      • get_Creator

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

      • set_Creator

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

      • get_DateCreated

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

      • set_DateCreated

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

      • get_LastModifier

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

      • set_LastModifier

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

      • get_DateLastModified

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

      • set_DateLastModified

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

      • get_Id

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

      • get_FailureDescription

        java.lang.String get_FailureDescription()
        Returns the value of the FailureDescription property. For more information, see FailureDescription Property.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

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