Schnittstelle IDataRangeDataService
- Alle Superschnittstellen:
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.
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoidAdds a field GUID.voidclears the rowsreturns the application guidde.uplanet.lucy.types.CONTAINER_TYPEMethod getContainerType.returns the guid of the application that holds the data.returns the data group GUIDde.uplanet.lucy.constants.DR_FLAGreturns the datarange flagreturns the GUID of the datarangeMethod getDatarangeInfo builds a new DatarangeInfo Object to return current attributes.returns the name of the datarangede.uplanet.lucy.server.businesslogic.util.IDataRangeResultInforeturns a list of field GUIDsReturns a list of field guids.de.uplanet.lucy.server.businesslogic.util.IRtFilterreturns an dataaccess filterintgetLimit()intUsed to optimize tables with a lot of records.intintreturns the page number (only valid for paging modePAGING_MODE.PAGE)intreturns the page size (only valid for paging modePAGING_MODE.PAGE)de.uplanet.lucy.server.businesslogic.util.PAGING_MODEreturns the parent idVeraltet.use getPreSelectFieldsVH insteadMap<String, IValueHolder<?>> returns a map of preselect fieldintreturns the preselect levelgetQuery()Returns the Query String that created the list.List<de.uplanet.lucy.server.businesslogic.util.IRow> getRows()returns aListofIRowobjectsList<de.uplanet.lucy.server.businesslogic.util.SortByInfo> returns a list of field idsintreturns the max. text area sizeintbooleanMethod hasPermission returns the value of the internal member.voidinitDataRangeInfo(DataRangeControlInfo p_containerControlInfo) sets a ContainerControlInfo for this datarangebooleanCheck if this data range object gets it's data from a data group that belongs to the same application this data range belongs to.booleanbooleanControl if the total record count should be determined or not.booleanControl if the records should be selected or not.voidsetAppGuid(String p_strAppGuid) Sets the application guid.voidsetAttribute(String p_strAttrName, String p_strValue) sets a datarange attribute like PAGECOUNT, etc.voidsetFilter(de.uplanet.lucy.server.businesslogic.util.IRtFilter p_filter) set an dataaccess filtervoidsetLimit(int p_limt) set the limit of records to readPAGING_MODE.OFFSET_LIMITvoidsetMaxPagesCount(int p_iMaxPageCount) Used to optimize tables with a lot of records.voidsetNeedsToSelectRowCount(boolean p_bNeedsToSelectCount) Control if the total record count should be determined or not.voidsetNeedsToSelectRows(boolean p_bSelectNeeded) voidsetOffset(int p_offset) set the scroll offset and set the paging mode toPAGING_MODE.OFFSET_LIMITvoidsetPageNumber(int p_iPageNumber) sets the page number and the paging mode toPAGING_MODE.PAGEvoidsetPageSize(int p_iPageSize) sets the page size and the paging mode toPAGING_MODE.PAGEvoidsetPagingMode(de.uplanet.lucy.server.businesslogic.util.PAGING_MODE p_pagingMode) set the paging modevoidsetParentId(String p_strParendId) sets the parent idvoidsetPermission(boolean p_bHasPermission) Method setPermission sets the internal member that holds the hasPermission statusvoidsetPreSelectLevel(int p_iLevel) sets the preselectLevelvoidsetPropertyForEveryRowVH(String p_strFieldGuid, IValueHolder<?> p_vhValue) Set the property value for every row that existsvoidSets the Query String that created the list.voidsetRecordOwner(int p_iRowOwner) voidsetTotalCount(int p_iTotalCount) voidsetUserIdForRow(String p_strUserId) Set the user ID for the current rowVon Schnittstelle geerbte Methoden de.uplanet.lucy.server.businesslogic.util.IDataCollection
fetchRowDataReady, getRow, setParentIdPerRow, setRecId, setValue
-
Methodendetails
-
getRows
List<de.uplanet.lucy.server.businesslogic.util.IRow> getRows()returns aListofIRowobjects- Gibt zurück:
- a
ListofIRowobjects
-
getSortbyFields
List<de.uplanet.lucy.server.businesslogic.util.SortByInfo> getSortbyFields()returns a list of field ids- Gibt zurück:
- a list containing field ids that are used for sorting
-
getDistinctFields
returns a list of field GUIDs- Gibt zurück:
- a list containing field GUIDs
-
getPreSelectFields
Veraltet.use getPreSelectFieldsVH insteadreturns a map of preselect field- Gibt zurück:
- a map of (fieldid, value) pairs
-
getPreSelectFieldsVH
Map<String,IValueHolder<?>> getPreSelectFieldsVH()returns a map of preselect field- Gibt zurück:
- a map of (fieldid, value) pairs
-
getPreSelectLevel
int getPreSelectLevel()returns the preselect level- Gibt zurück:
- the preselect level
-
getFilter
de.uplanet.lucy.server.businesslogic.util.IRtFilter getFilter()returns an dataaccess filter- Gibt zurück:
- a Filter object
-
setFilter
void setFilter(de.uplanet.lucy.server.businesslogic.util.IRtFilter p_filter) set an dataaccess filter- Parameter:
p_filter-
-
getDataRangeGuid
String getDataRangeGuid()returns the GUID of the datarange- Gibt zurück:
- the GUID of the datarange
-
getDataGroupGuid
String getDataGroupGuid()returns the data group GUID- Gibt zurück:
- the data group GUID
-
getDatarangeName
String getDatarangeName()returns the name of the datarange- Gibt zurück:
- the name of the datarange as string
-
getDatarangeFlag
de.uplanet.lucy.constants.DR_FLAG getDatarangeFlag()returns the datarange flag- Gibt zurück:
- the datarange flag as enum
-
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.- Gibt zurück:
- Returns always a list of field guids, maybe empty.
-
getParentId
String getParentId()returns the parent id- Gibt zurück:
- the parent id as String
-
getAppGuid
String getAppGuid()returns the application guid- Gibt zurück:
- the app guid
-
getTextAreaMaxSize
int getTextAreaMaxSize()returns the max. text area size- Gibt zurück:
- max. text area size
-
getPageSize
int getPageSize()returns the page size (only valid for paging modePAGING_MODE.PAGE)- Gibt zurück:
- page size
-
getPageNumber
int getPageNumber()returns the page number (only valid for paging modePAGING_MODE.PAGE)- Gibt zurück:
- page number
-
getOffset
int getOffset()- Gibt zurück:
- 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 toPAGING_MODE.OFFSET_LIMIT -
getLimit
int getLimit()- Gibt zurück:
- 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()- Gibt zurück:
- Returns the
-
getDataAppGuid
String getDataAppGuid()returns the guid of the application that holds the data.- Gibt zurück:
- 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.- Gibt zurück:
trueif this data range object gets it's data from a data group that belongs to the same application this data range belongs to, orfalseotherwise.
-
setAttribute
sets a datarange attribute like PAGECOUNT, etc.- Parameter:
p_strAttrName- a String containing the name of the attributep_strValue- the value of this attribute
-
initDataRangeInfo
sets a ContainerControlInfo for this datarange- Parameter:
p_containerControlInfo-
-
setAppGuid
Sets the application guid.- Parameter:
p_strAppGuid-
-
setParentId
sets the parent id- Parameter:
p_strParendId- the parent id
-
setPreSelectLevel
void setPreSelectLevel(int p_iLevel) sets the preselectLevel- Parameter:
p_iLevel- the preselect level
-
setPageNumber
void setPageNumber(int p_iPageNumber) sets the page number and the paging mode toPAGING_MODE.PAGE- Parameter:
p_iPageNumber- the page number
-
setPageSize
void setPageSize(int p_iPageSize) sets the page size and the paging mode toPAGING_MODE.PAGE- Parameter:
p_iPageSize- the page size
-
getContainerType
de.uplanet.lucy.types.CONTAINER_TYPE getContainerType()Method getContainerType.- Gibt zurück:
CONTAINER_TYPE
-
getDatarangeInfo
DataRangeControlInfo getDatarangeInfo()Method getDatarangeInfo builds a new DatarangeInfo Object to return current attributes.- Gibt zurück:
- DataRangeControlInfo
-
getQuery
String getQuery()Returns the Query String that created the list.- Gibt zurück:
- String
-
setQuery
Sets the Query String that created the list.- Parameter:
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.- Gibt zurück:
- boolean
-
setUserIdForRow
Set the user ID for the current row -
setRecordOwner
void setRecordOwner(int p_iRowOwner) -
setTotalCount
void setTotalCount(int p_iTotalCount) - Parameter:
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- Parameter:
p_strFieldGuid- The field guid.p_vhValue- Value to set- Löst aus:
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. iffalseone database call will be saved.- Gibt zurück:
trueif 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- Gibt zurück:
- -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
Adds a field GUID.- Parameter:
p_strField- The field GUID.
-
getTotalCount
int getTotalCount()- Gibt zurück:
- total number of all records within the datarange.
-
getDataRangeResultInfo
de.uplanet.lucy.server.businesslogic.util.IDataRangeResultInfo getDataRangeResultInfo()
-