com.sas.edir
Interface Entity

All Superinterfaces:

Caching, TrackedObject

All Known Subinterfaces:

Application, Archive, CatalogEntry, Channel, Column, Content, ContentChannel, ContentDocument, ContentItem, Cube, DeliveryUser, Dimension, EntityCollection, EntityList, ExternalFile, FilteredEntityCollection, Group, Hierarchy, KeywordEntity, KeywordEntityCollection, Library, Link, Login, Map, Mddb, Profile, Server, StaticEntityCollection, StoredProcess, StoredProcessPath, StoredProcessResult, Subscriber, Table, User, WarehouseGroup, WarehouseView, WebEisDocument, Widget

All Known Implementing Classes:

NonExEntity

public interface Entity

extends Caching, TrackedObject

An entity defines common behavior for all enterprise entities. An enterprise entity represents a physical entity or concept that is defined in the enterprise directory. An entity provides:

• Access to common properties.
• A mechanism for updating cached information
• A mechanism for notifying listeners of property changes.

Version:

1.0

Author:

SAS

Field Summary

static java.lang.String	PROPERTY_CHANGED The property change fired when one or more properties in an entity change.
static java.lang.String	SUBPROPERTY_CHANGED The property change fired when one or more properties in an entity contained within the entity change.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a property change listener to the listener list.
java.lang.String	getContext() Returns the context of this entity in the enterprise directory.
java.lang.String	getCreateTime() Get operational attribute with creation time stamp.
java.lang.String	getCreatorsName() Get operational attribute with Creator's DN
java.lang.String	getDescription() Returns this entities' description.
EnterpriseDirectory	getEnterpriseDirectory() Returns the enterprise directory service.
java.lang.String	getGuid() Returns this entities' GUID.
java.lang.String	getModifiersName() Get operational attribute with Modifier's DN
java.lang.String	getModifyTime() Get operational attribute with last modified time stamp.
java.lang.String	getName() Returns this entities' name.
java.lang.String	getObjectclass() Returns the objectClass of this entity.
void	removeModificationItems() Removes any unprocessed Modification Items
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a property change listener from the listener list.
void	setDescription(java.lang.String description) Sets this entities' description.
void	setGuid(java.lang.String guid) Sets this entities' GUID.
void	setName(java.lang.String name) Sets this entities' name.
void	setObjectclass(java.lang.String objectClass) Sets the LDAP object class for this entity.

Methods inherited from interface com.sas.edir.Caching

edirUpdateStore, getTimeToLive, isExpired, refreshCache, refreshCachedObjects, releaseCache, setDirty, setTimeToLive, setTimeToLive, updateStore

Methods inherited from interface com.sas.edir.TrackedObject

getTrackingId, getUserData, setUserData

Field Detail

PROPERTY_CHANGED

public static final java.lang.String PROPERTY_CHANGED

The property change fired when one or more properties in an entity change.

SUBPROPERTY_CHANGED

public static final java.lang.String SUBPROPERTY_CHANGED

The property change fired when one or more properties in an entity contained within the entity change.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a property change listener to the listener list.

Parameters:

listener - The property change listener.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a property change listener from the listener list.

Parameters:

listener - The property change listener.

getContext

public java.lang.String getContext()

Returns the context of this entity in the enterprise directory.

Returns:

The context.

getDescription

public java.lang.String getDescription()

Returns this entities' description.

Returns:

The description or null if one does not exist.

setDescription

public void setDescription(java.lang.String description)

Sets this entities' description.

This change is not persisted to the enterprise directory until updateStore is called.

Parameters:

description - The description.

getEnterpriseDirectory

public EnterpriseDirectory getEnterpriseDirectory()

Returns the enterprise directory service.

Returns:

The enterprise directory service.

getName

public java.lang.String getName()

Returns this entities' name.

Returns:

The name or null if one does not exist.

setName

public void setName(java.lang.String name)

Sets this entities' name.

This change is not persisted to the enterprise directory until updateStore is called.

Parameters:

name - The name.

getObjectclass

public java.lang.String getObjectclass()

Returns the objectClass of this entity. Each Subclass should set this value in the new method.

Returns:

The entity's LDAP object class

setObjectclass

public void setObjectclass(java.lang.String objectClass)

Sets the LDAP object class for this entity.

Parameters:

objectClass - the object Class for this entity

getCreatorsName

public java.lang.String getCreatorsName()

Get operational attribute with Creator's DN

Returns:

String with the creating user's DN

getModifiersName

public java.lang.String getModifiersName()

Get operational attribute with Modifier's DN

Returns:

String with last modifying user's DN

getCreateTime

public java.lang.String getCreateTime()

Get operational attribute with creation time stamp.

Returns:

String with creation time stamp.

getModifyTime

public java.lang.String getModifyTime()

Get operational attribute with last modified time stamp.

Returns:

String with last modification time stamp.

removeModificationItems

public void removeModificationItems()

Removes any unprocessed Modification Items

getGuid

public java.lang.String getGuid()

Returns this entities' GUID.

Returns:

The GUID or null if one does not exist.

setGuid

public void setGuid(java.lang.String guid)

Sets this entities' GUID.

This change is not persisted to the enterprise directory until updateStore is called.

Parameters:

guid - The GUID.