Package com.priint.pubserver.comet.bridge.snippet

Interface CometSnippetPluginLocal

  • public interface CometSnippetPluginLocal
    The interface Comet snippet plugin local.

    • Field Detail

      • JNDINAME

        static final java.lang.String JNDINAME
        The constant JNDINAME.
        See Also:
        Constant Field Values

      • MAPPED_NAME

        static final java.lang.String MAPPED_NAME
        The constant MAPPED_NAME.
        See Also:
        Constant Field Values

    • Method Detail

      • getSnippets

        @Deprecated
java.util.List<CometSnippet> getSnippets​(java.lang.String document,
                                         java.lang.String path,
                                         java.lang.String publication,
                                         java.lang.String publicationPlannerId,
                                         java.lang.String publicationType,
                                         java.util.List<java.lang.String> entityIdentifiers,
                                         java.util.List<java.lang.String> recordIdentifiers,
                                         java.util.List<java.lang.String> recordGroupIds,
                                         java.util.List<java.lang.String> entityClasses,
                                         java.util.List<java.lang.String> parentEntityIdentifiers,
                                         java.util.List<java.lang.String> parentRecordIdentifiers,
                                         java.util.List<java.lang.String> parentRecordGroupIds,
                                         java.util.List<java.lang.String> parentEntityClasses,
                                         java.util.List<java.lang.String> recordStringIds,
                                         Context context,
                                         java.util.List<java.lang.Integer> templateIds)
                                  throws PubServerException
        Deprecated.
        Replaced by getSnippets(FileRequestParameters)
        Gets snippets.
        Parameters:
        document - the document
        path - the path
        publication - the publication
        publicationPlannerId - the publication planner id
        publicationType - the publication type
        entityIdentifiers - the entity identifiers
        recordIdentifiers - the record identifiers
        recordGroupIds - the record group ids
        entityClasses - the entity classes
        parentEntityIdentifiers - the parent entity identifiers
        parentRecordIdentifiers - the parent record identifiers
        parentRecordGroupIds - the parent record group ids
        parentEntityClasses - the parent entity classes
        recordStringIds - the record string ids
        context - the context
        templateIds - the template ids
        Returns:
        snippets
        Throws:
        PubServerException - the pub server exception

      • getSnippets

        java.util.List<CometSnippet> getSnippets​(FileRequestParameters parameters)
                                  throws CometException

        Gets snippets according to the criteria provided with FileRequestParameters

        This method is based on the predefined NamedQueries in CometSnippet class, thus search criteria is limited to the ones supported by the respective queries.

        Parameters:
        parameters - request parameters encapsulated in FileRequestParameters object
        Returns:
        list of snippets matching the criteria
        Throws:
        CometException - the comet exception

      • findSnippets

        java.util.List<CometSnippet> findSnippets​(FileRequestParameters parameters)
                                   throws CometException

        Gets a list of snippets matching the criteria provided with FileRequestParameters

        Unlinke the getSnippets(FileRequestParameters) method, the query is assembled dynamically according to the given criteria and search flags.
        Any combination of search criteria is supported, or no criteria, which results in all snippets:

        Parameters:
        parameters - request parameters encapsulated in FileRequestParameters object
        Returns:
        list of snippets matching the criteria
        Throws:
        CometException - the comet exception

      • getSnippetsByProjectNameAndTemplateId

        java.util.List<CometSnippet> getSnippetsByProjectNameAndTemplateId​(java.lang.String projectIdentifier,
                                                                   int templateId)
                                                            throws CometException
        Gets snippets by project name and template id.
        Parameters:
        projectIdentifier - the project identifier
        templateId - the template id
        Returns:
        the snippets by project name and template id
        Throws:
        CometException - the comet exception

      • getSnippetsByDocumentId

        java.util.List<CometSnippet> getSnippetsByDocumentId​(java.lang.String projectIdentifier,
                                                     java.lang.String documentId)
                                              throws CometException
        Gets snippets by document id.
        Parameters:
        projectIdentifier - the project identifier
        documentId - the document id
        Returns:
        the snippets by document id
        Throws:
        CometException - the comet exception

      • getSnippetsByRecordStringId

        java.util.List<CometSnippet> getSnippetsByRecordStringId​(java.lang.String projectIdentifier,
                                                         java.lang.String recordStringId)
                                                  throws CometException
        Gets snippets by record string id.
        Parameters:
        projectIdentifier - the project identifier
        recordStringId - the record string id
        Returns:
        the snippets by record string id
        Throws:
        CometException - the comet exception

      • getSnippetsByObjectId

        java.util.List<CometSnippet> getSnippetsByObjectId​(java.lang.String projectIdentifier,
                                                   java.lang.String objectId)
                                            throws CometException
        Gets snippets by object id.
        Parameters:
        projectIdentifier - the project identifier
        objectId - the object id
        Returns:
        the snippets by object id
        Throws:
        CometException - the comet exception

      • getSnippetsByRootPublicationType

        java.util.List<CometSnippet> getSnippetsByRootPublicationType​(java.lang.String projectIdentifier,
                                                              java.lang.String rootPublicationType)
                                                       throws CometException
        Gets snippets by root publication type.
        Parameters:
        projectIdentifier - the project identifier
        rootPublicationType - the root publication type
        Returns:
        the snippets by root publication type
        Throws:
        CometException - the comet exception

      • getSnippets

        java.util.List<CometSnippet> getSnippets​(java.lang.String objectId,
                                         java.lang.String objectEntityIdentifier,
                                         java.lang.String objectClassName)
                                  throws CometException
        Gets snippets.
        Parameters:
        objectId - the object id
        objectEntityIdentifier - the object entity identifier
        objectClassName - the object class name
        Returns:
        the snippets
        Throws:
        CometException - the comet exception

      • getSnippets

        java.util.List<CometSnippet> getSnippets​(java.lang.String projectIdentifier,
                                         java.util.Map<CometSnippet.QueryParameter,​java.lang.Object> parameters)
                                  throws CometException
        Gets snippets.
        Parameters:
        projectIdentifier - the project identifier
        parameters - the parameters
        Returns:
        the snippets
        Throws:
        CometException - the comet exception

      • deleteSnippetById

        void deleteSnippetById​(int id)
                throws CometException
        Delete snippet by id.
        Parameters:
        id - the id
        Throws:
        CometException - the comet exception

      • getSnippetsByProject

        java.util.List<CometSnippet> getSnippetsByProject​(java.lang.String projectName)
                                           throws CometException
        Gets snippets by project.
        Parameters:
        projectName - the project name
        Returns:
        the snippets by project
        Throws:
        CometException - the comet exception

      • getSnippetsByBucketIdAndContext

        java.util.List<CometSnippet> getSnippetsByBucketIdAndContext​(java.lang.String projectIdentifier,
                                                             java.lang.String itemId,
                                                             java.lang.String snippetContext)
                                                      throws CometException
        Gets snippets by bucket id and context.
        Parameters:
        projectIdentifier - the project identifier
        itemId - the item id
        snippetContext - the snippet context
        Returns:
        the snippets by bucket id and context
        Throws:
        CometException - the comet exception