Class BackofficeSavedQueryModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class BackofficeSavedQueryModel
    extends ItemModel
    Generated model class for type BackofficeSavedQuery first defined at extension platformbackoffice.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CONDITIONS
      Generated constant - Attribute key of BackofficeSavedQuery.conditions attribute defined at extension platformbackoffice.
      static java.lang.String GLOBALOPERATORCODE
      Generated constant - Attribute key of BackofficeSavedQuery.globalOperatorCode attribute defined at extension platformbackoffice.
      static java.lang.String INCLUDESUBTYPES
      Generated constant - Attribute key of BackofficeSavedQuery.includeSubtypes attribute defined at extension platformbackoffice.
      static java.lang.String NAME
      Generated constant - Attribute key of BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
      static java.lang.String QUERYOWNER
      Generated constant - Attribute key of BackofficeSavedQuery.queryOwner attribute defined at extension platformbackoffice.
      static java.lang.String SAVEDQUERIESPARAMETERS
      Generated constant - Attribute key of BackofficeSavedQuery.savedQueriesParameters attribute defined at extension platformbackoffice.
      static java.lang.String SEARCHMODE
      Generated constant - Attribute key of BackofficeSavedQuery.searchMode attribute defined at extension platformbackoffice.
      static java.lang.String SORTASC
      Generated constant - Attribute key of BackofficeSavedQuery.sortAsc attribute defined at extension platformbackoffice.
      static java.lang.String SORTATTRIBUTE
      Generated constant - Attribute key of BackofficeSavedQuery.sortAttribute attribute defined at extension platformbackoffice.
      static java.lang.String TOKENIZABLE
      Generated constant - Attribute key of BackofficeSavedQuery.tokenizable attribute defined at extension platformbackoffice.
      static java.lang.String TYPECODE
      Generated constant - Attribute key of BackofficeSavedQuery.typeCode attribute defined at extension platformbackoffice.
      static java.lang.String USERGROUPS
      Generated constant - Attribute key of BackofficeSavedQuery.userGroups attribute defined at extension platformbackoffice.
    • Constructor Summary

      Constructors 
      Constructor Description
      BackofficeSavedQueryModel()
      Generated constructor - Default constructor for generic creation.
      BackofficeSavedQueryModel​(ItemModel _owner, UserModel _queryOwner, java.lang.String _typeCode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      BackofficeSavedQueryModel​(UserModel _queryOwner, java.lang.String _typeCode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      BackofficeSavedQueryModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Collection<BackofficeSearchConditionModel> getConditions()
      Generated method - Getter of the BackofficeSavedQuery.conditions attribute defined at extension platformbackoffice.
      java.lang.String getGlobalOperatorCode()
      Generated method - Getter of the BackofficeSavedQuery.globalOperatorCode attribute defined at extension platformbackoffice.
      java.lang.Boolean getIncludeSubtypes()
      Generated method - Getter of the BackofficeSavedQuery.includeSubtypes attribute defined at extension platformbackoffice.
      java.lang.String getName()
      Generated method - Getter of the BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
      java.lang.String getName​(java.util.Locale loc)
      Generated method - Getter of the BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
      UserModel getQueryOwner()
      Generated method - Getter of the BackofficeSavedQuery.queryOwner attribute defined at extension platformbackoffice.
      java.util.Map<java.lang.String,​java.lang.String> getSavedQueriesParameters()
      Generated method - Getter of the BackofficeSavedQuery.savedQueriesParameters attribute defined at extension platformbackoffice.
      java.lang.String getSearchMode()
      Generated method - Getter of the BackofficeSavedQuery.searchMode attribute defined at extension platformbackoffice.
      java.lang.Boolean getSortAsc()
      Generated method - Getter of the BackofficeSavedQuery.sortAsc attribute defined at extension platformbackoffice.
      java.lang.String getSortAttribute()
      Generated method - Getter of the BackofficeSavedQuery.sortAttribute attribute defined at extension platformbackoffice.
      java.lang.Boolean getTokenizable()
      Generated method - Getter of the BackofficeSavedQuery.tokenizable attribute defined at extension platformbackoffice.
      java.lang.String getTypeCode()
      Generated method - Getter of the BackofficeSavedQuery.typeCode attribute defined at extension platformbackoffice.
      java.util.Collection<UserGroupModel> getUserGroups()
      Generated method - Getter of the BackofficeSavedQuery.userGroups attribute defined at extension platformbackoffice.
      void setConditions​(java.util.Collection<BackofficeSearchConditionModel> value)
      Generated method - Setter of BackofficeSavedQuery.conditions attribute defined at extension platformbackoffice.
      void setGlobalOperatorCode​(java.lang.String value)
      Generated method - Setter of BackofficeSavedQuery.globalOperatorCode attribute defined at extension platformbackoffice.
      void setIncludeSubtypes​(java.lang.Boolean value)
      Generated method - Setter of BackofficeSavedQuery.includeSubtypes attribute defined at extension platformbackoffice.
      void setName​(java.lang.String value)
      Generated method - Setter of BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
      void setName​(java.lang.String value, java.util.Locale loc)
      Generated method - Setter of BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
      void setQueryOwner​(UserModel value)
      Generated method - Setter of BackofficeSavedQuery.queryOwner attribute defined at extension platformbackoffice.
      void setSavedQueriesParameters​(java.util.Map<java.lang.String,​java.lang.String> value)
      Generated method - Setter of BackofficeSavedQuery.savedQueriesParameters attribute defined at extension platformbackoffice.
      void setSearchMode​(java.lang.String value)
      Generated method - Setter of BackofficeSavedQuery.searchMode attribute defined at extension platformbackoffice.
      void setSortAsc​(java.lang.Boolean value)
      Generated method - Setter of BackofficeSavedQuery.sortAsc attribute defined at extension platformbackoffice.
      void setSortAttribute​(java.lang.String value)
      Generated method - Setter of BackofficeSavedQuery.sortAttribute attribute defined at extension platformbackoffice.
      void setTokenizable​(java.lang.Boolean value)
      Generated method - Setter of BackofficeSavedQuery.tokenizable attribute defined at extension platformbackoffice.
      void setTypeCode​(java.lang.String value)
      Generated method - Setter of BackofficeSavedQuery.typeCode attribute defined at extension platformbackoffice.
      void setUserGroups​(java.util.Collection<UserGroupModel> value)
      Generated method - Setter of BackofficeSavedQuery.userGroups attribute defined at extension platformbackoffice.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • QUERYOWNER

        public static final java.lang.String QUERYOWNER
        Generated constant - Attribute key of BackofficeSavedQuery.queryOwner attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • TYPECODE

        public static final java.lang.String TYPECODE
        Generated constant - Attribute key of BackofficeSavedQuery.typeCode attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • INCLUDESUBTYPES

        public static final java.lang.String INCLUDESUBTYPES
        Generated constant - Attribute key of BackofficeSavedQuery.includeSubtypes attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • GLOBALOPERATORCODE

        public static final java.lang.String GLOBALOPERATORCODE
        Generated constant - Attribute key of BackofficeSavedQuery.globalOperatorCode attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • SORTATTRIBUTE

        public static final java.lang.String SORTATTRIBUTE
        Generated constant - Attribute key of BackofficeSavedQuery.sortAttribute attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • SORTASC

        public static final java.lang.String SORTASC
        Generated constant - Attribute key of BackofficeSavedQuery.sortAsc attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • TOKENIZABLE

        public static final java.lang.String TOKENIZABLE
        Generated constant - Attribute key of BackofficeSavedQuery.tokenizable attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • SEARCHMODE

        public static final java.lang.String SEARCHMODE
        Generated constant - Attribute key of BackofficeSavedQuery.searchMode attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • SAVEDQUERIESPARAMETERS

        public static final java.lang.String SAVEDQUERIESPARAMETERS
        Generated constant - Attribute key of BackofficeSavedQuery.savedQueriesParameters attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • CONDITIONS

        public static final java.lang.String CONDITIONS
        Generated constant - Attribute key of BackofficeSavedQuery.conditions attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
      • USERGROUPS

        public static final java.lang.String USERGROUPS
        Generated constant - Attribute key of BackofficeSavedQuery.userGroups attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
    • Constructor Detail

      • BackofficeSavedQueryModel

        public BackofficeSavedQueryModel()
        Generated constructor - Default constructor for generic creation.
      • BackofficeSavedQueryModel

        public BackofficeSavedQueryModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • BackofficeSavedQueryModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public BackofficeSavedQueryModel​(UserModel _queryOwner,
                                         java.lang.String _typeCode)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _queryOwner - initial attribute declared by type BackofficeSavedQuery at extension platformbackoffice
        _typeCode - initial attribute declared by type BackofficeSavedQuery at extension platformbackoffice
      • BackofficeSavedQueryModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public BackofficeSavedQueryModel​(ItemModel _owner,
                                         UserModel _queryOwner,
                                         java.lang.String _typeCode)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _owner - initial attribute declared by type Item at extension core
        _queryOwner - initial attribute declared by type BackofficeSavedQuery at extension platformbackoffice
        _typeCode - initial attribute declared by type BackofficeSavedQuery at extension platformbackoffice
    • Method Detail

      • getConditions

        @Accessor(qualifier="conditions",
                  type=GETTER)
        public java.util.Collection<BackofficeSearchConditionModel> getConditions()
        Generated method - Getter of the BackofficeSavedQuery.conditions attribute defined at extension platformbackoffice. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the conditions
      • getGlobalOperatorCode

        @Accessor(qualifier="globalOperatorCode",
                  type=GETTER)
        public java.lang.String getGlobalOperatorCode()
        Generated method - Getter of the BackofficeSavedQuery.globalOperatorCode attribute defined at extension platformbackoffice.
        Returns:
        the globalOperatorCode
      • getIncludeSubtypes

        @Accessor(qualifier="includeSubtypes",
                  type=GETTER)
        public java.lang.Boolean getIncludeSubtypes()
        Generated method - Getter of the BackofficeSavedQuery.includeSubtypes attribute defined at extension platformbackoffice.
        Returns:
        the includeSubtypes
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName()
        Generated method - Getter of the BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
        Returns:
        the name
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName​(java.util.Locale loc)
        Generated method - Getter of the BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
        Parameters:
        loc - the value localization key
        Returns:
        the name
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getQueryOwner

        @Accessor(qualifier="queryOwner",
                  type=GETTER)
        public UserModel getQueryOwner()
        Generated method - Getter of the BackofficeSavedQuery.queryOwner attribute defined at extension platformbackoffice.
        Returns:
        the queryOwner
      • getSavedQueriesParameters

        @Accessor(qualifier="savedQueriesParameters",
                  type=GETTER)
        public java.util.Map<java.lang.String,​java.lang.String> getSavedQueriesParameters()
        Generated method - Getter of the BackofficeSavedQuery.savedQueriesParameters attribute defined at extension platformbackoffice.
        Returns:
        the savedQueriesParameters
      • getSearchMode

        @Accessor(qualifier="searchMode",
                  type=GETTER)
        public java.lang.String getSearchMode()
        Generated method - Getter of the BackofficeSavedQuery.searchMode attribute defined at extension platformbackoffice.
        Returns:
        the searchMode
      • getSortAsc

        @Accessor(qualifier="sortAsc",
                  type=GETTER)
        public java.lang.Boolean getSortAsc()
        Generated method - Getter of the BackofficeSavedQuery.sortAsc attribute defined at extension platformbackoffice.
        Returns:
        the sortAsc
      • getSortAttribute

        @Accessor(qualifier="sortAttribute",
                  type=GETTER)
        public java.lang.String getSortAttribute()
        Generated method - Getter of the BackofficeSavedQuery.sortAttribute attribute defined at extension platformbackoffice.
        Returns:
        the sortAttribute
      • getTokenizable

        @Accessor(qualifier="tokenizable",
                  type=GETTER)
        public java.lang.Boolean getTokenizable()
        Generated method - Getter of the BackofficeSavedQuery.tokenizable attribute defined at extension platformbackoffice.
        Returns:
        the tokenizable
      • getTypeCode

        @Accessor(qualifier="typeCode",
                  type=GETTER)
        public java.lang.String getTypeCode()
        Generated method - Getter of the BackofficeSavedQuery.typeCode attribute defined at extension platformbackoffice.
        Returns:
        the typeCode
      • getUserGroups

        @Accessor(qualifier="userGroups",
                  type=GETTER)
        public java.util.Collection<UserGroupModel> getUserGroups()
        Generated method - Getter of the BackofficeSavedQuery.userGroups attribute defined at extension platformbackoffice. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the userGroups
      • setConditions

        @Accessor(qualifier="conditions",
                  type=SETTER)
        public void setConditions​(java.util.Collection<BackofficeSearchConditionModel> value)
        Generated method - Setter of BackofficeSavedQuery.conditions attribute defined at extension platformbackoffice.
        Parameters:
        value - the conditions
      • setGlobalOperatorCode

        @Accessor(qualifier="globalOperatorCode",
                  type=SETTER)
        public void setGlobalOperatorCode​(java.lang.String value)
        Generated method - Setter of BackofficeSavedQuery.globalOperatorCode attribute defined at extension platformbackoffice.
        Parameters:
        value - the globalOperatorCode
      • setIncludeSubtypes

        @Accessor(qualifier="includeSubtypes",
                  type=SETTER)
        public void setIncludeSubtypes​(java.lang.Boolean value)
        Generated method - Setter of BackofficeSavedQuery.includeSubtypes attribute defined at extension platformbackoffice.
        Parameters:
        value - the includeSubtypes
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value)
        Generated method - Setter of BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
        Parameters:
        value - the name
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value,
                            java.util.Locale loc)
        Generated method - Setter of BackofficeSavedQuery.name attribute defined at extension platformbackoffice.
        Parameters:
        value - the name
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setQueryOwner

        @Accessor(qualifier="queryOwner",
                  type=SETTER)
        public void setQueryOwner​(UserModel value)
        Generated method - Setter of BackofficeSavedQuery.queryOwner attribute defined at extension platformbackoffice.
        Parameters:
        value - the queryOwner
      • setSavedQueriesParameters

        @Accessor(qualifier="savedQueriesParameters",
                  type=SETTER)
        public void setSavedQueriesParameters​(java.util.Map<java.lang.String,​java.lang.String> value)
        Generated method - Setter of BackofficeSavedQuery.savedQueriesParameters attribute defined at extension platformbackoffice.
        Parameters:
        value - the savedQueriesParameters
      • setSearchMode

        @Accessor(qualifier="searchMode",
                  type=SETTER)
        public void setSearchMode​(java.lang.String value)
        Generated method - Setter of BackofficeSavedQuery.searchMode attribute defined at extension platformbackoffice.
        Parameters:
        value - the searchMode
      • setSortAsc

        @Accessor(qualifier="sortAsc",
                  type=SETTER)
        public void setSortAsc​(java.lang.Boolean value)
        Generated method - Setter of BackofficeSavedQuery.sortAsc attribute defined at extension platformbackoffice.
        Parameters:
        value - the sortAsc
      • setSortAttribute

        @Accessor(qualifier="sortAttribute",
                  type=SETTER)
        public void setSortAttribute​(java.lang.String value)
        Generated method - Setter of BackofficeSavedQuery.sortAttribute attribute defined at extension platformbackoffice.
        Parameters:
        value - the sortAttribute
      • setTokenizable

        @Accessor(qualifier="tokenizable",
                  type=SETTER)
        public void setTokenizable​(java.lang.Boolean value)
        Generated method - Setter of BackofficeSavedQuery.tokenizable attribute defined at extension platformbackoffice.
        Parameters:
        value - the tokenizable
      • setTypeCode

        @Accessor(qualifier="typeCode",
                  type=SETTER)
        public void setTypeCode​(java.lang.String value)
        Generated method - Setter of BackofficeSavedQuery.typeCode attribute defined at extension platformbackoffice.
        Parameters:
        value - the typeCode
      • setUserGroups

        @Accessor(qualifier="userGroups",
                  type=SETTER)
        public void setUserGroups​(java.util.Collection<UserGroupModel> value)
        Generated method - Setter of BackofficeSavedQuery.userGroups attribute defined at extension platformbackoffice.
        Parameters:
        value - the userGroups