Package ch.systemsx.cisd.openbis.dss.generic.shared.api.v1

Class ShareInfo

  • All Implemented Interfaces:
    java.io.Serializable
    @JsonObject("ShareInfo")
public class ShareInfo
extends java.lang.Object
implements java.io.Serializable
    Information about a share.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ShareInfo​(java.lang.String shareId, long freeSpace)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long getFreeSpace()  
      java.lang.String getShareId()  
      boolean isIgnoredForShuffling()
      Returns true if the share should not be used by shuffling maintenance or post-registration tasks.
      boolean isIncoming()
      Returns true if the share is associated with one or more incoming directories.
      boolean isWithdrawShare()
      Returns true if the share should be emptied by shuffling maintenance tasks.
      void setIgnoredForShuffling​(boolean ignoredForShuffling)  
      void setIncoming​(boolean incoming)  
      void setWithdrawShare​(boolean withdrawShare)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ShareInfo

        public ShareInfo​(java.lang.String shareId,
                 long freeSpace)

    • Method Detail

      • getShareId

        public java.lang.String getShareId()

      • getFreeSpace

        public long getFreeSpace()

      • isIncoming

        public boolean isIncoming()
        Returns true if the share is associated with one or more incoming directories.

      • setIncoming

        public void setIncoming​(boolean incoming)

      • isWithdrawShare

        public boolean isWithdrawShare()
        Returns true if the share should be emptied by shuffling maintenance tasks.

      • setWithdrawShare

        public void setWithdrawShare​(boolean withdrawShare)

      • isIgnoredForShuffling

        public boolean isIgnoredForShuffling()
        Returns true if the share should not be used by shuffling maintenance or post-registration tasks.

      • setIgnoredForShuffling

        public void setIgnoredForShuffling​(boolean ignoredForShuffling)