com.sas.entities
Interface EntityKeyInterface

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

ActionList, ActionSupportFilter, AddFolderAction, AddFolderCommand, AddFolderCommand, AddRowAction, AddRowCommand, AdvancedFilterSelectorCommand, AdvancedFilterSelectorCommandFacade, BaseAction, BaseCommand, BaseEditCommand, BaseEntity, com.sas.commands.olap.BaseOLAPCommand, BaseOLAPExportCommand, BaseRelationalExportCommand, BaseScrollCommand, BaseSelectorCommand, com.sas.commands.olap.BaseTupleElementCommand, CancelCommand, CancelRowInsertCommand, ClearCommand, ClearSortCommand, com.sas.commands.olap.CollapseCommand, CommitCommand, CommitInsertedRowCommand, CompositeDynamicAttributeCommand, CopyAction, CopyCommand, CopyCommand, CutAction, CutCommand, CutCommand, DataItemSelectorCommand, DeleteAction, DeleteCommand, DeleteCommand, DeleteCommand, DeleteRowAction, DeleteRowCommand, DetailsAction, DisplaySearchResultsCommand, DisplaySearchResultsCommand, com.sas.commands.olap.DrillDownCommand, com.sas.commands.olap.DrillUpCommand, Entity, ExceptionHighlightingChartCommand, ExceptionHighlightingCommand, com.sas.commands.olap.ExpandCommand, ExportSelectorCommand, ExportToCSVCommand, ExportToExcelCommand, ExportToExcelXMLCommand, ExportToHTMLCommand, ExportToTabSeparatedCommand, FilterAndRankSelectorCommand, FilterTypeCommand, FindAction, FindCommand, FindSelectorCommand, FormatSelectorCommand, GoBackAction, GoBackCommand, GotoColumnCommand, GotoRowCommand, HideColumnCommand, HoldColumnCommand, HoldRowCommand, HttpAction, HttpSearchCommand, InsertCommand, InsertRowCommand, ListAction, MapBaseCommand, MapClearSelectionsCommand, MapCollapseCommand, MapDrillDownCommand, MapDrillUpCommand, MapExpandCommand, MapExportToExcelCommand, MapFilterSelectionsCommand, MapFullExtentsCommand, MapIdentifyCommand, MapPanCommand, MapPropertyCommand, MapRectangularSelectCommand, MapReportLinkingCommand, MapResizeCommand, MapSelectCommand, MapSetMeasureCommand, MapZoomInCommand, MapZoomOutCommand, MemberPropertiesCommand, MoveColumnAction, MoveColumnCommand, OLAPExportToCSVCommand, OLAPExportToExcelXMLCommand, OLAPExportToHTMLCommand, OLAPExportToTabSeparatedCommand, OLAPSortSelectorCommand, OLAPTimeBasedFilterCommand, OpenFolderAction, OpenFolderCommand, OpenFolderCommand, PasteAction, PasteCommand, PasteCommand, PasteCommand, PercentCalculationsCommand, RankingCommand, ReleaseAllColumnsCommand, ReleaseAllRowsCommand, ReleaseColumnCommand, ReleaseRowCommand, RenameAction, RenameCommand, RenameCommand, com.sas.actionprovider.support.graphics.ResizeCommand, ScrollFirstColumnCommand, ScrollFirstRowCommand, ScrollLastColumnCommand, ScrollLastRowCommand, ScrollNextColumnCommand, ScrollNextColumnPageCommand, ScrollNextRowCommand, ScrollNextRowPageCommand, ScrollPreviousColumnCommand, ScrollPreviousColumnPageCommand, ScrollPreviousRowCommand, ScrollPreviousRowPageCommand, SelectorAction, SelectorAction, ShowAllColumnsCommand, ShowColumnCommand, ShowColumnHeaderCommand, ShowDetailSelectorCommand, ShowRowHeaderCommand, SimpleCalculatedItemSelectorCommand, SortAction, SortCommand, SortCommand, SortFoldersFirstCommand, SortFoldersFirstCommand, SortSelectorCommand, StartSearchAction, StartSearchCommand, SwingAction, TableViewAction, TableViewActionSupportFilter, TotalsCommand, TreeAction, UpdateCommand, UpOneLevelAction, UpOneLevelCommand, ViewMenuAction, ViewSelectionAction

public interface EntityKeyInterface
extends java.rmi.Remote

EntityKeyInterface provides methods for Entities that contain Globally Unique Identifiers (sometimes known as GUIDs). These keys can serve as data base keys for locating the Entities.

Method Summary

java.lang.String	getEntityKey() Return this Entity's unique key.
boolean	sameEntity(EntityKeyInterface entity) Test if this Entity's key equals the key of another Entity.
void	setEntityKey(java.lang.String key) Assign an entity key to the Entity.

Method Detail

getEntityKey

java.lang.String getEntityKey()
                              throws java.rmi.RemoteException

Return this Entity's unique key.

Returns:

this Entity's unique key

Throws:

java.rmi.RemoteException - if there was an IO error communicating with the remote entity

setEntityKey

void setEntityKey(java.lang.String key)
                  throws java.rmi.RemoteException,
                         java.lang.IllegalStateException

Assign an entity key to the Entity.

Parameters:

key - the key with which this Entity can be identified

Throws:

java.rmi.RemoteException - if there was an IO error communicating with the RemoteEntity

java.lang.IllegalStateException - if the Entity already has a non-null key. Not all entity implementations are required to throw this exception; some may allow replacing a non-null key.

sameEntity

boolean sameEntity(EntityKeyInterface entity)
                   throws java.rmi.RemoteException

Test if this Entity's key equals the key of another Entity.

Returns:

true if the other entity's key is the same as getEntityKey(). Return false if entity is null

Throws:

java.rmi.RemoteException - if there was an IO error communicating with the remote entity