de.uplanet.lucy.server.businesslogic.rtappservices
Class DataCollection

java.lang.Object
  extended by de.uplanet.lucy.server.businesslogic.rtappservices.DataCollection

public class DataCollection
extends java.lang.Object

This class holds an array of DataRecord objects and a list of DataRange objects. An instance of this class is created by the application service, filled by a data service and read for output by the composing mechanism.

Version:
$Revision: 79300 $

Constructor Summary
DataCollection(de.uplanet.lucy.server.businesslogic.util.IControlRecord[] p_dataRecord, java.util.Map<java.lang.String,java.lang.Object> p_dataRanges, java.util.Map<java.lang.String,java.lang.Object> p_dataContainer)
           
 
Method Summary
 java.lang.String getAttribute(java.lang.String p_strName)
          Deprecated. use getValueHolder(java.lang.String) instead
 java.lang.String getAttributeBySysident(java.lang.String p_strSysident)
          Deprecated. use getValueHolderBySysident(java.lang.String) instead
 java.lang.Object getDataContainer(java.lang.String p_strName)
           
 de.uplanet.lucy.server.businesslogic.util.IDataRange getDataRange(java.lang.String p_strName)
          Returns a data range by its name.
 de.uplanet.lucy.server.businesslogic.util.IDataRange getDataRangeBySysident(java.lang.String p_strSysIdent)
          Returns a data range by its name.
 java.lang.Object getFWResult(java.lang.String p_strName)
          get Filewalker result data
 de.uplanet.lucy.server.businesslogic.util.Navigator getNavigator()
           
 java.util.List<de.uplanet.lucy.server.businesslogic.util.ListBoxOption> getOptions(java.lang.String p_strName)
          Returns a List of ListBoxOption-objects for a given control.
 java.lang.String getParentId()
          Returns the ParentId of the main data record as String.
 java.util.Map<java.lang.String,java.lang.String> getProperties()
          Deprecated. 
 java.util.Map<java.lang.String,IValueHolder<?>> getPropertiesVH()
          Returns the properties ValueHolders (unmodifiable).
 java.lang.String getRecId()
          returns the RecId of the main data record as String.
 java.lang.String getUserId()
          Returns the user id as a string.
 IValueHolder<?> getValueHolder(java.lang.String p_strName)
          Returns a value holder containing the value of the requested attribute
 IValueHolder<?> getValueHolderBySysident(java.lang.String p_strSysident)
          Returns an attribute value holder by its control sysident.
 java.lang.String getValueStr(java.lang.String p_strName)
          Deprecated. 
 java.lang.String getValueStrByFieldGuid(java.lang.String p_strFieldGuid)
           
 java.lang.String getValueStrBySysident(java.lang.String p_strSysident)
          Returns an attribute's value by its control sysident without any output transformations.
 void setDataOptions(de.uplanet.lucy.server.businesslogic.util.IDataOptions p_dataOptions)
           
 void setPropertiesVH(java.util.Map<java.lang.String,IValueHolder<?>> p_properties)
          Sets the properties.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataCollection

public DataCollection(de.uplanet.lucy.server.businesslogic.util.IControlRecord[] p_dataRecord,
                      java.util.Map<java.lang.String,java.lang.Object> p_dataRanges,
                      java.util.Map<java.lang.String,java.lang.Object> p_dataContainer)
Parameters:
p_dataRecord - An array of IControlRecord objects.
p_dataRanges - A Map of IDataRange objects.
Method Detail

getDataRange

public de.uplanet.lucy.server.businesslogic.util.IDataRange getDataRange(java.lang.String p_strName)
                                                                  throws de.uplanet.lucy.server.businesslogic.BlException
Returns a data range by its name.

Parameters:
p_strName - The datarange name.
Returns:
a IDataRange object
Throws:
a - BlException
de.uplanet.lucy.server.businesslogic.BlException

getDataRangeBySysident

public de.uplanet.lucy.server.businesslogic.util.IDataRange getDataRangeBySysident(java.lang.String p_strSysIdent)
                                                                            throws de.uplanet.lucy.server.businesslogic.BlException
Returns a data range by its name.

Parameters:
p_strSysIdent - The datarange sysident.
Returns:
a IDataRange object
Throws:
a - BlException
de.uplanet.lucy.server.businesslogic.BlException

getAttribute

@Deprecated
public java.lang.String getAttribute(java.lang.String p_strName)
Deprecated. use getValueHolder(java.lang.String) instead

Returns an attribute value by its name.

Parameters:
p_strName - an attribute name
Returns:
A string containing the value for the given attribute.

getAttributeBySysident

@Deprecated
public java.lang.String getAttributeBySysident(java.lang.String p_strSysident)
Deprecated. use getValueHolderBySysident(java.lang.String) instead

Returns an attribute value by its control sysident.

Parameters:
p_strSysident - an attribute control sysident
Returns:
A string containing the value for the given attribute.

getValueHolderBySysident

public IValueHolder<?> getValueHolderBySysident(java.lang.String p_strSysident)
Returns an attribute value holder by its control sysident.

Parameters:
p_strSysident - an attribute control sysident
Returns:
A value holder containing the value for the given attribute.

getValueStr

@Deprecated
public java.lang.String getValueStr(java.lang.String p_strName)
Deprecated. 

Returns an attribute's value by its name without any output transformations. e.g. date is returned in ISO notification YYYY-MM-DD HH:MM:SS

Parameters:
p_strName -
Returns:
String as raw value

getValueHolder

public IValueHolder<?> getValueHolder(java.lang.String p_strName)
Returns a value holder containing the value of the requested attribute

Parameters:
p_strName - The attributes name
Returns:
A value holder

getValueStrBySysident

public java.lang.String getValueStrBySysident(java.lang.String p_strSysident)
Returns an attribute's value by its control sysident without any output transformations. e.g. date is returned in ISO notification YYYY-MM-DD HH:MM:SS

Parameters:
p_strSysident - the control sysident
Returns:
String as raw value

getValueStrByFieldGuid

public java.lang.String getValueStrByFieldGuid(java.lang.String p_strFieldGuid)

getOptions

public java.util.List<de.uplanet.lucy.server.businesslogic.util.ListBoxOption> getOptions(java.lang.String p_strName)
Returns a List of ListBoxOption-objects for a given control. If no datarecord is available or no ListBox is available then an empty list is returned.

Parameters:
p_strName - a control name
Returns:
a List of ListBoxOption-objects

getRecId

public java.lang.String getRecId()
returns the RecId of the main data record as String. If no data record is available the an empty string is returned.

Returns:
the RecId as String

getParentId

public java.lang.String getParentId()
Returns the ParentId of the main data record as String. If no data record is available the an empty string is returned.

Returns:
the RecId as String

getUserId

public java.lang.String getUserId()
Returns the user id as a string.

Returns:
The user id as a string.

getProperties

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getProperties()
Deprecated. 

Returns the properties.


getPropertiesVH

public java.util.Map<java.lang.String,IValueHolder<?>> getPropertiesVH()
Returns the properties ValueHolders (unmodifiable).


setPropertiesVH

public void setPropertiesVH(java.util.Map<java.lang.String,IValueHolder<?>> p_properties)
Sets the properties.

Parameters:
p_properties - The m_properties to set

setDataOptions

public void setDataOptions(de.uplanet.lucy.server.businesslogic.util.IDataOptions p_dataOptions)
Parameters:
p_dataOptions - a dataOption object holding controls with DataSources without any record object.

getNavigator

public de.uplanet.lucy.server.businesslogic.util.Navigator getNavigator()
Returns:
a navigator object if the page contains a navigator control otherwise null

getFWResult

public java.lang.Object getFWResult(java.lang.String p_strName)
                             throws de.uplanet.lucy.server.businesslogic.BlException
get Filewalker result data

Throws:
de.uplanet.lucy.server.businesslogic.BlException

getDataContainer

public java.lang.Object getDataContainer(java.lang.String p_strName)


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.