Package com.priint.pubserver.comet.bridge

Class FileRequestParameters

  • All Implemented Interfaces:
    java.io.Serializable
    public class FileRequestParameters
extends java.lang.Object
implements java.io.Serializable
    The type File request parameters. For internal use only.
    See Also:
    Serialized Form

    • Method Detail

      • parse

        public static FileRequestParameters parse​(java.lang.String query,
                                          java.lang.String rootPath)
                                   throws CometException
        Parse file request parameters.
        Parameters:
        query - the query
        rootPath - the root path
        Returns:
        the file request parameters
        Throws:
        CometException - the comet exception

      • initResultDocument

        public void initResultDocument​(CometFrameInfoDocument document)
        Init result document.
        Parameters:
        document - the document

      • initResultDocument

        public void initResultDocument​(CometSnippetDocument document)
        Init result document.
        Parameters:
        document - the document

      • toString

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

      • debugString

        public java.lang.String debugString()
        Debug string string.
        Returns:
        the string

      • getPlaceholderIds

        public java.util.List<java.lang.Integer> getPlaceholderIds()
        Gets placeholder ids.
        Returns:
        the placeholder ids

      • getDocumentName

        public java.lang.String getDocumentName()
        Gets document name.
        Returns:
        the document name

      • getDocumentPath

        public java.lang.String getDocumentPath()
        Gets document path.
        Returns:
        the document path

      • getPublicationPlannerDocumentId

        public java.lang.String getPublicationPlannerDocumentId()
        Gets publication planner document id.
        Returns:
        the publication planner document id

      • getPublication

        public java.lang.String getPublication()
        Gets publication.
        Returns:
        the publication

      • getPublicationType

        public java.lang.String getPublicationType()
        Gets publication type.
        Returns:
        the publication type

      • getTemplateIds

        public java.util.List<java.lang.Integer> getTemplateIds()
        Gets template ids.
        Returns:
        the template ids

      • getPages

        public java.util.List<java.lang.Integer> getPages()
        Gets pages.
        Returns:
        the pages

      • getObjectEntityIds

        public java.util.List<java.lang.String> getObjectEntityIds()
        Gets object entity ids.
        Returns:
        the object entity ids

      • getObjectIds

        public java.util.List<java.lang.String> getObjectIds()
        Gets object ids.
        Returns:
        the object ids

      • getObjectGroupIds

        public java.util.List<java.lang.String> getObjectGroupIds()
        Gets object group ids.
        Returns:
        the object group ids

      • getObjectEntityClasses

        public java.util.List<java.lang.String> getObjectEntityClasses()
        Gets object entity classes.
        Returns:
        the object entity classes

      • getParentObjectEntityIds

        public java.util.List<java.lang.String> getParentObjectEntityIds()
        Gets parent object entity ids.
        Returns:
        the parent object entity ids

      • getParentObjectIds

        public java.util.List<java.lang.String> getParentObjectIds()
        Gets parent object ids.
        Returns:
        the parent object ids

      • getParentObjectGroupIds

        public java.util.List<java.lang.String> getParentObjectGroupIds()
        Gets parent object group ids.
        Returns:
        the parent object group ids

      • getParentObjectEntityClasses

        public java.util.List<java.lang.String> getParentObjectEntityClasses()
        Gets parent object entity classes.
        Returns:
        the parent object entity classes

      • getRecordStringIds

        public java.util.List<java.lang.String> getRecordStringIds()
        Gets record string ids.
        Returns:
        the record string ids

      • getBuiltByObjectEntityIds

        public java.util.List<java.lang.String> getBuiltByObjectEntityIds()
        Gets built by object entity ids.
        Returns:
        the built by object entity ids

      • getBuiltByObjectIds

        public java.util.List<java.lang.String> getBuiltByObjectIds()
        Gets built by object ids.
        Returns:
        the built by object ids

      • getBuiltByObjectGroupIds

        public java.util.List<java.lang.String> getBuiltByObjectGroupIds()
        Gets built by object group ids.
        Returns:
        the built by object group ids

      • getBuiltByObjectEntityClasses

        public java.util.List<java.lang.String> getBuiltByObjectEntityClasses()
        Gets built by object entity classes.
        Returns:
        the built by object entity classes

      • getBuiltByParentObjectEntityIds

        public java.util.List<java.lang.String> getBuiltByParentObjectEntityIds()
        Gets built by parent object entity ids.
        Returns:
        the built by parent object entity ids

      • getBuiltByParentObjectIds

        public java.util.List<java.lang.String> getBuiltByParentObjectIds()
        Gets built by parent object ids.
        Returns:
        the built by parent object ids

      • getBuiltByParentObjectGroupIds

        public java.util.List<java.lang.String> getBuiltByParentObjectGroupIds()
        Gets built by parent object group ids.
        Returns:
        the built by parent object group ids

      • getBuiltByParentObjectEntityClasses

        public java.util.List<java.lang.String> getBuiltByParentObjectEntityClasses()
        Gets built by parent object entity classes.
        Returns:
        the built by parent object entity classes

      • getBuiltByRecordStringIds

        public java.util.List<java.lang.String> getBuiltByRecordStringIds()
        Gets built by record string ids.
        Returns:
        the built by record string ids

      • getLayers

        public java.util.List<java.lang.String> getLayers()
        Gets layers.
        Returns:
        the layers

      • getFrameInfoIds

        public java.util.List<java.lang.String> getFrameInfoIds()
        Gets frame info ids.
        Returns:
        the frame info ids

      • getFrameLabels

        public java.util.List<java.lang.String> getFrameLabels()
        Gets frame labels.
        Returns:
        the frame labels

      • getFrameTypes

        public java.util.List<java.lang.String> getFrameTypes()
        Gets frame types.
        Returns:
        the frame types

      • getScriptTags

        public java.util.List<java.lang.String> getScriptTags()
        Gets script tags.
        Returns:
        the script tags

      • getFrameUIDs

        public java.util.List<java.lang.Integer> getFrameUIDs()
        Gets frame ui ds.
        Returns:
        the frame ui ds

      • getPlaceholderInfos1

        public java.util.List<java.lang.String> getPlaceholderInfos1()
        Gets placeholder infos 1.
        Returns:
        the placeholder infos 1

      • getPlaceholderInfos2

        public java.util.List<java.lang.String> getPlaceholderInfos2()
        Gets placeholder infos 2.
        Returns:
        the placeholder infos 2

      • getIds

        public java.util.List<java.lang.String> getIds()
        Gets ids.
        Returns:
        the ids

      • getProcessedSearchFlags

        public java.util.List<FileRequestParameters.SearchFlag> getProcessedSearchFlags()
        Gets processed search flags.
        Returns:
        the processed search flags

      • getDeclaredSearchFlags

        public java.util.List<FileRequestParameters.SearchFlag> getDeclaredSearchFlags()
        Gets declared search flags.
        Returns:
        the declared search flags

      • getUsedParametersAsDeclared

        public FileRequestParameters.Parameter[] getUsedParametersAsDeclared()
        Get used parameters as declared parameter [ ].
        Returns:
        the parameter [ ]

      • getUsedParametersAsDefined

        public FileRequestParameters.Parameter[] getUsedParametersAsDefined()
        Get used parameters as defined parameter [ ].
        Returns:
        the parameter [ ]

      • getCometProject

        public java.lang.String getCometProject()
        Gets comet project.
        Returns:
        the comet project

      • setCometProject

        public void setCometProject​(java.lang.String cometProject)
        Sets comet project.
        Parameters:
        cometProject - the comet project

      • hasParametersAsDeclared

        public boolean hasParametersAsDeclared()
        Has parameters as declared boolean.
        Returns:
        the boolean

      • containsOrIgnore

        public boolean containsOrIgnore​(FileRequestParameters.Parameter parameter,
                                java.lang.String value)
        Contains or ignore boolean.
        Parameters:
        parameter - the parameter
        value - the value
        Returns:
        the boolean

      • containsOrIgnore

        public boolean containsOrIgnore​(FileRequestParameters.Parameter parameter,
                                java.lang.Integer value)
        Contains or ignore boolean.
        Parameters:
        parameter - the parameter
        value - the value
        Returns:
        the boolean

      • matches

        public boolean matches​(java.lang.Object obj)

        Test, if an object matches parameters as defined.

        Parameters:
        obj - the object to test
        Returns:
        true, if the object matches the defined search parameters, false otherwise.

      • matchesSearchFlags

        public boolean matchesSearchFlags​(java.lang.Object obj)

        Test, if an object matches parameters as declared by search flags.

        Parameters:
        obj - the object to test
        Returns:
        true, if the object matches the declared search parameters, false otherwise.

      • equals

        public boolean equals​(java.lang.Object obj1,
                      java.lang.Object obj2)

        Test, if two objects are equal according to the declared search flags..

        Parameters:
        obj1 - first object two compare
        obj2 - second object to compare
        Returns:
        true, if the objects are equal according to the declared search flags, false otherwise.

      • setOrVerifyDocumentParameters

        public void setOrVerifyDocumentParameters​(java.lang.String cometProject,
                                          java.lang.String documentName,
                                          java.lang.String documentPath,
                                          java.lang.String publicationPlannerDocumentId,
                                          java.lang.String publication,
                                          java.lang.String publicationType)
                                   throws CometException
        Sets or verify document parameters.
        Parameters:
        cometProject - the comet project
        documentName - the document name
        documentPath - the document path
        publicationPlannerDocumentId - the publication planner document id
        publication - the publication
        publicationType - the publication type
        Throws:
        CometException - the comet exception

      • setSnippetSearchFlags

        public void setSnippetSearchFlags​(java.util.List<FileRequestParameters.SnippetSearchFlag> snippetSearchFlags)
        Sets snippet search flags.
        Parameters:
        snippetSearchFlags - the snippet search flags

      • getContexts

        public java.util.List<java.lang.String> getContexts()
        Gets contexts.
        Returns:
        the contexts

      • setContexts

        public void setContexts​(java.util.List<java.lang.String> contexts)
        Sets contexts.
        Parameters:
        contexts - the contexts