 ChangeSubSpaceKey | Changes the key of a sub space. |
| CheckBasicAccess | |
| CleanupAllData | This method is called when an ActivitySpace is removed from the cache. This method then calls IModel.CleanupAllData() on all IModels registered using RegisterModel(). This method is intended for releasing data stored in the server when the activity space is no longer needed, such as search objects that need to be maintained as long as the user is clicking through the search, but should be freed when the space can no longer be used. This can be used to prevent Java references to COM memory from hanging around in the long lived Java heap without cleaning up the underlying COM memory. The Java reference will still stay in the long lived heap until it gets garbage collected (which could be a while), but the COM memory should get released here. This method will not be called if an HTTPSession times out. CleanupTempData will be called before CleanupAllData. |
| CleanupTempData | This method is called at the end of every HTTP request by the Interpreter. This method then calls IModel.CleanupTempData() on all IModels registered using RegisterModel(). This method is intended for cleaning up temporary data that is only used for the lifetime of a single request, like DB query results. |
| Create | This method is used by the ASManager to return new instances of managed objects. |
| DeleteSubSpace | Delete the specified Sub-space and remove it from the Activity Space cache. This is permanent! The sub-space key is different from the space ID. |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| GetAccessStyle | This method returns the current access style (i.e. Section 508 compliance, low bandwidth, or standard). |
| GetApplication | Return the Application. |
| GetControl | Return the requested Control. This method should probably wrap control objects in aggregating control objects to do page specific tasks. In other words, the default package control should have no page specific knowledge. |
| GetControlExists | This method checks whether or not a specific control exists in this AActivitySpace. |
| GetControlsEnumerator | Return an Enumerator for the registered controls. |
| GetCurrentFormData | JF- Returns the current name/value pairs from the Request. (This for PEI use only.) |
| GetCurrentHTTPRequest | Return the HTTP Request for the current request. |
| GetCurrentHTTPResponse | Return the HTTP Response for the current request. |
| GetCurrentNormalizedBaseURL | Return the normalized base url of the current request. The normalized base url is essentially the request url up to and including the '?'. |
| GetCurrentPage | Return the most recent DisplayPage. |
| GetCurrentRequestURL | Return the full url of the current request. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
| GetHelpTopic | |
| GetIsAccessStyleNonStandard | Return true if the current access style is not STANDARD (it is SECTION_508 or LOW_BANDWIDTH) otherwise return false. |
| GetIsAccessStyleStandard | Return true if the current access style is STANDARD otherwise return false. |
| GetIsInPlaceRefreshDisplayOn | This method is used to return whether Display Pages should currently be displaying in place content instead of their normal content. |
| GetIsInPlaceRefreshEnabled | This method is used to return whether this Activity Space has in place refresh enabled. If it is enabled, then we can, for example, include the JavaScript for JSXML. This method should be used carefully in shared components because if shared components use this method, then any time you add any in-place to an AS, you will have to implement it for all the shared components. Shared components that require you to implement a partial content display method should use another way to determine if they should be enabled or not. |
| GetIsSecuredSpace | This method is used to return whether or not this space is secured (SSL) or not (regular HTTP). |
| GetLanguage | Gets the current language of the user. I.E. en, fr, jp |
| GetLocale | Gets the current locale of the user. I.E. en-us, en-gb, fr-fr, jp-jp |
| GetModel | Return the requested Model. |
| GetModelExists | This method checks whether or not a specific model exists in this AActivitySpace. |
| GetModelsEnumerator | Return an Enumerator for the registered models. |
| GetName | This method is used to identify the type of this space. |
| GetPage | Return the requested DisplayPage. |
| GetPageExists | This method checks whether or not a specific page exists in this AActivitySpace. |
| GetPagesEnumerator | Return an Enumerator for the registered pages. |
| GetParentSpace | Return the parent AActivitySpace. If there is no parent space, this will return null. |
| GetParentSpaceID | Return the space ID of the parent AActivitySpace. If there is no parent space, this will return null. |
| GetParentSpaceName | Return the name of the parent AActivitySpace. If there is no parent space, this will return null. |
| GetPersistentSubSession | Returns the persistent subsession that the AActivitySpace can use to store cross-space data for use across multiple login/logout cycles. This SubSession is not cleared of its data on logout, so be sure not to cache anything on this session that could be considered a security risk if it was leaked to another user. Most developers should use the normal subsession (GetSubSession()) for cross-space data storage. This is currently only used when editing the default profiles. |
| GetResourceManager | Return the XPResourceManager AActivitySpace.GetString() and the static method XPResourceManager.FormatString() should be used instead. |
| GetSpaceID | Return the unique space ID for this AActivitySpace. |
| GetString | This method gets localized strings for an internationalized string file based on the user's locale. Available string files: |
| GetStyleSheetLinks | Figure out the style sheet; this method can be overriden by classes that require a special style sheet. |
| GetSubSession | Returns the subsession that the AActivitySpace can use to store cross-space data. This also provides access to the ASCache object (ASConstants.SANDBOXASCACHE). This SubSession is cleared of all data on logout. |
| GetSubSpace | Return the requested Sub-space. The sub-space key is different from the space ID. |
| GetSubSpaceExists | This method checks whether or not a specific sub-space exists in this AActivitySpace. |
| GetSubSpaceKey | Returns the sub-space key. If this is null, this is not a sub-space. This key is used by the parent AActivitySpace to identify sub-spaces (in case there are multiple instances of the same type of sub-space). The sub-space key is different from the space ID. |
| GetSubSpacesEnumerator | Return an Enumerator for the registered sub-spaces. |
| GetTimeZone | Gets the time zone of the current user. I.E. TODO |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| 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). |
| GetVarPack | Helper method to access Variable Packages. |
| GetView | Return the requested View. |
| GetViewExists | This method checks whether or not a specific view exists in this AActivitySpace. |
| GetViewsEnumerator | Return an Enumerator for the registered views. |
| Init | Initialize the Activity Space. This method is called after common attributes like ID, parent, session, application, etc... are set. Get methods are not valid until this method is called. This method should be overridden and called as super.Init(); |
| IsSubSpace | Returns whether or not this space is a sub-space. |
| refString | This creates a reference to a long query string parameter. Currently only the tree knows how to unreference this for certain parameters. |
| RegisterControl | Overloaded. This method registers the control so the AActivitySpace can manage it automatically. It also initializes it with the IModel argument. This operation will fail and return false if the control is null or if there is already a control with the same name registered with the AActivitySpace. |
| RegisterModel | Overloaded. This method registers and initializes the model so the AActivitySpace can manage it automatically. This operation will fail and return false if the model is null or if there is already a model with the same name registered with the AActivitySpace. |
| RegisterPage | Overloaded. This method registers the IDisplayPage so the AActivitySpace can manage it automatically. It also initializes it with the AActivitySpace argument. This operation will fail and return false if the IDisplayPage is null or if there is already a IDisplayPage with the same name registered with the AActivitySpace. The first DisplayPage will be set as the current IDisplayPage. |
| RegisterSubSpace | Registers the Sub-space. The sub-space key is different from the space ID. |
| RegisterView | Overloaded. This method registers the view so the AActivitySpace can manage it automatically. It also initializes it with the IModel and AActivitySpace arguments. This operation will fail and return false if the view is null or if there is already a view with the same name registered with the AActivitySpace. |
| ReInit | Re-Initialize the Activity Space in case models are holding on to an old session. |
| SetApplication | Sets the Application. This method must be called before Init(); |
| SetCurrentFormData | JF- Sets the hastable with the name/value pairs from XPRequest. (This for PEI use only.) This method must be called at the beginning of every request. |
| SetCurrentHTTPRequestResponseObjects | Sets the HTTP Request and Response Objects for the current request. This method must be called at the beginning of every request. |
| SetCurrentPage | Set the current page for this AActivitySpace. If this AActivitySpace only has one IDisplayPage, the current page will automatically be set to that IDisplayPage. If current page tracking is on (off by default), the Interpeter will set the current page to be the most recently accessed page. |
| SetCurrentRequestURL | Sets the current Request URL and computes the normalized base url. This method must be called at the beginning of every request. |
| SetHelpTopic | |
| SetIsASSecured | Should be set to the request secure flag (IsSecureConnection). This method must be called before Init(); |
| SetIsInPlaceRefreshDisplayOn | This method is used to determin whether Display Pages should currently be displaying in place content instead of their normal content. |
| SetIsInPlaceRefreshEnabled | This method is used to determine whether this Activity Space has in place refresh enabled. If it is enabled, then we can, for example, include the JavaScript for JSXML. This method should be used carefully in shared components because if shared components use this method, then any time you add any in-place to an AS, you will have to implement it for all the shared components. Shared components that require you to implement a partial content display method should use another way to determine if they should be enabled or not. |
| SetOverWriteSubSpaces | This method turns on and off overwriting of sub-spaces when they register with this AActivitySpace. If bOverWrite is false, the space will give an error and ignore requests to overwrite a sub-space. This is the default state. |
| SetParentSpace | Set the name and ID of the parent AActivitySpace (i.e. the one that launched this space). If there is no parent space, then this method does not need to be called. |
| SetPersistentSubSession | Sets the persistent subsession that the AActivitySpace can use to store cross-space data across multiple login/logout cycles. This SubSession will not be cleared on logout. This method must be called before Init(); |
| SetSpaceID | Sets the unique space ID for this AActivitySpace. This method must be called before Init(); |
| SetSubSession | Sets the subsession that the AActivitySpace can use to store cross-space data. This SubSession will be cleared on logout. This method must be called before Init(); |
| SetSubSpaceKey | Sets the sub-space key. If this is null, this is not a sub-space. By default, spaces are not sub-spaces. This key is used by the parent AActivitySpace to identify sub-spaces (in case there are multiple instances of the same type of sub-space). The sub-space key is different from the space ID. |
| SetTrackCurrentPage | This method turns on and off automatic tracking of the current IDisplayPage. The Interpreter calls SetCurrentPage at the end of every request with the most recently viewed IDisplayPage. If bTrack is false, MainAS will ignore this information. This is the default state. |
| SetUserSession | Set the user's Session. This is a generic object that can be used for different kinds of user sessions. For the portal it is an IPTSession. This will be called before Init() and CheckBasicAccess() are called. |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
| unrefString | This unreferences a key to a long query string parameter |
| UnRegisterControl | Un-registers the requested control (removes it from AActivitySpace) |
| UnRegisterModel | Un-registers the requested model (removes it from AActivitySpace) |
| UnRegisterPage | Un-registers the requested view (removes it from AActivitySpace) |
| UnRegisterView | Un-registers the requested view (removes it from AActivitySpace) |
AActivitySpace Constructor
m_stringReferences