Package com.opentext.livelink.service.docman

Class CopyOptions

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable
    public class CopyOptions
extends ServiceDataObject
implements java.io.Serializable
    CopyOptions is used to specify the options to copy an object with using CopyNode of the document management service.
    Version:
    2013-08-26
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      CopyOptions()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getAddVersion()
      Gets whether the current version of the node to copy is copied as the latest version.
      AttributeSourceType getAttrSourceType()
      Gets whether the copied node gets the original or destination parent categories or both (merge).
      boolean getCopyCurrent()
      Gets whether to copy only the current version of the node.
      boolean getCurrentUserAsOwner()
      Gets whether to use the currently authenticated user as the creator of the node created by the copy operation.
      boolean getKeepReservedState()
      Gets whether the copied node will keep its reserved state.
      boolean getKeepVersionLocks()
      Gets whether all copied versions will keep their Locked state.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setAddVersion​(boolean value)
      Sets whether the current version of the node to copy is copied as the latest version.
      void setAttrSourceType​(AttributeSourceType value)
      Sets whether the copied node gets the original or destination parent categories or both (merge).
      void setCopyCurrent​(boolean value)
      Sets whether to copy only the current version of the node.
      void setCurrentUserAsOwner​(boolean value)
      Sets whether to use the currently authenticated user as the creator of the node created by the copy operation.
      void setKeepReservedState​(boolean value)
      Sets whether the copied node will keep its reserved state.
      void setKeepVersionLocks​(boolean value)
      Sets whether all copied versions will keep their Locked state.
      com.opentext.api.LLValue toLLValue()
      Serialize an SDO object to an LLValue that can be sent to Livelink.
      java.lang.String toString()
      Returns a string representation of the object consisting of the object name and any features and their values within square brackets.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • CopyOptions

        public CopyOptions()

    • Method Detail

      • setAddVersion

        public void setAddVersion​(boolean value)
        Sets whether the current version of the node to copy is copied as the latest version.

      • getAddVersion

        public boolean getAddVersion()
        Gets whether the current version of the node to copy is copied as the latest version.

      • setAttrSourceType

        public void setAttrSourceType​(AttributeSourceType value)
        Sets whether the copied node gets the original or destination parent categories or both (merge).

      • getAttrSourceType

        public AttributeSourceType getAttrSourceType()
        Gets whether the copied node gets the original or destination parent categories or both (merge).

      • setCopyCurrent

        public void setCopyCurrent​(boolean value)
        Sets whether to copy only the current version of the node.

      • getCopyCurrent

        public boolean getCopyCurrent()
        Gets whether to copy only the current version of the node.

      • setCurrentUserAsOwner

        public void setCurrentUserAsOwner​(boolean value)
        Sets whether to use the currently authenticated user as the creator of the node created by the copy operation.

      • getCurrentUserAsOwner

        public boolean getCurrentUserAsOwner()
        Gets whether to use the currently authenticated user as the creator of the node created by the copy operation.

      • setKeepReservedState

        public void setKeepReservedState​(boolean value)
        Sets whether the copied node will keep its reserved state.

      • getKeepReservedState

        public boolean getKeepReservedState()
        Gets whether the copied node will keep its reserved state.

      • setKeepVersionLocks

        public void setKeepVersionLocks​(boolean value)
        Sets whether all copied versions will keep their Locked state.

      • getKeepVersionLocks

        public boolean getKeepVersionLocks()
        Gets whether all copied versions will keep their Locked state.

      • load

        public void load​(com.opentext.api.LLValue value)
        Description copied from interface: IServiceDataObject
        Deserialize an ServiceDataObject from an LLValue that is received from Livelink. The LLValue is an Assoc that contains all of the features of this SDO. These features may refer to other SDOs and contain arrays of primitive values or SDOs. Each referenced SDO, will have its load() method called as well. Note: this is an internal method not meant to be called by clients.
        Specified by:
        load in interface IServiceDataObject
        Overrides:
        load in class ServiceDataObject
        Parameters:
        value - the LLValue containing the data to be loaded

      • toLLValue

        public com.opentext.api.LLValue toLLValue()
        Description copied from interface: IServiceDataObject
        Serialize an SDO object to an LLValue that can be sent to Livelink. Each feature of the SDO is stored in a key of the LLValue Assoc. Any references to other SDOs cause their toLLValue() method to be called. Note: this is an internal method not meant to be called by clients.
        Specified by:
        toLLValue in interface IServiceDataObject
        Overrides:
        toLLValue in class ServiceDataObject
        Returns:
        Returns the LLValue object that represents this SDO

      • toString

        public java.lang.String toString()
        Description copied from class: ServiceDataObject
        Returns a string representation of the object consisting of the object name and any features and their values within square brackets. Intended for simple debugging or logging of an SDO.
        Overrides:
        toString in class ServiceDataObject