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

Interface CometTableOfContentsLocal

public interface CometTableOfContentsLocal
The Interface CometTableOfContentsLocal.

  • Field Details

  • Method Details

    • addCometTocEntry

      void addCometTocEntry(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:
      entry - the entry
      Throws:
      PubServerException - the pub server exception

    • clearAndAddCometTocEntries

      void clearAndAddCometTocEntries(String document, String path, String publication, String publicationPlannerId, String layerList, String placeholderList, 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:
      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

      List<CometTocEntry> deleteCometTocEntries(String project) throws PubServerException
      Delete all the toc entries of the given project.
      Parameters:
      project - the project
      Returns:
      the list
      Throws:
      PubServerException - the pub server exception

    • deleteCometTocEntries

      void deleteCometTocEntries(List<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:
      entryIDs - list of valid toc entry IDs
      Throws:
      PubServerException - the pub server exception

    • deleteCometTocEntries

      List<CometTocEntry> deleteCometTocEntries(String document, String path, String publication, String publicationPlannerId, String layerList, 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:
      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

      List<CometTocEntry> getDocumentTocEntries(String document, String path, String publication, String publicationPlannerId, String layerList, 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:
      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

      List<CometTocEntry> getEntityTocEntries(String document, String path, String publication, String publicationPlannerId, String entityIdentifier, String recordIdentifier, String recordGroupId, String entityClass, String parentEntityId, String parentRecordIdentifier, String parentRecordGroupId, String parentEntityClass, Context context, String layerList, 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:
      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

      List<CometTocEntry> getProjectTocEntries(String project) throws PubServerException
      Get all the toc entries of the given project.
      Parameters:
      project - the project
      Returns:
      the project toc entries
      Throws:
      PubServerException - the pub server exception