Package org.apache.manifoldcf.crawler.connectors.csws

Class CswsConnector.ObjectInformation

  • Enclosing class:
    CswsConnector
    protected class CswsConnector.ObjectInformation
extends java.lang.Object
    This object represents an object information cache. Initialize it with the volume ID and object ID, and then request the appropriate fields from it. Keep it around as long as needed; it functions as a cache of sorts...

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean fetched  
      protected long objectID  
      protected com.opentext.livelink.service.docman.Node objectValue  
      protected java.lang.String workspaceName  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      boolean exists()
      Check whether object seems to exist or not.
      java.util.List<? extends com.opentext.livelink.service.docman.AttributeGroup> getAttributeGroups()
      Get AttributeGroups
      long getCategoryId​(java.lang.String startPath)
      Returns the category ID specified by the path name.
      java.lang.String getComments()
      Get OpenText comments/description.
      java.util.Date getCreationDate()
      Get creation date.
      java.lang.Long getCreatorId()
      Get creator ID.
      java.util.Date getModifyDate()  
      java.lang.String getName()
      Get OpenText document name.
      long[] getObjectCategoryIDs()
      Get category IDs available to the object with a specified object ID
      protected com.opentext.livelink.service.docman.Node getObjectValue()
      Get the objInfo object.
      java.lang.Long getParentId()
      Get parent ID.
      java.lang.Long getPathId​(java.lang.String startPath)
      Returns the object ID specified by the path name.
      com.opentext.livelink.service.docman.NodePermissions getPermissions()
      Get permissions.
      boolean getSpecifiedCategoryAttribute​(org.apache.manifoldcf.agents.interfaces.RepositoryDocument rd, long catID, java.lang.String catName)
      Fetch attribute value for a specified categoryID for a given object.
      java.lang.String getWorkspaceName()
      Get workspace name
      int hashCode()  
      java.lang.String toString()
      toString override

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • objectID

        protected final long objectID

      • workspaceName

        protected final java.lang.String workspaceName

      • objectValue

        protected com.opentext.livelink.service.docman.Node objectValue

      • fetched

        protected boolean fetched

    • Constructor Detail

      • ObjectInformation

        public ObjectInformation​(long objectID)

      • ObjectInformation

        public ObjectInformation​(java.lang.String workspaceName)

    • Method Detail

      • getWorkspaceName

        public java.lang.String getWorkspaceName()
        Get workspace name

      • exists

        public boolean exists()
               throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                      org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Check whether object seems to exist or not.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • toString

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

      • getSpecifiedCategoryAttribute

        public boolean getSpecifiedCategoryAttribute​(org.apache.manifoldcf.agents.interfaces.RepositoryDocument rd,
                                             long catID,
                                             java.lang.String catName)
                                      throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                             org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Fetch attribute value for a specified categoryID for a given object.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getPathId

        public java.lang.Long getPathId​(java.lang.String startPath)
                         throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Returns the object ID specified by the path name.
        Parameters:
        startPath - is the folder name (a string with dots as separators)
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getAttributeGroups

        public java.util.List<? extends com.opentext.livelink.service.docman.AttributeGroup> getAttributeGroups()
                                                                                                 throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                                        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        Get AttributeGroups
        Throws:
        org.apache.manifoldcf.core.interfaces.ManifoldCFException
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption

      • getObjectCategoryIDs

        public long[] getObjectCategoryIDs()
                            throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                   org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        Get category IDs available to the object with a specified object ID
        Throws:
        org.apache.manifoldcf.core.interfaces.ManifoldCFException
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption

      • getCategoryId

        public long getCategoryId​(java.lang.String startPath)
                   throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                          org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        Returns the category ID specified by the path name.
        Parameters:
        startPath - is the folder name, ending in a category name (a string with slashes as separators)
        Throws:
        org.apache.manifoldcf.core.interfaces.ManifoldCFException
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption

      • getPermissions

        public com.opentext.livelink.service.docman.NodePermissions getPermissions()
                                                                    throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                                                           org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Get permissions.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getName

        public java.lang.String getName()
                         throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Get OpenText document name.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getComments

        public java.lang.String getComments()
                             throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                    org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Get OpenText comments/description.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getParentId

        public java.lang.Long getParentId()
                           throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                  org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Get parent ID.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getCreationDate

        public java.util.Date getCreationDate()
                               throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                      org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Get creation date.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getCreatorId

        public java.lang.Long getCreatorId()
                            throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                   org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Get creator ID.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getModifyDate

        public java.util.Date getModifyDate()
                             throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                    org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • getObjectValue

        protected com.opentext.livelink.service.docman.Node getObjectValue()
                                                            throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                                                   org.apache.manifoldcf.core.interfaces.ManifoldCFException
        Get the objInfo object.
        Throws:
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        org.apache.manifoldcf.core.interfaces.ManifoldCFException

      • hashCode

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

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object