Package unlimited.fc.server.api

Class FolderGroupCanAccess

  • public class FolderGroupCanAccess
extends LinkState

    Title: FileCatalyst Direct Server API

    Description: Class that holds a VIEW of a folder a group has access to. Permissions are not modifiable via this object, nor are they persisted. Calls to the Server API need to be made in order to modify on the server any permission set. Allows viewing/editing of permissions by API caller without exposing the inner permission classes.

    Copyright: Copyright (c) 2013

    Company: Unlimi-Tech Software Inc.

    Since:
    v3.1
    Version:
    1.0
    Author:
    Christian Charette, ccharette

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Custom equals method for this object
      java.lang.String getDescription()
      Return the virtual folder description
      java.lang.String getFolder()
      Return the folder name (not label, but database PK) to identify folder in question
      java.lang.String getGroup()
      Return the group name
      java.lang.String getLabel()
      Return the folder label to identify folder in question.
      java.lang.String getName()
      Return the folder name (not label, but database PK) to identify folder in question
      java.lang.String getPath()
      Return the folder path (real system path) which to which the Virtual Folder points to.
      int getPermission()
      Return permission set to group (as int value -- see PermissionsContainer.generatePermission() to translate into boolean values)
      int hashCode()
      Custom hash-code method for this object
      java.lang.String toString()
      Write out FolderGroupCanAccess object to string.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • getGroup

        public java.lang.String getGroup()
        Return the group name
        Returns:
        group Name

      • getFolder

        public java.lang.String getFolder()
        Return the folder name (not label, but database PK) to identify folder in question
        Returns:
        Folder Name

      • getPermission

        public int getPermission()
        Return permission set to group (as int value -- see PermissionsContainer.generatePermission() to translate into boolean values)
        Returns:
        the permission granted to the group.

      • toString

        public java.lang.String toString()
        Write out FolderGroupCanAccess object to string. Used for debugging.
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()

      • getName

        public java.lang.String getName()
        Return the folder name (not label, but database PK) to identify folder in question
        Specified by:
        getName in class LinkState
        Returns:
        Folder Name

      • getLabel

        public java.lang.String getLabel()
        Return the folder label to identify folder in question. This is the sub-directory link presented to the user when it appears on their home directory.
        Returns:
        Folder label

      • getPath

        public java.lang.String getPath()
        Return the folder path (real system path) which to which the Virtual Folder points to. ie: C:/tmp/. Forward slashes are returned even on Windows machines.
        Returns:
        Folder path

      • getDescription

        public java.lang.String getDescription()
        Return the virtual folder description
        Returns:
        Virtual Folder description

      • hashCode

        public int hashCode()
        Custom hash-code method for this object
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Custom equals method for this object
        Overrides:
        equals in class java.lang.Object