com.sas.edir
Interface KeywordEntity

All Superinterfaces:

Caching, Entity, TrackedObject

All Known Subinterfaces:

Application, Archive, CatalogEntry, Channel, Content, ContentChannel, ContentDocument, ContentItem, ExternalFile, KeywordEntityCollection, Link, Mddb, StoredProcess, Table, WebEisDocument, Widget

public interface KeywordEntity

extends Entity

An interface for Enterprise Directory entities which all the keyword attribute. This provides a common way to access and manipulate the keywords.

Version:

1.0

Author:

SAS

Fields inherited from interface com.sas.edir.Entity

PROPERTY_CHANGED, SUBPROPERTY_CHANGED

Method Summary

void	addKeyword(java.lang.String keyword) Adds a keyword to this entity.
java.util.Iterator	keywordIterator() Returns an iteration of all the keywords associated with this entity.
java.util.ListIterator	keywordIterator(java.util.Comparator compare) Returns a sorted iteration of all the keywords associated with this entity.
void	removeKeyword(java.lang.String keyword) Removes a keyword from this entity.
void	setKeywords(java.util.List keywords) Sets the keywords for this entity.

Methods inherited from interface com.sas.edir.Entity

addPropertyChangeListener, getContext, getCreateTime, getCreatorsName, getDescription, getEnterpriseDirectory, getGuid, getModifiersName, getModifyTime, getName, getObjectclass, removeModificationItems, removePropertyChangeListener, setDescription, setGuid, setName, setObjectclass

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

Method Detail

keywordIterator

public java.util.Iterator keywordIterator()

Returns an iteration of all the keywords associated with this entity.

Returns:

A String iteration.

keywordIterator

public java.util.ListIterator keywordIterator(java.util.Comparator compare)

Returns a sorted iteration of all the keywords associated with this entity.

Parameters:

comparator - A Comparator for sorting, or null for no sorting.

Returns:

A String iteration.

addKeyword

public void addKeyword(java.lang.String keyword)

Adds a keyword to this entity.

Parameters:

keyword - The keyword to add.

Throws:

NamingException - Thrown for enterprise directory failure.

setKeywords

public void setKeywords(java.util.List keywords)

Sets the keywords for this entity.

Parameters:

keywords - The list of keywords.

Throws:

NamingException - Thrown for enterprise directory failure.

removeKeyword

public void removeKeyword(java.lang.String keyword)

Removes a keyword from this entity.

Parameters:

keyword - The keyword to remove.