com.filenet.rm.bds

Interface DocumentDefinition

  • All Superinterfaces:
    BaseDefinition


    public interface DocumentDefinition
    extends BaseDefinition
    This interface represents the definition of a single document to be committed.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean getAutoClassify()
      Controls whether or not auto classification will be performed on the newly created CE document defined by this DocumentDefinition.
      java.util.List getContentElements()
      Returns a modifiable List of ContentElement instances associated with this DocumentDefinition instance.
      boolean getCreateAsMajorVersion()
      Controls whether or not the newly created CE document defined by this DocumentDefinition instance is to be checked in initially as a major or as a minor version.
      void setAutoClassify(boolean autoClassify)
      Controls whether or not auto classification will be performed on the newly created CE document defined by this DocumentDefinition.
      void setCreateAsMajorVersion(boolean asMajor)
      Controls whether or not the newly created CE document defined by this DocumentDefinition instance is to be checked in initially as a major or minor version.
    • Method Detail

      • getContentElements

        java.util.List getContentElements()
        Returns a modifiable List of ContentElement instances associated with this DocumentDefinition instance. This List is initially empty for a newly instantiated DocumentDefinition.
        Returns:
        a List of ContentElement instances.
      • setCreateAsMajorVersion

        void setCreateAsMajorVersion(boolean asMajor)
        Controls whether or not the newly created CE document defined by this DocumentDefinition instance is to be checked in initially as a major or minor version.
        Parameters:
        asMajor - true if as a major version; false if as a minor version.
      • getCreateAsMajorVersion

        boolean getCreateAsMajorVersion()
        Controls whether or not the newly created CE document defined by this DocumentDefinition instance is to be checked in initially as a major or as a minor version.
        Returns:
        true if as a major version; false if as a minor version.
      • setAutoClassify

        void setAutoClassify(boolean autoClassify)
        Controls whether or not auto classification will be performed on the newly created CE document defined by this DocumentDefinition.
        Parameters:
        autoClassify - true to allow auto classification.
      • getAutoClassify

        boolean getAutoClassify()
        Controls whether or not auto classification will be performed on the newly created CE document defined by this DocumentDefinition.
        Returns:
        if auto classification is allowed.

© Copyright IBM Corp. 2006, 2013. All Rights Reserved.