Class ExportOptions

    • Constructor Summary

      Constructors 
      Constructor Description
      ExportOptions()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getAcls()
      Gets whether ACLs of nodes are exported.
      boolean getAttributeInfo()
      Gets whether categories are exported.
      java.lang.String getCallbackHandlerName()
      Gets the callback handler to use.
      int getChildDepth()
      Gets the child depth of the heirarchy to export.
      ExportContent getContent()
      Gets how the content of documents is exported.
      boolean getExtUserInfo()
      Gets whether the creator, owner and group owner are exported.
      java.lang.Boolean getFollowAliases()
      Gets whether to follow aliases (shortcuts).
      java.lang.String getHandlerName()
      Gets the name of the export handler.
      java.lang.String getNameSpaceTag()
      Gets the namespace to pre-append to Content Server tags (when schema is enabled).
      boolean getNodeInfo()
      Gets whether the DAPINODE is exported.
      boolean getPermissions()
      Gets whether the creator/owner of nodes and ACLs are exported.
      boolean getSchema()
      Gets whether a link to the Content Server schema is added.
      ExportScope getScope()
      Gets the scope of a parent to export.
      java.lang.String getStyleSheet()
      Gets the stylesheet to apply to perform the transform (when transform is enabled).
      java.lang.String getTransform()
      Gets whether a transform will be performed on the exported content.
      ExportVersionInfo getVersionInfo()
      Gets the controls for the versions of documents.
      long getVersionNumber()
      Gets the specific version that is exported of a document.
      java.lang.String[] getXmlAttributes()
      Gets the list of strings that set which XML attriubtes to run during the export.
      java.lang.String getXmlAttributes​(int index)
      Gets the value at the specified index in the XmlAttributes array.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setAcls​(boolean value)
      Sets whether ACLs of nodes are exported.
      void setAttributeInfo​(boolean value)
      Sets whether categories are exported.
      void setCallbackHandlerName​(java.lang.String value)
      Sets the callback handler to use.
      void setChildDepth​(int value)
      Sets the child depth of the heirarchy to export.
      void setContent​(ExportContent value)
      Sets how the content of documents is exported.
      void setExtUserInfo​(boolean value)
      Sets whether the creator, owner and group owner are exported.
      void setFollowAliases​(java.lang.Boolean value)
      Sets whether to follow aliases (shortcuts).
      void setHandlerName​(java.lang.String value)
      Sets the name of the export handler.
      void setNameSpaceTag​(java.lang.String value)
      Sets the namespace to pre-append to Content Server tags (when schema is enabled).
      void setNodeInfo​(boolean value)
      Sets whether the DAPINODE is exported.
      void setPermissions​(boolean value)
      Sets whether the creator/owner of nodes and ACLs are exported.
      void setSchema​(boolean value)
      Sets whether a link to the Content Server schema is added.
      void setScope​(ExportScope value)
      Sets the scope of a parent to export.
      void setStyleSheet​(java.lang.String value)
      Sets the stylesheet to apply to perform the transform (when transform is enabled).
      void setTransform​(java.lang.String value)
      Sets whether a transform will be performed on the exported content.
      void setVersionInfo​(ExportVersionInfo value)
      Sets the controls for the versions of documents.
      void setVersionNumber​(long value)
      Sets the specific version that is exported of a document.
      void setXmlAttributes​(int index, java.lang.String value)
      Sets the value at the specified index in the fXmlAttributes array.
      void setXmlAttributes​(java.lang.String[] value)
      Sets the list of strings that set which XML attriubtes to run during the export.
      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

      • ExportOptions

        public ExportOptions()
    • Method Detail

      • setAcls

        public void setAcls​(boolean value)
        Sets whether ACLs of nodes are exported.
      • getAcls

        public boolean getAcls()
        Gets whether ACLs of nodes are exported.
      • setAttributeInfo

        public void setAttributeInfo​(boolean value)
        Sets whether categories are exported.
      • getAttributeInfo

        public boolean getAttributeInfo()
        Gets whether categories are exported.
      • setCallbackHandlerName

        public void setCallbackHandlerName​(java.lang.String value)
        Sets the callback handler to use.
      • getCallbackHandlerName

        public java.lang.String getCallbackHandlerName()
        Gets the callback handler to use.
      • setChildDepth

        public void setChildDepth​(int value)
        Sets the child depth of the heirarchy to export.
      • getChildDepth

        public int getChildDepth()
        Gets the child depth of the heirarchy to export.
      • setContent

        public void setContent​(ExportContent value)
        Sets how the content of documents is exported.
      • getContent

        public ExportContent getContent()
        Gets how the content of documents is exported.
      • setExtUserInfo

        public void setExtUserInfo​(boolean value)
        Sets whether the creator, owner and group owner are exported. Can only be used when nodeInfo is true.
      • getExtUserInfo

        public boolean getExtUserInfo()
        Gets whether the creator, owner and group owner are exported. Can only be used when nodeInfo is true.
      • setFollowAliases

        public void setFollowAliases​(java.lang.Boolean value)
        Sets whether to follow aliases (shortcuts).
      • getFollowAliases

        public java.lang.Boolean getFollowAliases()
        Gets whether to follow aliases (shortcuts).
      • setHandlerName

        public void setHandlerName​(java.lang.String value)
        Sets the name of the export handler.
      • getHandlerName

        public java.lang.String getHandlerName()
        Gets the name of the export handler.
      • setNameSpaceTag

        public void setNameSpaceTag​(java.lang.String value)
        Sets the namespace to pre-append to Content Server tags (when schema is enabled). This is the XML namespace the Content Server tags belong to.
      • getNameSpaceTag

        public java.lang.String getNameSpaceTag()
        Gets the namespace to pre-append to Content Server tags (when schema is enabled). This is the XML namespace the Content Server tags belong to.
      • setNodeInfo

        public void setNodeInfo​(boolean value)
        Sets whether the DAPINODE is exported. Required for exported content will be imported.
      • getNodeInfo

        public boolean getNodeInfo()
        Gets whether the DAPINODE is exported. Required for exported content will be imported.
      • setPermissions

        public void setPermissions​(boolean value)
        Sets whether the creator/owner of nodes and ACLs are exported.
      • getPermissions

        public boolean getPermissions()
        Gets whether the creator/owner of nodes and ACLs are exported.
      • setSchema

        public void setSchema​(boolean value)
        Sets whether a link to the Content Server schema is added.
      • getSchema

        public boolean getSchema()
        Gets whether a link to the Content Server schema is added.
      • setScope

        public void setScope​(ExportScope value)
        Sets the scope of a parent to export. This overrides ChildDepth if it is used.
      • getScope

        public ExportScope getScope()
        Gets the scope of a parent to export. This overrides ChildDepth if it is used.
      • setStyleSheet

        public void setStyleSheet​(java.lang.String value)
        Sets the stylesheet to apply to perform the transform (when transform is enabled).
      • getStyleSheet

        public java.lang.String getStyleSheet()
        Gets the stylesheet to apply to perform the transform (when transform is enabled).
      • setTransform

        public void setTransform​(java.lang.String value)
        Sets whether a transform will be performed on the exported content.
      • getTransform

        public java.lang.String getTransform()
        Gets whether a transform will be performed on the exported content.
      • setVersionInfo

        public void setVersionInfo​(ExportVersionInfo value)
        Sets the controls for the versions of documents. This overrides VersionNumber if it is used.
      • getVersionInfo

        public ExportVersionInfo getVersionInfo()
        Gets the controls for the versions of documents. This overrides VersionNumber if it is used.
      • setVersionNumber

        public void setVersionNumber​(long value)
        Sets the specific version that is exported of a document.
      • getVersionNumber

        public long getVersionNumber()
        Gets the specific version that is exported of a document.
      • setXmlAttributes

        public void setXmlAttributes​(java.lang.String[] value)
        Sets the list of strings that set which XML attriubtes to run during the export. XmlAttributes are used to add content on a per node basis.
      • getXmlAttributes

        public java.lang.String[] getXmlAttributes()
        Gets the list of strings that set which XML attriubtes to run during the export. XmlAttributes are used to add content on a per node basis.
      • setXmlAttributes

        public void setXmlAttributes​(int index,
                                     java.lang.String value)
        Sets the value at the specified index in the fXmlAttributes array.
      • getXmlAttributes

        public java.lang.String getXmlAttributes​(int index)
        Gets the value at the specified index in the XmlAttributes array.
      • 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