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.

Version:
$Revision: 86610 $

Method Summary
 void clearRows()
          clears the rows
 java.lang.String getAppGuid()
          returns the application guid
 de.uplanet.lucy.types.IContainerType getContainerType()
          Method getContainerType.
 java.lang.String getDataAppGuid()
          returns the guid of the application that holds the data.
 java.lang.String getDataGroupGuid()
          returns the data group GUID
 de.uplanet.lucy.constants.DR_FLAG getDatarangeFlag()
          returns the datarange flag
 java.lang.String getDataRangeGuid()
          returns the GUID of the datarange
 de.uplanet.lucy.server.rtcache.DataRangeControlInfo getDatarangeInfo()
          Method getDatarangeInfo builds a new DatarangeInfo Object to return current attributes.
 java.lang.String getDatarangeName()
          returns the name of the datarange
 java.util.List<java.lang.String> getDistinctFields()
          returns a list of field GUIDs
 java.util.List<java.lang.String> getFieldGuidList()
          Returns a list of field guids.
 de.uplanet.lucy.server.businesslogic.util.IRtFilter getFilter()
          returns an dataaccess filter
 int getMaxPagesCount()
          Used to optimize tables with a lot of records.
 int getPageNumber()
          returns the page number
 int getPageSize()
          returns the page size
 java.lang.String getParentId()
          returns the parent id
 java.util.Map<java.lang.String,java.lang.String> getPreSelectFields()
          Deprecated. use getPreSelectFieldsVH instead
 java.util.Map<java.lang.String,IValueHolder<?>> getPreSelectFieldsVH()
          returns a map of preselect field
 int getPreSelectLevel()
          returns the preselect level
 java.lang.String getQuery()
          Returns the Query String that created the list.
 java.util.List<de.uplanet.lucy.server.businesslogic.util.IRow> getRows()
          returns a List of IRow objects
 java.util.List<de.uplanet.lucy.server.businesslogic.util.SortByInfo> getSortbyFields()
          returns a list of field ids
 int getTextAreaMaxSize()
          returns the max. text area size
 boolean hasPermission()
          Method hasPermission returns the value of the internal member.
 void initDataRangeInfo(de.uplanet.lucy.server.rtcache.DataRangeControlInfo p_containerControlInfo)
          sets a ContainerControlInfo for this datarange
 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.
 boolean needsToSelectParentField()
           
 boolean needsToSelectRowCount()
          Control if the total record count should be determined or not.
 boolean needsToSelectRows()
          Control if the records should be selected or not.
 void setAppGuid(java.lang.String p_strAppGuid)
          Sets the application guid.
 void setAttribute(java.lang.String p_strAttrName, java.lang.String p_strValue)
          sets a datarange attribute like PAGECOUNT, etc.
 void setFilter(de.uplanet.lucy.server.businesslogic.util.IRtFilter p_filter)
          set an dataaccess filter
 void setMaxPagesCount(int p_iMaxPageCount)
          Used to optimize tables with a lot of records.
 void setNeedsToSelectRowCount(boolean p_bNeedsToSelectCount)
          Control if the total record count should be determined or not.
 void setNeedsToSelectRows(boolean p_bSelectNeeded)
           
 void setPageNumber(int p_iPageNumber)
          sets the page number
 void setPageSize(int p_iPageSize)
          sets the page size
 void setParentId(java.lang.String p_strParendId)
          sets the parent id
 void setPermission(boolean p_bHasPermission)
          Method setPermission sets the internal member that holds the hasPermission status
 void setPreSelectLevel(int p_iLevel)
          sets the preselectLevel
 void setPropertyForEveryRowVH(java.lang.String p_strFieldGuid, IValueHolder<?> p_vhValue)
          Set the property value for every row that exists
 void setQuery(java.lang.String p_strQuery)
          Sets the Query String that created the list.
 void setTotalCount(int p_iTotalCount)
           
 void setUserIdForRow(java.lang.String p_strUserId)
          Set the user ID for the current row
 
Methods inherited from interface de.uplanet.lucy.server.businesslogic.util.IDataCollection
fetchRowDataReady, getRow, setParentIdPerRow, setRecId, setValue
 

Method Detail

getRows

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

Returns:
a List of IRow objects

getSortbyFields

java.util.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

java.util.List<java.lang.String> getDistinctFields()
returns a list of field GUIDs

Returns:
a list containing field GUIDs

getPreSelectFields

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getPreSelectFields()
Deprecated. use getPreSelectFieldsVH instead

returns a map of preselect field

Returns:
a map of pairs

getPreSelectFieldsVH

java.util.Map<java.lang.String,IValueHolder<?>> getPreSelectFieldsVH()
returns a map of preselect field

Returns:
a map of 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

java.lang.String getDataRangeGuid()
returns the GUID of the datarange

Returns:
the GUID of the datarange

getDataGroupGuid

java.lang.String getDataGroupGuid()
returns the data group GUID

Returns:
the data group GUID

getDatarangeName

java.lang.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

java.util.List<java.lang.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

java.lang.String getParentId()
returns the parent id

Returns:
the parent id as String

getAppGuid

java.lang.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

Returns:
page size

getPageNumber

int getPageNumber()
returns the page number

Returns:
page number

getDataAppGuid

java.lang.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(java.lang.String p_strAttrName,
                  java.lang.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(de.uplanet.lucy.server.rtcache.DataRangeControlInfo p_containerControlInfo)
sets a ContainerControlInfo for this datarange

Parameters:
p_containerControlInfo -

setAppGuid

void setAppGuid(java.lang.String p_strAppGuid)
Sets the application guid.

Parameters:
p_strAppGuid -

setParentId

void setParentId(java.lang.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

Parameters:
p_iPageNumber - the page number

setPageSize

void setPageSize(int p_iPageSize)
sets the page size

Parameters:
p_iPageSize - the page size

getContainerType

de.uplanet.lucy.types.IContainerType getContainerType()
Method getContainerType.

Returns:
IContainerType

getDatarangeInfo

de.uplanet.lucy.server.rtcache.DataRangeControlInfo getDatarangeInfo()
Method getDatarangeInfo builds a new DatarangeInfo Object to return current attributes.

Returns:
DataRangeControlInfo

getQuery

java.lang.String getQuery()
Returns the Query String that created the list.

Returns:
String

setQuery

void setQuery(java.lang.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(java.lang.String p_strUserId)
Set the user ID for the current row


setTotalCount

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

needsToSelectParentField

boolean needsToSelectParentField()

setPropertyForEveryRowVH

void setPropertyForEveryRowVH(java.lang.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



Last updated: 2012-07-06 09-36
Copyright © 2000-2012 United Planet. All Rights Reserved.