com.plumtree.uiinfrastructure.uitasks
Interface IEnvironment
- All Known Implementing Classes:
- AActivitySpace, ActivityRightsTreeAS, AdminFolderEditorAS, AdminSearchAS, AdvancedSearchAS, AFileDownloadAS, AFormAS, AjaxAS, AreYouSureAS, AssociatedObjectsAS, ATreeAS, AuditManagerEditorAS, AuthSourceEditorAS, AuthWSWebServiceEditorAS, AutomationServerEditorAS, BaseOpenerAS, BasicSearchAS, BestBetEditorAS, CardEditorAS, ChoosePageCommunitiesAS_HTML32, ChoosePageCommunitiesAS_WML, ChoosePageDevicesAS_HTML32, ChoosePageDevicesAS_WML, CommunityEditorAS, CommunityPageAS, CommunitySelectionEditorAS, CommunityTemplateEditorAS, CrawlerEditorAS, CrawlWSWebServiceEditorAS, CreateAccountAS, CredentialVaultManagerAS, CredVaultTreeAS, CustomActivityEditorAS, DataSourceEditorAS, DebugAS, DebugLayoutAS, DiagnosticPageEditorAS, DirAS, DirPrefsAS, DirSubmitAS_D, DisplayOptAS, DocTypeEditorAS, DocumentApprovalAS, DSEditorAS, EditDefaultProfileAS, EditMyPagePortletLayoutAS_D, EditMyPortalPageAS, EditorAS, EditPortletPrefsAS, EditWebLinkAS, EnsembleHandlerAS, EODPortletPrefsEditorAS, ErrorAS, ErrorDevicesAS_HTML32, ErrorDevicesAS_WML, ExternalOperationEditorAS, FilterEditorAS, FlyoutCommunitySelectionAS, FlyoutPortletSelectionAS, FolderEditorAS, GatewayAS, GbDocTypeEditorAS, GbDocTypeExtEditorAS, GlobalACLSyncMapAS, GlobalObjsTreeAS, GroupEditorAS, HelpFrameAS, HostServicesAS, HTTPMemoryDebugAS, IntrinsicPrefsEditorForPageletParametersAS, IntrPortWSWebServiceEditorAS, InvitationEditorAS, JobEditorAS, JobFoldersEditorAS, JobLogAS, KDDocumentDataStoreAS, KDFolderDataStoreAS, LayoutSelectionEditorAS, LocaleSettingsEditorAS, LocalizedStringsAS, LockboxEditorAS, LoginAS, LoginDevicesAS_HTML32, LoginDevicesAS_WML, LogoffDevicesAS_HTML32, LogoffDevicesAS_WML, MainActivityRightsEditorAS, MigrationFileDownloadAS, MigrationHistoryAS, MigrationUtilityAS, MigrationUtilityExportAS, MigrationUtilityImportAS, MultipleCardLinkSettingsAS, MWSWebServiceEditorAS, MyPageAS, MyPageDevicesAS_HTML32, MyPageDevicesAS_WML, NetSearchEditorAS, NetSearchEditorAS, NetworkSearchAS, ObjectApprovalAS, ObjectApprovalStatusAS, ObjectLockManagerAS, ObjEditorAS, ObjMgrAS, ObjPropEditorAS, ObjPropMapEditorAS, OpenDocAS, OpenerAS, OutgoingNSEditorAS, PageEditorAS, PageTemplateEditorAS, PasswordAS, PasswordManagerAS, PEIAS, PlumtreeAS, PlumtreeAuthSourceEditorAS, PortalSettingsAS, PortletBundleEditorAS, PortletDevicesAS_HTML32, PortletDevicesAS_WML, PortletEditorAS, PortletInBundleSelectionAS, PortletSelectionEditorAS, PortMainPortletEditorAS, PortTempPortletEditorAS, PreviewCommunityAS, PreviewCommunityBarAS, PreviewPortletAS, ProfileSourceEditorAS, ProfileWSWebServiceEditorAS, PropEditorAS, PropertyMapEditorAS, PTEditorAS, PTFileDownloadAS, PTLoginHelperAS, RemoteAuthSourceEditorAS, RemoteProfileSourceEditorAS, RemoteServerEditorAS, RemPageletWSWebServiceEditorAS, RemPortWSWebServiceEditorAS, RuleEditorAS, RulesDebugMSGAS, SavedSearchEditorAS, SavedSearchPortletPrefsEditorAS, SaveObjectAS, SearchResultAS, SearchServerSettingsEditorAS, SearchServerStatusAS, SearchServerTuningEditorAS, SearchSettingsAS, SearchWSWebServiceEditorAS, SecurityMatrixEditorAS, SendInvitationAS, ServerTreeAS, SessionPrefsAS, SetServerSettingsAS, SiteMapAS, SiteMapFolderEditorAS, SiteMapPortletPrefsEditorAS, SmartSortEditorAS, SOAPCardSubmitAdvancedAS, SOAPCrawlerEditorAS, SOAPDSEditorAS, SubPortalAS, SubportalRulesManagerAS, SubscribeMatrixEditorAS, TagLibManagerAS, TemplateTreeAS, TopBestBetHandlerAS, TreeAS, UnsubscribeCommunitiesAS, UserEditorAS, UserIdLookupAS, UserInfoPropMapAS, UserInfoTreeAS, UserLockManagerAS, UserProfileEditorAS, UserRESTAS, UsrProfMgrEditorAS, VarPackAS, WebServiceEditorAS, WWWCardSubmitAdvancedAS, WWWCrawlerEditorAS
public interface IEnvironment
This class provides access to the environment that a
tag is executed in.
Method Summary |
AccessStyles |
GetAccessStyle()
This method returns the current access style (i.e. |
IXPRequest |
GetCurrentHTTPRequest()
Return the HTTP Request for the current request. |
IXPResponse |
GetCurrentHTTPResponse()
Return the HTTP Response for the current request. |
java.lang.String |
GetCurrentNormalizedBaseURL()
Return the normalized base url of the current request. |
java.lang.String |
GetCurrentRequestURL()
Return the full url of the current request. |
java.lang.String |
GetLanguage()
Gets the current language of the user. |
java.lang.String |
GetLocale()
Gets the current locale of the user. |
java.lang.String |
GetString(int _nID,
java.lang.String _strStringFile)
This method gets localized strings for an
internationalized string file based on the user's
locale. |
java.lang.String |
GetTimeZone()
Gets the time zone of the current user. |
java.lang.Object |
GetUserSession()
Return the user's Session. |
IVarPack |
GetVarPack(java.lang.String _strVarPack)
Deprecated. Variable packages are no longer available directly in tags. In the portal, the Environment object can be cast to an Activity Space and VarPacks can be retrieved that way. |
GetAccessStyle
AccessStyles GetAccessStyle()
- This method returns the current access style (i.e. Section
508 compliance, low bandwidth, or standard).
- Returns:
- AccessStyles The access style
- See Also:
AccessStyles
GetCurrentHTTPRequest
IXPRequest GetCurrentHTTPRequest()
- Return the HTTP Request for the current request.
- Returns:
- the current request
GetCurrentHTTPResponse
IXPResponse GetCurrentHTTPResponse()
- Return the HTTP Response for the current request.
- Returns:
- the current response
GetCurrentNormalizedBaseURL
java.lang.String GetCurrentNormalizedBaseURL()
- Return the normalized base url of the current request.
The normalized base url is essentially the request url
up to and including the '?'.
- Returns:
- The normalized base url of the current request
- See Also:
com.plumtree.uiinfrastructure.statichelpers.ConfigHelpers#GetNormalizedBaseURL(String)
GetCurrentRequestURL
java.lang.String GetCurrentRequestURL()
- Return the full url of the current request.
- Returns:
- the url of the current request
GetLanguage
java.lang.String GetLanguage()
- Gets the current language of the user.
E.G. en, fr, jp
- Returns:
- The current language of the user
GetLocale
java.lang.String GetLocale()
- Gets the current locale of the user.
E.G. en-us, en-gb, fr-fr, jp-jp
- Returns:
- The current locale of the user.
GetTimeZone
java.lang.String GetTimeZone()
- Gets the time zone of the current user.
E.G. America/Los_Angeles
- Returns:
- The time zone of the user.
GetString
java.lang.String GetString(int _nID,
java.lang.String _strStringFile)
- This method gets localized strings for an
internationalized string file based on the user's
locale.
Available string files:
- Parameters:
_nID
- The ID of the string to retrieve_strStringFile
- The name of the string file to use
- Returns:
- String The localized string
- See Also:
Custom string files can also be added to the portal.
GetUserSession
java.lang.Object GetUserSession()
- Return the user's Session. This is a generic Object that
can be used for different kinds of sessions. This will
have to be cast to the correct type of session (IPTSession
for the portal).
- Returns:
- Object the user's session
GetVarPack
IVarPack GetVarPack(java.lang.String _strVarPack)
- Deprecated. Variable packages are no longer available directly in tags. In the portal, the Environment object can be cast to an Activity Space and VarPacks can be retrieved that way.
- This method gets Variable Packages.
- Parameters:
String
- _strVarPack The ID of the requested VarPack
- Returns:
- IVarPack The requested VarPack