Package com.priint.pubserver.comet.bridge.toc

Interface CometTableOfContentsRemote

  • public interface CometTableOfContentsRemote
    Remote interface to access the comet table of contents bean from external JVM.

    This is intended for testing purposes only and maybe removed or changed without notice.

    For all normal work please use CometTableOfContentsLocal interface instead.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ENTITY_IDENTIFIER
      The Constant ENTITY_IDENTIFIER: "comet_toc"
      static java.lang.String JNDINAME
      The Constant JNDINAME: "java:global/CometTableOfContents/CometTableOfContentsRemoteEntryPoint!com.priint.pubserver.comet.bridge.toc.CometTableOfContentsRemote"
      static java.lang.String MAPPED_NAME
      The Constant MAPPED_NAME: "com.priint.pubserver.comet.bridge.toc.CometTableOfContentsRemote"

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addCometTocEntry​(java.lang.String sessionId, CometTocEntry entry)
      Add a single table of contents entry.
      Note: the database should be cleared before, e.g.
      void clearAndAddCometTocEntries​(java.lang.String sessionId, java.lang.String document, java.lang.String path, java.lang.String publication, java.lang.String publicationPlannerId, java.lang.String layerList, java.lang.String placeholderList, java.util.List<CometTocEntry> entries)
      Add a list of CometTocEntries.
      java.util.List<CometTocEntry> deleteCometTocEntries​(java.lang.String sessionId, java.lang.String project)
      Delete all the toc entries of the given project.
      java.util.List<CometTocEntry> deleteCometTocEntries​(java.lang.String sessionId, java.lang.String document, java.lang.String path, java.lang.String publication, java.lang.String publicationPlannerId, java.lang.String layerList, java.lang.String placeholderList)
      Delete table of contents entries of a certain document.
      If a (comma separated) list of layers is provided: delete only entries of these layers.
      If a (comma separated) list of placeholders is provided: delete only entries of these placeholders.
      void deleteCometTocEntries​(java.lang.String sessionId, java.util.List<java.lang.String> entryIDs)
      Deletes toc entries refered by ID.
      java.util.List<CometTocEntry> getDocumentTocEntries​(java.lang.String sessionId, java.lang.String document, java.lang.String path, java.lang.String publication, java.lang.String publicationPlannerId, java.lang.String layerList, java.lang.String placeholderList)
      Get the table of contents entries of a certain document.
      If a (comma separated) list of layers is provided: query only entries of these layers.
      If a (comma separated) list of placeholders is provided: query only entries of these placeholders.
      java.util.List<CometTocEntry> getEntityTocEntries​(java.lang.String sessionId, java.lang.String document, java.lang.String path, java.lang.String publication, java.lang.String publicationPlannerId, java.lang.String entityIdentifier, java.lang.String recordIdentifier, java.lang.String recordGroupId, java.lang.String entityClass, java.lang.String parentEntityId, java.lang.String parentRecordIdentifier, java.lang.String parentRecordGroupId, java.lang.String parentEntityClass, Context context, java.lang.String layerList, java.lang.String placeholderList)
      Get toc entries for a specific document and product.
      To find these entries, all the values required to identify a document AND the product must be provided, so this method has a couple of parameters.
      Some values may be implied by others: e.g.
      java.util.List<CometTocEntry> getProjectTocEntries​(java.lang.String sessionId, java.lang.String project)
      Get all the toc entries of the given project.

    • Field Detail

      • ENTITY_IDENTIFIER

        static final java.lang.String ENTITY_IDENTIFIER
        The Constant ENTITY_IDENTIFIER: "comet_toc"
        See Also:
        Constant Field Values

      • JNDINAME

        static final java.lang.String JNDINAME
        The Constant JNDINAME: "java:global/CometTableOfContents/CometTableOfContentsRemoteEntryPoint!com.priint.pubserver.comet.bridge.toc.CometTableOfContentsRemote"
        See Also:
        Constant Field Values

      • MAPPED_NAME

        static final java.lang.String MAPPED_NAME
        The Constant MAPPED_NAME: "com.priint.pubserver.comet.bridge.toc.CometTableOfContentsRemote"
        See Also:
        Constant Field Values

    • Method Detail

      • addCometTocEntry

        void addCometTocEntry​(java.lang.String sessionId,
                      CometTocEntry entry)
               throws PubServerException
        Add a single table of contents entry.
        Note: the database should be cleared before, e.g. by calling deleteCometTocEntries before.
        Parameters:
        sessionId - the session id
        entry - the entry
        Throws:
        PubServerException - the pub server exception

      • clearAndAddCometTocEntries

        void clearAndAddCometTocEntries​(java.lang.String sessionId,
                                java.lang.String document,
                                java.lang.String path,
                                java.lang.String publication,
                                java.lang.String publicationPlannerId,
                                java.lang.String layerList,
                                java.lang.String placeholderList,
                                java.util.List<CometTocEntry> entries)
                         throws PubServerException
        Add a list of CometTocEntries. This method will clear all existing entries of this document (in the specified layers / of the specified placeholders) before.
        Parameters:
        sessionId - the session id
        document - the document
        path - the path
        publication - the publication
        publicationPlannerId - the publication planner id
        layerList - the layer list
        placeholderList - the placeholder list
        entries - the entries
        Throws:
        PubServerException - the pub server exception

      • deleteCometTocEntries

        java.util.List<CometTocEntry> deleteCometTocEntries​(java.lang.String sessionId,
                                                    java.lang.String project)
                                             throws PubServerException
        Delete all the toc entries of the given project.
        Parameters:
        sessionId - the session id
        project - the project
        Returns:
        the list
        Throws:
        PubServerException - the pub server exception

      • deleteCometTocEntries

        void deleteCometTocEntries​(java.lang.String sessionId,
                           java.util.List<java.lang.String> entryIDs)
                    throws PubServerException

        Deletes toc entries refered by ID.

        Deletes all toc entries by ID passed as argument.
        If a toc entry with one ID specified in the list cannot be found or is ambiguous, an Exception is thrown.

        Parameters:
        sessionId - the session id
        entryIDs - list of valid toc entry IDs
        Throws:
        PubServerException - the pub server exception

      • deleteCometTocEntries

        java.util.List<CometTocEntry> deleteCometTocEntries​(java.lang.String sessionId,
                                                    java.lang.String document,
                                                    java.lang.String path,
                                                    java.lang.String publication,
                                                    java.lang.String publicationPlannerId,
                                                    java.lang.String layerList,
                                                    java.lang.String placeholderList)
                                             throws PubServerException
        Delete table of contents entries of a certain document.
        If a (comma separated) list of layers is provided: delete only entries of these layers.
        If a (comma separated) list of placeholders is provided: delete only entries of these placeholders.
        Parameters:
        sessionId - the session id
        document - the document
        path - the path
        publication - the publication
        publicationPlannerId - the publication planner id
        layerList - the layer list
        placeholderList - the placeholder list
        Returns:
        the list
        Throws:
        PubServerException - the pub server exception

      • getDocumentTocEntries

        java.util.List<CometTocEntry> getDocumentTocEntries​(java.lang.String sessionId,
                                                    java.lang.String document,
                                                    java.lang.String path,
                                                    java.lang.String publication,
                                                    java.lang.String publicationPlannerId,
                                                    java.lang.String layerList,
                                                    java.lang.String placeholderList)
                                             throws PubServerException
        Get the table of contents entries of a certain document.
        If a (comma separated) list of layers is provided: query only entries of these layers.
        If a (comma separated) list of placeholders is provided: query only entries of these placeholders.
        Parameters:
        sessionId - the session id
        document - the document
        path - the path
        publication - the publication
        publicationPlannerId - the publication planner id
        layerList - the layer list
        placeholderList - the placeholder list
        Returns:
        the document toc entries
        Throws:
        PubServerException - the pub server exception

      • getEntityTocEntries

        java.util.List<CometTocEntry> getEntityTocEntries​(java.lang.String sessionId,
                                                  java.lang.String document,
                                                  java.lang.String path,
                                                  java.lang.String publication,
                                                  java.lang.String publicationPlannerId,
                                                  java.lang.String entityIdentifier,
                                                  java.lang.String recordIdentifier,
                                                  java.lang.String recordGroupId,
                                                  java.lang.String entityClass,
                                                  java.lang.String parentEntityId,
                                                  java.lang.String parentRecordIdentifier,
                                                  java.lang.String parentRecordGroupId,
                                                  java.lang.String parentEntityClass,
                                                  Context context,
                                                  java.lang.String layerList,
                                                  java.lang.String placeholderList)
                                           throws PubServerException
        Get toc entries for a specific document and product.
        To find these entries, all the values required to identify a document AND the product must be provided, so this method has a couple of parameters.
        Some values may be implied by others: e.g. the context language may be encoded in the layer name, so you don't have to provide both.
        Parameters:
        sessionId - the session id
        document - the document
        path - the path
        publication - the publication
        publicationPlannerId - the publication planner id
        entityIdentifier - the entity identifier
        recordIdentifier - the record identifier
        recordGroupId - the record group id
        entityClass - the entity class
        parentEntityId - the parent entity id
        parentRecordIdentifier - the parent record identifier
        parentRecordGroupId - the parent record group id
        parentEntityClass - the parent entity class
        context - the context
        layerList - the layer list
        placeholderList - the placeholder list
        Returns:
        the entity toc entries
        Throws:
        PubServerException - the pub server exception

      • getProjectTocEntries

        java.util.List<CometTocEntry> getProjectTocEntries​(java.lang.String sessionId,
                                                   java.lang.String project)
                                            throws PubServerException
        Get all the toc entries of the given project.
        Parameters:
        sessionId - the session id
        project - the project
        Returns:
        the project toc entries
        Throws:
        PubServerException - the pub server exception