lumis.doui.source.field.type
Class PrincipalDataType.Data

java.lang.Object
  lumis.portal.principal.PrincipalConfig
      lumis.doui.source.field.type.PrincipalDataType.Data

All Implemented Interfaces:

Cloneable, Principal, IRenderable, ICacheEntry, ICloneableCacheEntry

Enclosing class:

PrincipalDataType

public static class PrincipalDataType.Data
extends PrincipalConfig
implements IRenderable

Data object for a field with data type principal.

Since:

4.0.4

Field Summary

Fields inherited from class lumis.portal.principal.PrincipalConfig

TYPE_GROUP, TYPE_USER

Constructor Summary

PrincipalDataType.Data(GroupConfig groupConfig)

PrincipalDataType.Data(PrincipalConfig principalConfig)

PrincipalDataType.Data(String id, String shortId, String name, int type, int subType)

PrincipalDataType.Data(UserConfig userConfig)

Method Summary

String	getDisplayString(IRenderer renderer) Returns the string to be displayed for representing this instance, when a short display is required.
String	getRenderData(IRenderer renderer) Returns the data of this object in a standard xml format.

Methods inherited from class lumis.portal.principal.PrincipalConfig

clone, equals, getChannelId, getId, getName, getShortId, getSubType, getType, hashCode, setChannelId, setName, setShortId, setSubType, setType, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PrincipalDataType.Data

public PrincipalDataType.Data(String id,
                              String shortId,
                              String name,
                              int type,
                              int subType)

PrincipalDataType.Data

public PrincipalDataType.Data(PrincipalConfig principalConfig)

PrincipalDataType.Data

public PrincipalDataType.Data(GroupConfig groupConfig)

PrincipalDataType.Data

public PrincipalDataType.Data(UserConfig userConfig)

Method Detail

getRenderData

public String getRenderData(IRenderer renderer)
                     throws PortalException

Description copied from interface: IRenderable

Returns the data of this object in a standard xml format.

Specified by:

getRenderData in interface IRenderable

Parameters:

renderer - the renderer object that will use the returned render data.

Returns:

the xml data for this object.

Throws:

PortalException

getDisplayString

public String getDisplayString(IRenderer renderer)
                        throws PortalException

Description copied from interface: IRenderable

Returns the string to be displayed for representing this instance, when a short display is required.

Specified by:

getDisplayString in interface IRenderable

Parameters:

renderer - the renderer object that will use the returned render data.

Returns:

the string to be used to friendly display this instance.

Throws:

PortalException