Package com.priint.pubserver.comet.bridge

Class FileRequestParameters

java.lang.Object
com.priint.pubserver.comet.bridge.FileRequestParameters
All Implemented Interfaces:
Serializable
public class FileRequestParameters extends Object implements Serializable
The type File request parameters. For internal use only.
See Also:

  • Method Details

    • parse

      public static FileRequestParameters parse(String query, 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 String toString()
      Overrides:
      toString in class Object

    • debugString

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

    • getSnippetSearchFlagByName

      public static FileRequestParameters.SnippetSearchFlag getSnippetSearchFlagByName(String flag) throws CometException
      Gets snippet search flag by name.
      Parameters:
      flag - the flag
      Returns:
      the snippet search flag by name
      Throws:
      CometException - the comet exception

    • getSearchFlagByName

      public static FileRequestParameters.SearchFlag getSearchFlagByName(String flag) throws CometException
      Gets search flag by name.
      Parameters:
      flag - the flag
      Returns:
      the search flag by name
      Throws:
      CometException - the comet exception

    • getPlaceholderIds

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

    • getDocumentName

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

    • getDocumentPath

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

    • getPublicationPlannerDocumentId

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

    • getPublication

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

    • getPublicationType

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

    • getTemplateIds

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

    • getPages

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

    • getObjectEntityIds

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

    • getObjectIds

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

    • getObjectGroupIds

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

    • getObjectEntityClasses

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

    • getParentObjectEntityIds

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

    • getParentObjectIds

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

    • getParentObjectGroupIds

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

    • getParentObjectEntityClasses

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

    • getRecordStringIds

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

    • getBuiltByObjectEntityIds

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

    • getBuiltByObjectIds

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

    • getBuiltByObjectGroupIds

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

    • getBuiltByObjectEntityClasses

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

    • getBuiltByParentObjectEntityIds

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

    • getBuiltByParentObjectIds

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

    • getBuiltByParentObjectGroupIds

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

    • getBuiltByParentObjectEntityClasses

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

    • getBuiltByRecordStringIds

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

    • getLayers

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

    • getFrameInfoIds

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

    • getFrameLabels

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

    • getFrameTypes

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

    • getScriptTags

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

    • getFrameUIDs

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

    • getPlaceholderInfos1

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

    • getPlaceholderInfos2

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

    • getIds

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

    • getProcessedSearchFlags

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

    • getDeclaredSearchFlags

      public 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 String getCometProject()
      Gets comet project.
      Returns:
      the comet project

    • setCometProject

      public void setCometProject(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, String value)
      Contains or ignore boolean.
      Parameters:
      parameter - the parameter
      value - the value
      Returns:
      the boolean

    • containsOrIgnore

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

    • matches

      public boolean matches(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(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(Object obj1, 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(String cometProject, String documentName, String documentPath, String publicationPlannerDocumentId, String publication, 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

    • getSnippetSearchFlags

      public List<FileRequestParameters.SnippetSearchFlag> getSnippetSearchFlags()
      Gets snippet search flags.
      Returns:
      the snippet search flags

    • setSnippetSearchFlags

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

    • getContexts

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

    • setContexts

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