Package de.uplanet.lucy.server.businesslogic.util

Interface IDataRangeDataService

All Superinterfaces:
de.uplanet.lucy.server.businesslogic.util.IDataCollection
public interface IDataRangeDataService extends de.uplanet.lucy.server.businesslogic.util.IDataCollection
Interface for the Data part to the DataRange implementation.

  • Method Details

    • getRows

      List<de.uplanet.lucy.server.businesslogic.util.IRow> getRows()
      returns a List of IRow objects
      Returns:
      a List of IRow objects

    • getSortbyFields

      List<de.uplanet.lucy.server.businesslogic.util.SortByInfo> getSortbyFields()
      returns a list of field ids
      Returns:
      a list containing field ids that are used for sorting

    • getDistinctFields

      List<String> getDistinctFields()
      returns a list of field GUIDs
      Returns:
      a list containing field GUIDs

    • getPreSelectFields

      @Deprecated Map<String,String> getPreSelectFields()
      Deprecated.
      use getPreSelectFieldsVH instead
      returns a map of preselect field
      Returns:
      a map of (fieldid, value) pairs

    • getPreSelectFieldsVH

      Map<String,IValueHolder<?>> getPreSelectFieldsVH()
      returns a map of preselect field
      Returns:
      a map of (fieldid, value) pairs

    • getPreSelectLevel

      int getPreSelectLevel()
      returns the preselect level
      Returns:
      the preselect level

    • getFilter

      de.uplanet.lucy.server.businesslogic.util.IRtFilter getFilter()
      returns an dataaccess filter
      Returns:
      a Filter object

    • setFilter

      void setFilter(de.uplanet.lucy.server.businesslogic.util.IRtFilter p_filter)
      set an dataaccess filter
      Parameters:
      p_filter -

    • getDataRangeGuid

      String getDataRangeGuid()
      returns the GUID of the datarange
      Returns:
      the GUID of the datarange

    • getDataGroupGuid

      String getDataGroupGuid()
      returns the data group GUID
      Returns:
      the data group GUID

    • getDatarangeName

      String getDatarangeName()
      returns the name of the datarange
      Returns:
      the name of the datarange as string

    • getDatarangeFlag

      de.uplanet.lucy.constants.DR_FLAG getDatarangeFlag()
      returns the datarange flag
      Returns:
      the datarange flag as enum

    • getFieldGuidList

      List<String> getFieldGuidList()
      Returns a list of field guids. This method always has to return a list. If no fields are available, the method returns an empty list.
      Returns:
      Returns always a list of field guids, maybe empty.

    • getParentId

      String getParentId()
      returns the parent id
      Returns:
      the parent id as String

    • getAppGuid

      String getAppGuid()
      returns the application guid
      Returns:
      the app guid

    • getTextAreaMaxSize

      int getTextAreaMaxSize()
      returns the max. text area size
      Returns:
      max. text area size

    • getPageSize

      int getPageSize()
      returns the page size (only valid for paging mode PAGING_MODE.PAGE)
      Returns:
      page size

    • getPageNumber

      int getPageNumber()
      returns the page number (only valid for paging mode PAGING_MODE.PAGE)
      Returns:
      page number

    • getOffset

      int getOffset()
      Returns:
      Returns the scoll offset (only valid for paging mode PAGING_MODE.OFFSET_LIMIT

    • setOffset

      void setOffset(int p_offset)
      set the scroll offset and set the paging mode to PAGING_MODE.OFFSET_LIMIT

    • getLimit

      int getLimit()
      Returns:
      Returns the limit of records to read (only valid for paging mode PAGING_MODE.OFFSET_LIMIT

    • setLimit

      void setLimit(int p_limt)
      set the limit of records to readPAGING_MODE.OFFSET_LIMIT

    • setPagingMode

      void setPagingMode(de.uplanet.lucy.server.businesslogic.util.PAGING_MODE p_pagingMode)
      set the paging mode

    • getPagingMode

      de.uplanet.lucy.server.businesslogic.util.PAGING_MODE getPagingMode()
      Returns:
      Returns the

    • getDataAppGuid

      String getDataAppGuid()
      returns the guid of the application that holds the data.
      Returns:
      the application guid

    • isDataFromSameApp

      boolean isDataFromSameApp()
      Check if this data range object gets it's data from a data group that belongs to the same application this data range belongs to.
      Returns:
      true if this data range object gets it's data from a data group that belongs to the same application this data range belongs to, or false otherwise.

    • setAttribute

      void setAttribute(String p_strAttrName, String p_strValue)
      sets a datarange attribute like PAGECOUNT, etc.
      Parameters:
      p_strAttrName - a String containing the name of the attribute
      p_strValue - the value of this attribute

    • initDataRangeInfo

      void initDataRangeInfo(DataRangeControlInfo p_containerControlInfo)
      sets a ContainerControlInfo for this datarange
      Parameters:
      p_containerControlInfo -

    • setAppGuid

      void setAppGuid(String p_strAppGuid)
      Sets the application guid.
      Parameters:
      p_strAppGuid -

    • setParentId

      void setParentId(String p_strParendId)
      sets the parent id
      Parameters:
      p_strParendId - the parent id

    • setPreSelectLevel

      void setPreSelectLevel(int p_iLevel)
      sets the preselectLevel
      Parameters:
      p_iLevel - the preselect level

    • setPageNumber

      void setPageNumber(int p_iPageNumber)
      sets the page number and the paging mode to PAGING_MODE.PAGE
      Parameters:
      p_iPageNumber - the page number

    • setPageSize

      void setPageSize(int p_iPageSize)
      sets the page size and the paging mode to PAGING_MODE.PAGE
      Parameters:
      p_iPageSize - the page size

    • getContainerType

      de.uplanet.lucy.types.CONTAINER_TYPE getContainerType()
      Method getContainerType.
      Returns:
      CONTAINER_TYPE

    • getDatarangeInfo

      DataRangeControlInfo getDatarangeInfo()
      Method getDatarangeInfo builds a new DatarangeInfo Object to return current attributes.
      Returns:
      DataRangeControlInfo

    • getQuery

      String getQuery()
      Returns the Query String that created the list.
      Returns:
      String

    • setQuery

      void setQuery(String p_strQuery)
      Sets the Query String that created the list.
      Parameters:
      p_strQuery - The m_strQuery to set

    • setPermission

      void setPermission(boolean p_bHasPermission)
      Method setPermission sets the internal member that holds the hasPermission status

    • hasPermission

      boolean hasPermission()
      Method hasPermission returns the value of the internal member. This member ist set by the setPermission method and represents the AppDgPermission.READ action.
      Returns:
      boolean

    • setUserIdForRow

      void setUserIdForRow(String p_strUserId)
      Set the user ID for the current row

    • setRecordOwner

      void setRecordOwner(int p_iRowOwner)

    • setTotalCount

      void setTotalCount(int p_iTotalCount)
      Parameters:
      p_iTotalCount - total number of all records within the datarange.

    • needsToSelectParentField

      boolean needsToSelectParentField()

    • setPropertyForEveryRowVH

      void setPropertyForEveryRowVH(String p_strFieldGuid, IValueHolder<?> p_vhValue) throws de.uplanet.lucy.server.businesslogic.BlException
      Set the property value for every row that exists
      Parameters:
      p_strFieldGuid - The field guid.
      p_vhValue - Value to set
      Throws:
      de.uplanet.lucy.server.businesslogic.BlException

    • clearRows

      void clearRows()
      clears the rows

    • needsToSelectRowCount

      boolean needsToSelectRowCount()
      Control if the total record count should be determined or not. if false one database call will be saved.
      Returns:
      true if the row count is need or not.

    • setNeedsToSelectRowCount

      void setNeedsToSelectRowCount(boolean p_bNeedsToSelectCount)
      Control if the total record count should be determined or not.

    • needsToSelectRows

      boolean needsToSelectRows()
      Control if the records should be selected or not.

    • setNeedsToSelectRows

      void setNeedsToSelectRows(boolean p_bSelectNeeded)

    • getMaxPagesCount

      int getMaxPagesCount()
      Used to optimize tables with a lot of records. if value is not -1 than select count(*) will not be called, and the record count will be calculated with getMaxPagesCount() * m_iPageSize
      Returns:
      -1 if select count(*) should used to count the record count.

    • setMaxPagesCount

      void setMaxPagesCount(int p_iMaxPageCount)
      Used to optimize tables with a lot of records. if value is not -1 than select count(*) will not be called, and the record count will be calculated with getMaxPagesCount() * m_iPageSize

    • addField

      void addField(String p_strField)
      Adds a field GUID.
      Parameters:
      p_strField - The field GUID.

    • getTotalCount

      int getTotalCount()
      Returns:
      total number of all records within the datarange.

    • getDataRangeResultInfo

      de.uplanet.lucy.server.businesslogic.util.IDataRangeResultInfo getDataRangeResultInfo()