Class TargetDocumentDescriptor


  • public class TargetDocumentDescriptor
    extends Object
    Descriptor for specifying a reference to the document into which an office document is going to be saved.
    Since:
    2.2M1
    Version:
    $Id: 769ff621a462d6f3a2101b831f00bb4de19bda31 $
    • Constructor Detail

      • TargetDocumentDescriptor

        public TargetDocumentDescriptor​(org.xwiki.model.reference.DocumentReference documentReference,
                                        org.xwiki.component.manager.ComponentManager componentManager)
        Creates a new TargetDocumentDescriptor instance.
        Parameters:
        documentReference - reference of the target document
        componentManager - used to lookup the entity reference serializer
    • Method Detail

      • getDocumentReference

        public org.xwiki.model.reference.DocumentReference getDocumentReference()
        Returns:
        target document reference name.
      • getDocumentReferenceAsString

        public String getDocumentReferenceAsString()
        Returns:
        target document reference as a string.
      • getParentReference

        public org.xwiki.model.reference.DocumentReference getParentReference()
        Returns:
        target parent document reference
      • getParentReferenceAsString

        public String getParentReferenceAsString()
        Returns:
        name of the parent document reference
      • setParentReference

        public void setParentReference​(org.xwiki.model.reference.DocumentReference parentReference)
        Sets the name of the parent document reference.
        Parameters:
        parentReference - parent document reference
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object