com.plumtree.uiinfrastructure.activityspace
Interface IControl

All Superinterfaces:

IManagedObject, IMVCObject

All Known Subinterfaces:

IHTTPControl, ILoginControl

All Known Implementing Classes:

ActivityRightsStartTreeControl, AddPortletControl, AddRemovePortletControl, AdminFolderRepostControl, AdminLoginTokenControl, AdminRedirectControl, AdminSearchRepostControl, AdvancedSearchRepostControl, AdvancedStartSearchControl, AjaxControl, ApprovalControl, AreYouSureControl, AssociatedObjectsControl, AStartTreeControl, AuditManagerRepostControl, AuthSourceRepostControl, AutomationServerRepostControl, BannerStartSearchControl, BaseOpenerControl, BestBetRepostControl, BreadcrumbControl, CardEditorRepostControl, CardLanguagePlugInRepostControl, CheckDeleteControl, ChoosePageDevicesControl, CollapsePortletControl, CommunityEditorRepostControl, CommunityTemplateRepostControl, CrawlerRepostControl, CreateAccountControl, CredentialVaultManagerRepostControl, CredVaultRefreshTreeControl, CredVaultStartTreeControl, CustomActivityRepostControl, DataSourceRepostControl, DefaultLoginControl, DefaultPageControl, DefaultSiteMapPageControl, DeletePageControl, DiagnosticPageRepostControl, DirCheckDeleteControl, DirPrefsRepostControl, DirRepostControl, DirRESTControl, DisplayInPortletControl, DisplayOptRepostControl, DocTypePlugInRepostControl, DocTypeRepostControl, DocumentApprovalControl, DrilldownControl, DSRepostControl, EditCardPropRepostControl, EditDefaultProfileRepostControl, EditMyPagePortletLayoutRepostControl_D, EditMyPagePortletLayoutSetPageControl_D, EditorHelperRepostControl, EditorRepostControl, EditorStartControl, EditPageCreateDefaultControl, EditPageRepostControl, EditPortletPrefsRepostControl, EnsembleHandlerControl, EODPortletPrefsRepostControl, ErrorControl, ErrorDevicesControl, ExpiredPasswordControl, ExpiredPasswordMarkAsGuestControl, ExpListControl, ExternalOperationEditorRepostControl, FileDownloadControl, FilterRepostControl, FolderEditorRepostControl, FolderSelectorRepostControl, GatewayControl, GbDocTypeExtRepostControl, GbDocTypeRepostControl, GlobalACLSyncMapRepostControl, GlobalObjsStartTreeControl, GroupRepostControl, HeaderAndFooterRepostControl, HelpControl, HTTPMemoryDebugRepostControl, InterceptInvitationControl, IntrinsicPortletControl, IntrinsicPortletsRepostControl, InvCodesListControl, InvitationPopupControl, InvitationRepostControl, JobFoldersRepostControl, JobHistoryPortletControl, JobLogRepostControl, JobRepostControl, JoinCommunityControl, JoinCurCommunityControl, KDDocumentDataStoreControl, KDFolderDataStoreControl, LayoutSelectionRepostControl, LocaleSettingsRepostControl, LocalizedStringsControl, LockboxEditorRepostControl, LocNamesRepostControl, LoginControl, LoginDevicesControl, LogoffDevicesControl, MainActivityRightsRepostControl, MigrationDependencyListRepostControl, MigrationExportRepostControl, MigrationImportRepostControl, MigrationSelectForExportRepostControl, MigrationUtilityRepostControl, MultiObjectsSecurityControl, MyPageDevicesControl, NavigationControl, NetSearchRepostControl, NetSearchRepostControl, NetworkSearchControl, ObjectLockManagerRepostControl, ObjectSelectionActionControl, ObjectSelectionRepostControl, ObjEditorRepostControl, ObjMgrRepostControl, ObjMgrSettingsControl, ObjPropMapRepostControl, ObjSelFrameCheckAccessControl, OpenDirFolderControl, OpenDocControl, OpenObjectControl, OpenSubFolderControl, OutgoingNSRepostControl, PageCreateDefaultControl, PageLayoutControl, PageListControl, PageRepostControl, PageTemplateRepostControl, PaginationControl, PaginationControl, PassthruControl, PasswordManagerRepostControl, PortalSettingsControl, PortletBundleRepostControl, PortletDevicesControl, PortletInBundleSelectionEditorStartControl, PortletRepostControl, PowerSearchControl, PreviewCommunityBarControl, PreviewCommunityControl, PreviewPortletControl, ProfileSourceRepostControl, PropertyMapEditorRepostControl, PropRepostControl, PTMultiColumnListRepostControl, QueryStoreControl, ReconstructSearchControl, RefreshEditPageControl, RefreshLayoutSelectControl, RefreshObjSelControl, RefreshTreeControl, RemoteAuthSourceRepostControl, RemoteServerRepostControl, ReorderPortletsControl, ReorganizationControl, RepostControl, RuleEditorRepostControl, SavedSearchPortletControl, SavedSearchPortletPrefsRepostControl, SavedSearchRepostControl, SaveObjectRepostControl, SaveObjectStartControl, SaveSearchControl, SearchBrowseEditModeControl, SearchResultControl, SearchServerSettingsEditorRepostControl, SearchServerTuningEditorRepostControl, SearchWithinResultsControl, SecurityMatrixRepostControl, SendInvitationRepostControl, ServerRefreshTreeControl, ServerStartTreeControl, SessionPrefsControl, SetCommunityControl, SetEditDefaultProfileControl, SetGroupControl, SetJobRepostControl, SetLastItemControl, SetLinkControl, SetPageControl, SetServerSettingsRepostControl, SetSiteMapControl, SetStartItemControl, SinglePageErrorControl, SiteMapFolderCheckAccessControl, SiteMapFolderPlugInControl, SiteMapFolderRepostControl, SiteMapPortletControl, SiteMapPortletPrefsRepostControl, SiteMapPortletPrefsSortedLinksControl, SiteMapRepostControl, SmartSortEditorRepostControl, SOAPCardSubmitAdvancedRepostControl, SOAPCrawlerRepostControl, SOAPDSRepostControl, SortControl, StandardFooterControl, StandardHeaderControl, StartSearchControl, StartTreeControl, SubPortalRepostControl, SubportalRulesManagerRepostControl, SubscribeMatrixRepostControl, TaggingControl, TagLibRepostControl, TemplateTreeRepostControl, TipsControl, TopBestBetHandlerCT, TreeRepostControl, TreeSearchRepostControl, TreeSelectControl, TypeFilterControl, TypeSelectorRepostControl, UnsubscribeCommunitiesRepostControl, UnsubscribeCurCommunityControl, UpdateSortOrderControl, UserIdLookupControl, UserInfoPropMapRepostControl, UserInfoRefreshTreeControl, UserInfoStartTreeControl, UserLockManagerRepostControl, UserProfileRepostControl, UserRepostControl, UserRESTControl, UsrProfCommRepostControl, UsrProfMgrRepostControl, ViewVarPackControl, WebServiceRepostControl, WWWCardSubmitAdvancedRepostControl, WWWCrawlerRepostControl

public interface IControl
extends IMVCObject, IManagedObject

Controls process the events generated by users. The Interpreter takes the user events and fills out the fields in the control. The control is then executed and returns the next DisplayPage (usually the parent page, unless the control is a go to url control). Controls should encapsulate the business logic of the AActivitySpace. As an MVC component, Views are subject to the strict separation between data, logic, and presentation. Obviously, there should be a good way to refer to controls without having to manually type in a text string. There should be some sort of package identifier used to get these.

Author:

Don Hayler

Method Summary

Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace.
void	Init(IModel model, AActivitySpace space) Initialize the control with the model it should use and it's parent AActivitySpace.

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IManagedObject

Create

Method Detail

CheckActionSecurityAndExecute

Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace. Returning null means that the user should return to the parent AActivitySpace's current page. This method is designed to check that the user has access to perform the actions with the given parameters. If the user does not, a redirect object which has had Redirect.SetRedirectToLogin(true) called on it. If the user is the Guest, this will bounce to the login page and back to the Redirect after the user has logged on. If the user is already logged on, they will be redirected to an error page. In general, the error redirect that is returned should contain all of the query string parameters that made up the URL that originally led to the control. Checking whether or not a particular user ever has any access to the space, page, and control should be done in IPTActivitySpace.CheckBasicAccess().

Parameters:

XPHashtable - this contains all of the name value pairs for the control in String, String[] format. This may contain information the control doesn't need. The control should not modify this argument.

Returns:

Redirect where to redirect to after the control is finished executing. This will go to the login page or an error page if Redirect.SetRedirectToLogin(true) has been called.

Init

void Init(IModel model,
          AActivitySpace space)

Initialize the control with the model it should use and it's parent AActivitySpace. This method needs to be called before any other methods. This method also clears all internal data so the control can be used again without fear of mixing data.