Package de.uplanet.lucy.server.businesslogic.rtappservices

Interface IWebDataRange

All Known Implementing Classes:
de.uplanet.lucy.server.businesslogic.rtappservices.AbstractWebDataRange, WebDataRange, WebShapedTableRange
public interface IWebDataRange

  • Method Details

    • getRows

      List<IWebRowDataCollection> getRows()
      returns a List of IRow objects
      Returns:
      a List of IRow objects

    • getContextRowIterator

      de.uplanet.lucy.server.businesslogic.rtappservices.IWebRowDataCollectionContextIterator getContextRowIterator()
      Returns a context row iterator. Current binding context will be set to the current row. On finish the context will reset to the beginning state.

    • getDC

      de.uplanet.lucy.server.businesslogic.rtappservices.IWebRecordDataCollection getDC()
      Returns:
      Returns the data collection of the page.

    • 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

    • getParentId

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

    • getAppGuid

      String getAppGuid()
      returns the application GUID
      Returns:
      Returns the application GUID

    • getQuery

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

    • hasPermission

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

    • getTotalCount

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

    • getAttribute

      String getAttribute(String p_strName)
      returns an attribute's value by its name. Attributes are part of the datarange header and footer.
      Parameters:
      p_strName - an attribute name
      Returns:
      a String containing the value for the given attribute

    • getPreSelectControlsStr

      String getPreSelectControlsStr()
      returns the String that is given by the request for evaluating preSelect controls
      Returns:
      a String representing the request parameter

    • getPreSelectControls

      List<?> getPreSelectControls()
      returns a list of lists that hold control information
      Returns:
      a List

    • getResizerList

      List<ResizerListItem> getResizerList()
      returns a List of values for the resizer control
      Returns:
      a List of ResizerListItem's values

    • getResizerList

      List<ResizerListItem> getResizerList(int p_iMax)
      returns a List of values for the resizer control
      Parameters:
      p_iMax - Maximum number in the resizer list.
      Returns:
      a List of ResizerListItem's values

    • getDataRangeControlInfo

      DataRangeChildControlInfoList getDataRangeControlInfo()
      Returns the child control infos
      Returns:
      p_childControlList a DataRangeChildControlInfo

    • getUserTimeZone

      TimeZone getUserTimeZone()
      returns the TimeZone
      Returns:
      a TimeZone instance

    • getSysident

      String getSysident()
      returns the sysident for this control
      Returns:
      the sysident for this control

    • getPropertyVH

      <T> IValueHolder<T> getPropertyVH(String p_strGuidOrName)

    • getPropertiesVH

      de.uplanet.lucy.server.businesslogic.rtappservices.IPropertiesMap getPropertiesVH()

    • getDrSortItems

      de.uplanet.lucy.server.businesslogic.util.DrSortItemList getDrSortItems()
      Returns:
      A sorted copy of the DrSortItemList

    • getBinding

      IIxValue getBinding(String p_strBinding)
      Parameters:
      p_strBinding - The binding string
      Returns:
      The binding or null if no value found for the binding.
      Throws:
      IllegalArgumentException - will thrown if an invalid binding is set.

    • getBinding

      IIxValue getBinding(String p_strBinding, Object p_default)
      Parameters:
      p_strBinding - The binding string
      p_default - Will returned if no binding found. If the type is not an IIxValue instance, A IIxValue instance will created with IxValueFactory#create(p_default) and returned.
      Returns:
      The binding or the given default value.
      Throws:
      IllegalArgumentException - will thrown if an invalid binding is set.

    • getSystemProperty

      IIxValue getSystemProperty(String p_strName)
      Parameters:
      p_strName - The system data group field name
      Returns:
      Returns the property of the the system data group or null if not exists.
      Throws:
      IllegalArgumentException - if no system property found, with the given name.

    • getSystemProperty

      IIxValue getSystemProperty(String p_strName, Object p_default)
      Parameters:
      p_strName - The system data group field name
      p_default - Will returned if no binding found. If the type is not an IIxValue instance, A IIxValue instance will created with IxValueFactory#create(p_default) and returned.
      Returns:
      Returns the property of the the system data group or null if not exists.
      Throws:
      IllegalArgumentException - if no system property found, with the given name.

    • getSystemPropertyVH

      <T> IValueHolder<T> getSystemPropertyVH(String p_strName)
      Parameters:
      p_strName - The system data group field name
      Returns:
      Returns the property of the the system data group or null if not exists.
      Throws:
      IllegalArgumentException - if no system property found, with the given name.

    • getSystemPropertyVH

      IValueHolder<?> getSystemPropertyVH(String p_strName, Object p_default)
      Parameters:
      p_strName - The system data group field name
      p_default - Will returned if no binding found. If the type is not an IIxValue instance, A IIxValue instance will created with IxValueFactory#create(p_default) and returned.
      Returns:
      Returns the property of the the system data group or null if not exists.
      Throws:
      IllegalArgumentException - if no system property found, with the given name.

    • hasSystemProperty

      boolean hasSystemProperty(String p_strName)
      Parameters:
      p_strName - The system property name
      Returns:
      Returns true if a system property with the given name exists or false if not. (Checks only the existing, not if a value is present or not)