Class FolderId

  • All Implemented Interfaces:
    java.io.Serializable

    public class FolderId
    extends java.lang.Object
    implements java.io.Serializable
    Identifies a folder on the backend system.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ROOT
      Root folder id.
    • Constructor Summary

      Constructors 
      Constructor Description
      FolderId​(java.lang.String objectId, java.lang.String ddcName)
      Creates a new FolderId.
      FolderId​(java.lang.String objectId, java.lang.String revisionId, java.lang.String ddcName)
      Creates a new FolderId.
    • Constructor Detail

      • FolderId

        public FolderId​(java.lang.String objectId,
                        java.lang.String ddcName)
        Creates a new FolderId.
        Parameters:
        objectId - object ID of the folder. This corresponds with the SysRowId.
        ddcName - ddc name
      • FolderId

        public FolderId​(java.lang.String objectId,
                        java.lang.String revisionId,
                        java.lang.String ddcName)
        Creates a new FolderId.
        Parameters:
        objectId - object ID of the document. This corresponds with the SysRowId.
        revisionId - revision ID of the document. This corresponds with the HDOC.
        ddcName - ddc name
    • Method Detail

      • getObjectId

        public java.lang.String getObjectId()
        Returns:
        object ID of the document. This corresponds with the SysRowId. Never null.
      • getRevisionId

        public java.lang.String getRevisionId()
        Returns:
        revision ID of the document or null if not available. This corresponds with the HDOC.
      • getDdcName

        public java.lang.String getDdcName()
        Returns:
        DDC name or null if not set.
      • getName

        public final java.lang.String getName()
        Returns:
        the name
      • setName

        public final void setName​(java.lang.String value)
        Parameters:
        value - the name to set
      • getPath

        public final java.lang.String getPath()
        Returns:
        the path
      • setPath

        public final void setPath​(java.lang.String value)
        Parameters:
        value - the path to set
      • getType

        public final com.saperion.constants.SaFolderConstants.FOLDER_TYPE getType()
        Returns:
        the type
      • setType

        public final void setType​(com.saperion.constants.SaFolderConstants.FOLDER_TYPE value)
        Parameters:
        value - the type to set
      • convertToObjectIdList

        public static final java.util.List<java.lang.String> convertToObjectIdList​(java.util.List<FolderId> list)
        Converts to a list of object id's.
        Parameters:
        list - Input
        Returns:
        List of object id's
      • convertToRevisionIdList

        public static final java.util.List<java.lang.String> convertToRevisionIdList​(java.util.List<FolderId> list)
        /**Converts to a list of revision id's.
        Parameters:
        list - Input
        Returns:
        List of revision id's
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • getSimpleString

        public java.lang.String getSimpleString()
        Returns:
        DDC + object id
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object