Package com.appiancorp.suiteapi.content
Class CopySource
java.lang.Object
com.appiancorp.suiteapi.content.CopySource
Represents an instruction for the source of a Content copy.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Copy the created timestamp; otherwise, the current timestamp will be used.static final int
Copy the creator username; otherwise, the current user will be used.static final int
This is the default copy rule if none specified in constructor.static final int
Exclude source and its children from copy.static final int
Exclude versions of Content items, rather than copying them as well.static final int
Copy inactive items as well as active items; otherwise, only active items will be copied.static final int
Copy source into target, as its child or children.static final int
Copy source onto target, such that source's children are copied to target, but not source itself.static final int
Copy custom security rolemaps where present, otherwise always inherit. -
Constructor Summary
ConstructorDescriptionBlank 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
-
Field Details
-
COPY_INCLUDE_INTO
public static final int COPY_INCLUDE_INTOCopy 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_ONTOCopy 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_EXCLUDEExclude 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_SECURITYCopy custom security rolemaps where present, otherwise always inherit.- See Also:
-
COPY_EXCLUDE_VERSIONS
public static final int COPY_EXCLUDE_VERSIONSExclude 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_CREATORCopy 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_CREATEDCopy 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_INACTIVECopy 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_DEFAULTThis 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
CopySource with given source and default rule. -
CopySource
CopySource with given source and rule. -
CopySource
CopySource with given source and rule.
-
-
Method Details
-
getSource
Source id to copy. -
getRule
Copy rule. See COPY_ constants. -
setSource
- Parameters:
Source
- id to copy.
-
setRule
- Parameters:
Copy
- rule. See COPY_ constants.
-
setRule
public void setRule(int value) - Parameters:
Copy
- rule. See COPY_ constants.
-