com.ibm.mashups.enabler.user
Interface Entity

All Superinterfaces:

Identifiable

public Entity
extends Identifiable

Interface representing an entity which acts as a base class for a user or a group

Method Summary

String	getDisplayName() Returns a useful display name.
String	getCN() Returns the value of user LDAP CN attribute
String	getAttribute(String name) Returns the value of the given attribute name
String[]	getReadOnlyAttributeNames() Returns the read only attribute names as string array.
String[]	getReadWriteAttributeNames() Returns the readable and writable attribute names as string array.
String[]	getAttributeNames() Returns all the attribute names as string array.
Boolean	isVirtual() Returns if this Entity is virtual.
VirtualType	getVirtualType() Returns the type of virtual entity, or null if the entity is not virtual
String	getEntityType() Returns the type of entity.

Methods inherited from interface com.ibm.mashups.enabler.Identifiable

getID

Method Detail

getDisplayName

String getDisplayName()

Returns a useful display name. Currently CN + SN for users and CN for groups

Returns:

the display name; may be null.

getCN

String getCN()

Returns the value of user LDAP CN attribute

Returns:

the value of the CN attritibute; may be null.

getAttribute

String getAttribute(String name)

Returns the value of the given attribute name

Parameters:

name - the attribute name to look up

Returns:

the value of the given attribute name; may be null.

getReadOnlyAttributeNames

String[] getReadOnlyAttributeNames()

Returns the read only attribute names as string array.

Returns:

all attributes names as string array; never null.

getReadWriteAttributeNames

String[] getReadWriteAttributeNames()

Returns the readable and writable attribute names as string array.

Returns:

all attributes names as string array; never null.

getAttributeNames

String[] getAttributeNames()

Returns all the attribute names as string array.

Returns:

all attributes names as string array; never null.

isVirtual

Boolean isVirtual()

Returns if this Entity is virtual.

Returns:

if this Entity is virtual

getVirtualType

VirtualType getVirtualType()

Returns the type of virtual entity, or null if the entity is not virtual

Returns:

the virtual type of the entity. May be null.

getEntityType

String getEntityType()

Returns the type of entity. Maybe 'user" or 'group'

Returns:

the type. Must not be null.