Package org.alfresco.filesys.alfresco

Class DesktopParams

  • public class DesktopParams
extends java.lang.Object
    Desktop Parameters Class

    Contains the parameters for a desktop action request from the client side application.

    Author:
    gkspencer

    • Constructor Summary

      Constructors 
      Constructor Description
      DesktopParams()
      Default constructor
      DesktopParams​(org.alfresco.jlan.server.SrvSession sess, org.alfresco.service.cmr.repository.NodeRef folderNode, org.alfresco.jlan.server.filesys.NetworkFile folderFile)
      Class constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addTarget​(DesktopTarget target)
      Add a target node for the action
      org.alfresco.jlan.server.filesys.NetworkFile getFolder()
      Return the folder network file
      org.alfresco.service.cmr.repository.NodeRef getFolderNode()
      Return the working directory node
      org.alfresco.jlan.server.SrvSession getSession()
      Return the file server session
      DesktopTarget getTarget​(int idx)
      Return the required target
      java.lang.String getTicket()
      Return the authentication ticket for the user/session
      int numberOfTargetNodes()
      Return the count of target nodes for the action
      void setFolder​(org.alfresco.jlan.server.filesys.NetworkFile netFile)
      Set the folder network file
      java.lang.String toString()
      Return the desktop parameters as a string

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DesktopParams

        public DesktopParams()
        Default constructor

      • DesktopParams

        public DesktopParams​(org.alfresco.jlan.server.SrvSession sess,
                     org.alfresco.service.cmr.repository.NodeRef folderNode,
                     org.alfresco.jlan.server.filesys.NetworkFile folderFile)
        Class constructor
        Parameters:
        sess - SrvSession
        folderNode - NodeRef
        folderFile - NetworkFile

    • Method Detail

      • numberOfTargetNodes

        public final int numberOfTargetNodes()
        Return the count of target nodes for the action
        Returns:
        int

      • getSession

        public final org.alfresco.jlan.server.SrvSession getSession()
        Return the file server session
        Returns:
        SrvSession

      • getTicket

        public final java.lang.String getTicket()
        Return the authentication ticket for the user/session
        Returns:
        String

      • getFolderNode

        public final org.alfresco.service.cmr.repository.NodeRef getFolderNode()
        Return the working directory node
        Returns:
        NodeRef

      • getFolder

        public final org.alfresco.jlan.server.filesys.NetworkFile getFolder()
        Return the folder network file
        Returns:
        NetworkFile

      • setFolder

        public final void setFolder​(org.alfresco.jlan.server.filesys.NetworkFile netFile)
        Set the folder network file
        Parameters:
        netFile - NetworkFile

      • getTarget

        public final DesktopTarget getTarget​(int idx)
        Return the required target
        Parameters:
        idx - int
        Returns:
        DesktopTarget

      • addTarget

        public final void addTarget​(DesktopTarget target)
        Add a target node for the action
        Parameters:
        target - DesktopTarget

      • toString

        public java.lang.String toString()
        Return the desktop parameters as a string
        Overrides:
        toString in class java.lang.Object
        Returns:
        String