Interface IWebDataRange
- All Known Implementing Classes:
de.uplanet.lucy.server.businesslogic.rtappservices.AbstractWebDataRange
,WebDataRange
,WebShapedTableRange
public interface IWebDataRange
-
Method Summary
Modifier and TypeMethodDescriptionreturns the application GUIDgetAttribute
(String p_strName) returns an attribute's value by its name.getBinding
(String p_strBinding) getBinding
(String p_strBinding, Object p_default) de.uplanet.lucy.server.businesslogic.rtappservices.IWebRowDataCollectionContextIterator
Returns a context row iterator.returns the data group GUIDReturns the child control infosreturns the GUID of the datarangereturns the name of the datarangede.uplanet.lucy.server.businesslogic.rtappservices.IWebRecordDataCollection
getDC()
de.uplanet.lucy.server.businesslogic.util.DrSortItemList
returns the parent idList<?>
returns a list of lists that hold control informationreturns the String that is given by the request for evaluating preSelect controlsde.uplanet.lucy.server.businesslogic.rtappservices.IPropertiesMap
<T> de.uplanet.lucy.server.dataobjects.IValueHolder<T>
getPropertyVH
(String p_strGuidOrName) getQuery()
Returns the Query String that created the list.returns aList
of values for the resizer controlgetResizerList
(int p_iMax) returns aList
of values for the resizer controlgetRows()
returns aList
ofIRow
objectsreturns the sysident for this controlgetSystemProperty
(String p_strName) getSystemProperty
(String p_strName, Object p_default) <T> de.uplanet.lucy.server.dataobjects.IValueHolder<T>
getSystemPropertyVH
(String p_strName) de.uplanet.lucy.server.dataobjects.IValueHolder<?>
getSystemPropertyVH
(String p_strName, Object p_default) int
returns theTimeZone
boolean
Method hasPermission returns the value of the internal member.boolean
hasSystemProperty
(String p_strName)
-
Method Details
-
getRows
List<IWebRowDataCollection> getRows()returns aList
ofIRow
objects- Returns:
- a
List
ofIRow
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
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 aList
of values for the resizer control- Returns:
- a
List
of ResizerListItem's values
-
getResizerList
returns aList
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 theTimeZone
- Returns:
- a
TimeZone
instance
-
getSysident
String getSysident()returns the sysident for this control- Returns:
- the sysident for this control
-
getPropertyVH
-
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
- 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
- Parameters:
p_strBinding
- The binding stringp_default
- Will returned if no binding found. If the type is not an IIxValue instance, A IIxValue instance will created withIxValueFactory#create(p_default)
and returned.- Returns:
- The binding or the given default value.
- Throws:
IllegalArgumentException
- will thrown if an invalid binding is set.
-
getSystemProperty
- 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
- Parameters:
p_strName
- The system data group field namep_default
- Will returned if no binding found. If the type is not an IIxValue instance, A IIxValue instance will created withIxValueFactory#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
- 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
de.uplanet.lucy.server.dataobjects.IValueHolder<?> getSystemPropertyVH(String p_strName, Object p_default) - Parameters:
p_strName
- The system data group field namep_default
- Will returned if no binding found. If the type is not an IIxValue instance, A IIxValue instance will created withIxValueFactory#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
- Parameters:
p_strName
- The system property name- Returns:
- Returns
true
if a system property with the given name exists orfalse
if not. (Checks only the existing, not if a value is present or not)
-