Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.action
Interface EntityAware

All Known Implementing Classes:
AbuseAction, Accountbox, AddressBookAction, AddressBookAddAction, AddressBookRemoveAction, AddressBookViewAction, AnnounceAction, AnnounceDeleteAction, AnnounceEditAction, AnnounceExpireAction, AttachAction, AttachmentSettingsAction, AvatarDisplayAction, AvatarModerationAction, AvatarSetActiveAction, AvatarSettingsAction, AvatarUploadAction, AvatarUserDeleteAction, AvatarUserUploadAction, BranchAction, Breadcrumbs, BulkModerateAction, ChangePasswordAction, Click, CommunityEverywhereSettings, CreateProfile, DeleteAction, DeletePrivateMessageAction, DeleteProfileFields, DraftsAction, DraftsDeleteAction, EditAction, EditAttachAction, EditProfile, EditProfileAction, EditProfileField, EditProfileFieldOptions, EditRenderFilter, EditTagsAction, EditUserProfile, EditWatchesAction, EmailResetPasswordToken, FilterSettings, ForumAction, ForumActionSupport, ForumCategoryAction, ForumThreadAction, GuestSettingsAction, HelpAction, ListProfileFields, LockThreadAction, MarkPrivateMessageAction, MovePrivateMessageAction, MoveProfileFieldDown, MoveProfileFieldUp, MoveThreadAction, MyRewardsAction, OldEditAction, OldPostAction, OnlineAction, ParameterNameDispatchAction, PluginSettingsAction, PollAction, PollDeleteAction, PollEditAction, PollExpireAction, PollPostAction, PollsViewAction, PollViewAction, PollVoteAction, PostAction, PostAnnounceAction, PrivateMessageFolderAction, PrivateMessageFolderAddAction, PrivateMessageFolderDeleteAction, PrivateMessageFolderEditAction, PrivateMessagePostAction, PrivateMessagesAction, PrivateMessageViewAction, ProfileAction, ProfileFieldWizard, ProfileFieldWizard2, ProfileRedirectAction, RatingAddAction, ReadAction, RecentHistoryAction, ResetPassword, RewardsAction, RosterAction, SearchAction, SearchProfile, SpellAction, StatusLevelLeadersAction, TagAction, TagCloudAction, TagsAction, UnlockThreadAction, UserAvatarAction, UserPicker, UserSearch, UserSettingsAction, ValidateAction, ViewProfile, WatchesAction

public interface EntityAware

An interface meant to be used by actions. Implementing this interface means the action can get a handle on a specific object. An entity in the system is an object like a user, group, KB document, forum, thread, etc. This interface is meant to be used by actions as a way for an action to communicate what object it's using. For example, an action that loads a Poll


Method Summary
 EntityDescriptor getEntityDescriptor(java.util.Map parameters)
          Returns information (ID, type) about a specific type given a Map of parameters.
 

Method Detail

getEntityDescriptor

EntityDescriptor getEntityDescriptor(java.util.Map parameters)
Returns information (ID, type) about a specific type given a Map of parameters. The parameters are expected to be String keys with Long values. If the parameter is not found, null is returned.

Parameters:
parameters - a Map of parameters with String keys and Long values.
Returns:
a descriptor of the object (ID and type) or null if the entity was not found.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.