Package com.appiancorp.suiteapi.content

Class CopySource

java.lang.Object
com.appiancorp.suiteapi.content.CopySource
public class CopySource extends Object
Represents an instruction for the source of a Content copy.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COPY_CREATED
    Copy the created timestamp; otherwise, the current timestamp will be used.
    static final int
    COPY_CREATOR
    Copy the creator username; otherwise, the current user will be used.
    static final int
    COPY_DEFAULT
    This is the default copy rule if none specified in constructor.
    static final int
    COPY_EXCLUDE
    Exclude source and its children from copy.
    static final int
    COPY_EXCLUDE_VERSIONS
    Exclude versions of Content items, rather than copying them as well.
    static final int
    COPY_INACTIVE
    Copy inactive items as well as active items; otherwise, only active items will be copied.
    static final int
    COPY_INCLUDE_INTO
    Copy source into target, as its child or children.
    static final int
    COPY_INCLUDE_ONTO
    Copy source onto target, such that source's children are copied to target, but not source itself.
    static final int
    COPY_SECURITY
    Copy custom security rolemaps where present, otherwise always inherit.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CopySource()
    Blank CopySource with default rule; the source must still be set.
    CopySource(Long source)
    CopySource with given source and default rule.
    CopySource(Long source, int rule)
    CopySource with given source and rule.
    CopySource(Long source, Integer rule)
    CopySource with given source and rule.

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getRule()
    Copy rule.
    Long
    getSource()
    Source id to copy.
    void
    setRule(int value)
     
    void
    setRule(Integer value)
     
    void
    setSource(Long value)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • COPY_INCLUDE_INTO

      public static final int COPY_INCLUDE_INTO
      Copy source into target, as its child or children. The COPY_ constants may be ORd together for a combined rule.
      See Also:

    • COPY_INCLUDE_ONTO

      public static final int COPY_INCLUDE_ONTO
      Copy source onto target, such that source's children are copied to target, but not source itself. The COPY_ constants may be ORd together for a combined rule.
      See Also:

    • COPY_EXCLUDE

      public static final int COPY_EXCLUDE
      Exclude source and its children from copy. Use this to exclude a particular hierarchy from a source higher in the tree. Children of this source that are explicitly included in the CopySource list will still be copied. The COPY_ constants may be ORd together for a combined rule.
      See Also:

    • COPY_SECURITY

      public static final int COPY_SECURITY
      Copy custom security rolemaps where present, otherwise always inherit.
      See Also:

    • COPY_EXCLUDE_VERSIONS

      public static final int COPY_EXCLUDE_VERSIONS
      Exclude versions of Content items, rather than copying them as well. The COPY_ constants may be ORd together for a combined rule.
      See Also:

    • COPY_CREATOR

      public static final int COPY_CREATOR
      Copy the creator username; otherwise, the current user will be used. The COPY_ constants may be ORd together for a combined rule.
      See Also:

    • COPY_CREATED

      public static final int COPY_CREATED
      Copy the created timestamp; otherwise, the current timestamp will be used. The COPY_ constants may be ORd together for a combined rule.
      See Also:

    • COPY_INACTIVE

      public static final int COPY_INACTIVE
      Copy inactive items as well as active items; otherwise, only active items will be copied. The COPY_ constants may be ORd together for a combined rule.
      See Also:

    • COPY_DEFAULT

      public static final int COPY_DEFAULT
      This is the default copy rule if none specified in constructor.
      See Also:

  • Constructor Details

    • CopySource

      public CopySource()
      Blank CopySource with default rule; the source must still be set.

    • CopySource

      public CopySource(Long source)
      CopySource with given source and default rule.

    • CopySource

      public CopySource(Long source, Integer rule)
      CopySource with given source and rule.

    • CopySource

      public CopySource(Long source, int rule)
      CopySource with given source and rule.

  • Method Details

    • getSource

      public Long getSource()
      Source id to copy.

    • getRule

      public Integer getRule()
      Copy rule. See COPY_ constants.

    • setSource

      public void setSource(Long value)
      Parameters:
      Source - id to copy.

    • setRule

      public void setRule(Integer value)
      Parameters:
      Copy - rule. See COPY_ constants.

    • setRule

      public void setRule(int value)
      Parameters:
      Copy - rule. See COPY_ constants.