Class ItemListSyncFilterData

  • All Implemented Interfaces:
    IdentifiableData, NameableData

    public class ItemListSyncFilterData
    extends BasicData
    implements NameableData
    Synchronization options for item lists. This is similar to filters used by ContextData.
    Since:
    3.5
    Author:
    Nicklas
    Hibernate: class
    table="`ItemListSyncFilters`" lazy="true"
    • Field Detail

      • description

        private String description
      • filterGroup

        private String filterGroup
      • sourceItemType

        private int sourceItemType
      • sourceItemTransform

        private int sourceItemTransform
      • sourceMustExist

        private boolean sourceMustExist
      • disabled

        private boolean disabled
      • matchingSource

        private int matchingSource
      • matchingTransformed

        private int matchingTransformed
      • lastSyncProperties

        private String lastSyncProperties
      • include

        private int include
    • Constructor Detail

      • ItemListSyncFilterData

        public ItemListSyncFilterData()
    • Method Detail

      • getName

        public String getName()
        Description copied from interface: NameableData
        Get the name of the item.
        Specified by:
        getName in interface NameableData
        Returns:
        A String with the name of the item
      • setName

        public void setName​(String name)
        Description copied from interface: NameableData
        Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.
        Specified by:
        setName in interface NameableData
        Parameters:
        name - The new name for the item
      • getDescription

        public String getDescription()
        Description copied from interface: NameableData
        Get the description for the item.
        Specified by:
        getDescription in interface NameableData
        Returns:
        A String with a description of the item
      • setDescription

        public void setDescription​(String description)
        Description copied from interface: NameableData
        Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.
        Specified by:
        setDescription in interface NameableData
        Parameters:
        description - The new description for the item
      • getItemList

        public ItemListData getItemList()
        Get the item list this sync filter belongs to.
        Hibernate: many-to-one
        column="`itemlist_id`" not-null="true" outer-join="false" update="false"
      • setItemList

        public void setItemList​(ItemListData itemList)
      • getFilterGroup

        public String getFilterGroup()
        Get the group for this filter.
        Since:
        3.18
        Hibernate: property
        column="`filter_group`" type="string" length="255" not-null="true"
      • setFilterGroup

        public void setFilterGroup​(String filterGroup)
      • getSourceItemType

        public int getSourceItemType()
        Get the type of items that this filter is applies to.
        Hibernate: property
        column="`source_type`" type="int" not-null="true"
      • setSourceItemType

        public void setSourceItemType​(int sourceItemType)
      • getSourceItemTransform

        public int getSourceItemTransform()
        The transform to use for converting filter matches to list members. 0 = none; 1 = parent to child, 2 = child to parent
        Hibernate: property
        column="`source_transform`" type="int" not-null="true"
      • setSourceItemTransform

        public void setSourceItemTransform​(int sourceItemTransform)
      • getSourceMustExist

        public boolean getSourceMustExist()
        If set, the source item must exist, otherwise it must not exist. This option is only used if the transform is to a parent/child item
        Hibernate: property
        column="`source_must_exist`" type="boolean" not-null="true"
      • setSourceMustExist

        public void setSourceMustExist​(boolean sourceMustExist)
      • isDisabled

        public boolean isDisabled()
        If set, the filter is disabled and should not be used when syncing.
        Hibernate: property
        column="`disabled`" type="boolean" not-null="true"
      • setDisabled

        public void setDisabled​(boolean disabled)
      • getMatchingSource

        public int getMatchingSource()
        The number of matching source items during that last sync.
        Hibernate: property
        column="`matching_source`" type="int" not-null="true"
      • setMatchingSource

        public void setMatchingSource​(int matchingSource)
      • getMatchingTransformed

        public int getMatchingTransformed()
        The number of matching items after the transform during that last sync.
        Hibernate: property
        column="`matching_transformed`" type="int" not-null="true"
      • setMatchingTransformed

        public void setMatchingTransformed​(int matchingTransformed)
      • getLastSyncProperties

        public String getLastSyncProperties()
        A string representation of properties that was affecting that last filter during the last sync. Used to check if the result may affect the final item list even if the actual items returned by the query hasn't change. Example: changing the filterGroup or sourceMustExists options.
        Since:
        3.18
        Hibernate: property
        column="`last_sync_properties`" type="string" length="255" not-null="false"
      • setLastSyncProperties

        public void setLastSyncProperties​(String lastSyncProperties)
      • getMd5

        public String getMd5()
        Get the MD5 hash of the concatenated ID values. It is always returned as a string with 32 hexadecimal characters.
        Hibernate: property
        column="`md5`" type="string" length="32" not-null="false"
      • setMd5

        public void setMd5​(String md5)
      • getInclude

        public int getInclude()
        Flags for specifying include options to an entity query.
        Hibernate: property
        column="`include`" type="int" not-null="true"
      • setInclude

        public void setInclude​(int include)
      • getPropertyFilters

        public Map<String,​PropertyFilterData> getPropertyFilters()
        Get the map that manages property filters in this sync filter.
        Hibernate: map
        table="`ItemListSyncPropertyFilters`" lazy="true"
        Hibernate: collection-key
        column="`syncfilter_id`"
        Hibernate: collection-index
        column="`property`" type="string" length="255"
        Hibernate: collection-composite-element
        class="net.sf.basedb.core.data.PropertyFilterData" not-null="true"