|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.activityspace.AActivitySpace
public abstract class AActivitySpace
AActivitySpaces contain the MVC setup for a set of Display Pages, as well as the Display Pages themselves. All objects should come to their parent AActivitySpace for access to other objects, such as IModels, IViews, and user objects like IPTSession and UserPreferences. Activity spaces setup and manage the interaction between the different MVC objects and the IDisplayPage. They initialize all of the objects, and can get and set data on the Models if necessary. Activity Spaces are not subject to the strict data/logic/presentation separation that MVC components are. This class provides helper implementations of the methods to get MVC Objects and manages them automatically (IModel, IView, IControl, IDisplayPage). Just register things and then call GetModel, etc... to access them. It also provides base implementations of some of the common AActivitySpace functionality.
Field Summary | |
---|---|
protected XPHashtable |
m_stringReferences
This hashtable is used to store references to extremely long query string parameters. |
Constructor Summary | |
---|---|
AActivitySpace()
|
Method Summary | |
---|---|
void |
ChangeSubSpaceKey(java.lang.String subSpaceKey,
java.lang.String subSpaceNewKey)
Changes the key of a sub space. |
abstract boolean |
CheckBasicAccess(java.lang.String strPage,
java.lang.String strControl,
boolean bSameSpace)
This method is called by the Interpreter at the beginning of every HTTP request to determine whether or not the current user has the security privileges necessary to view the requested page. |
void |
CleanupAllData()
This method is called when an ActivitySpace is removed from the cache. |
void |
CleanupTempData()
This method is called at the end of every HTTP request by the Interpreter. |
abstract java.lang.Object |
Create()
This method is used by the ASManager to return new instances of managed objects. |
void |
DeleteSubSpace(java.lang.String subSpaceKey)
Delete the specified Sub-space and remove it from the Activity Space cache. |
AccessStyles |
GetAccessStyle()
This method returns the current access style (i.e. |
IApplication |
GetApplication()
Return the Application. |
IControl |
GetControl(java.lang.String controlName)
Return the requested Control. |
boolean |
GetControlExists(java.lang.String controlName)
This method checks whether or not a specific control exists in this AActivitySpace. |
IXPEnumerator |
GetControlsEnumerator()
Return an Enumerator for the registered controls. |
XPHashtable |
GetCurrentFormData()
JF- Returns the current name/value pairs from the Request. |
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. |
IDisplayPage |
GetCurrentPage()
Return the most recent DisplayPage. |
java.lang.String |
GetCurrentRequestURL()
Return the full url of the current request. |
java.lang.String |
GetHelpTopic()
|
boolean |
GetIsAccessStyleNonStandard()
Return true if the current access style is not STANDARD (it is SECTION_508 or LOW_BANDWIDTH) otherwise return false. |
boolean |
GetIsAccessStyleStandard()
Return true if the current access style is STANDARD otherwise return false. |
boolean |
GetIsInPlaceRefreshDisplayOn()
This method is used to return whether Display Pages should currently be displaying in place content instead of their normal content. |
boolean |
GetIsInPlaceRefreshEnabled()
This method is used to return whether this Activity Space has in place refresh enabled. |
boolean |
GetIsSecuredSpace()
This method is used to return whether or not this space is secured (SSL) or not (regular HTTP). |
java.lang.String |
GetLanguage()
Gets the current language of the user. |
java.lang.String |
GetLocale()
Gets the current locale of the user. |
IModel |
GetModel(java.lang.String modelName)
Return the requested Model. |
boolean |
GetModelExists(java.lang.String modelName)
This method checks whether or not a specific model exists in this AActivitySpace. |
IXPEnumerator |
GetModelsEnumerator()
Return an Enumerator for the registered models. |
abstract java.lang.String |
GetName()
This method is used to identify the type of this space. |
IDisplayPage |
GetPage(java.lang.String pageName)
Return the requested DisplayPage. |
boolean |
GetPageExists(java.lang.String pageName)
This method checks whether or not a specific page exists in this AActivitySpace. |
IXPEnumerator |
GetPagesEnumerator()
Return an Enumerator for the registered pages. |
AActivitySpace |
GetParentSpace()
Return the parent AActivitySpace. |
java.lang.String |
GetParentSpaceID()
Return the space ID of the parent AActivitySpace. |
java.lang.String |
GetParentSpaceName()
Return the name of the parent AActivitySpace. |
ISessionManager |
GetPersistentSubSession()
Returns the persistent subsession that the AActivitySpace can use to store cross-space data for use across multiple login/logout cycles. |
XPResourceManager |
GetResourceManager()
Return the XPResourceManager AActivitySpace.GetString() and the static method XPResourceManager.FormatString() should be used instead. |
java.lang.String |
GetSpaceID()
Return the unique space ID for this AActivitySpace. |
java.lang.String |
GetString(int _nStringID,
java.lang.String _strResourceFileName)
This method gets localized strings for an internationalized string file based on the user's locale. |
HTMLElementCollection |
GetStyleSheetLinks()
Figure out the style sheet; this method can be overriden by classes that require a special style sheet. |
ISessionManager |
GetSubSession()
Returns the subsession that the AActivitySpace can use to store cross-space data. |
AActivitySpace |
GetSubSpace(java.lang.String subSpaceKey)
Return the requested Sub-space. |
boolean |
GetSubSpaceExists(java.lang.String subSpaceKey)
This method checks whether or not a specific sub-space exists in this AActivitySpace. |
java.lang.String |
GetSubSpaceKey()
Returns the sub-space key. |
IXPEnumerator |
GetSubSpacesEnumerator()
Return an Enumerator for the registered sub-spaces. |
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)
Helper method to access Variable Packages. |
IView |
GetView(java.lang.String viewName)
Return the requested View. |
boolean |
GetViewExists(java.lang.String viewName)
This method checks whether or not a specific view exists in this AActivitySpace. |
IXPEnumerator |
GetViewsEnumerator()
Return an Enumerator for the registered views. |
void |
Init()
Initialize the Activity Space. |
boolean |
IsSubSpace()
Returns whether or not this space is a sub-space. |
java.lang.String |
refString(java.lang.String value)
This creates a reference to a long query string parameter. |
boolean |
RegisterControl(java.lang.String controlName,
IModel model)
This method registers the control so the AActivitySpace can manage it automatically. |
boolean |
RegisterControl(java.lang.String controlName,
java.lang.String storageName,
IModel model)
This method registers the control so the AActivitySpace can manage it automatically. |
boolean |
RegisterModel(java.lang.String modelName)
This method registers and initializes the model so the AActivitySpace can manage it automatically. |
boolean |
RegisterModel(java.lang.String modelName,
java.lang.String storageName)
This method registers and initializes the model so the AActivitySpace can manage it automatically. |
boolean |
RegisterPage(IDisplayPage page)
This method registers the IDisplayPage so the AActivitySpace can manage it automatically. |
boolean |
RegisterPage(IDisplayPage page,
java.lang.String strStorageName)
This method registers the IDisplayPage so the AActivitySpace can manage it automatically. |
boolean |
RegisterSubSpace(AActivitySpace subSpace,
java.lang.String storageName)
Registers the Sub-space. |
boolean |
RegisterView(java.lang.String viewName,
IModelRO model)
This method registers the view so the AActivitySpace can manage it automatically. |
boolean |
RegisterView(java.lang.String viewName,
java.lang.String storageName,
IModelRO model)
This method registers the view so the AActivitySpace can manage it automatically. |
void |
ReInit()
Re-Initialize the Activity Space in case models are holding on to an old session. |
void |
SetApplication(IApplication application)
Sets the Application. |
void |
SetCurrentFormData(XPHashtable _htFormData)
JF- Sets the hastable with the name/value pairs from XPRequest. |
void |
SetCurrentHTTPRequestResponseObjects(IXPRequest xpRequest,
IXPResponse xpResponse)
Sets the HTTP Request and Response Objects for the current request. |
void |
SetCurrentPage(IDisplayPage page)
Set the current page for this AActivitySpace. |
void |
SetCurrentRequestURL(java.lang.String strCurrentRequestURL)
Sets the current Request URL and computes the normalized base url. |
void |
SetHelpTopic(java.lang.String s)
|
void |
SetIsASSecured(boolean _bIsSecured)
Should be set to the request secure flag (IsSecureConnection). |
void |
SetIsInPlaceRefreshDisplayOn(boolean IsInPlaceRefreshDisplayOn)
This method is used to determin whether Display Pages should currently be displaying in place content instead of their normal content. |
void |
SetIsInPlaceRefreshEnabled(boolean IsInPlaceRefreshEnabled)
This method is used to determine whether this Activity Space has in place refresh enabled. |
void |
SetOverWriteSubSpaces(boolean bOverWrite)
This method turns on and off overwriting of sub-spaces when they register with this AActivitySpace. |
void |
SetParentSpace(java.lang.String spaceName,
java.lang.String spaceID)
Set the name and ID of the parent AActivitySpace (i.e. |
void |
SetPersistentSubSession(ISessionManager session)
Sets the persistent subsession that the AActivitySpace can use to store cross-space data across multiple login/logout cycles. |
void |
SetSpaceID(java.lang.String spaceID)
Sets the unique space ID for this AActivitySpace. |
void |
SetSubSession(ISessionManager session)
Sets the subsession that the AActivitySpace can use to store cross-space data. |
void |
SetSubSpaceKey(java.lang.String sSubSpaceKey)
Sets the sub-space key. |
void |
SetTrackCurrentPage(boolean bTrack)
This method turns on and off automatic tracking of the current IDisplayPage. |
void |
SetUserSession(java.lang.Object userSession)
Set the user's Session. |
java.lang.String |
unrefString(java.lang.String key)
This unreferences a key to a long query string parameter |
void |
UnRegisterControl(java.lang.String controlName)
Un-registers the requested control (removes it from AActivitySpace) |
void |
UnRegisterModel(java.lang.String modelName)
Un-registers the requested model (removes it from AActivitySpace) |
void |
UnRegisterPage(java.lang.String pageName)
Un-registers the requested view (removes it from AActivitySpace) |
void |
UnRegisterView(java.lang.String viewName)
Un-registers the requested view (removes it from AActivitySpace) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected XPHashtable m_stringReferences
Constructor Detail |
---|
public AActivitySpace()
Method Detail |
---|
public abstract boolean CheckBasicAccess(java.lang.String strPage, java.lang.String strControl, boolean bSameSpace)
String
- the requested IDisplayPage name (may be null for default)String
- the requested IControl name (may be null if not used)boolean
- true implies this is from an internal redirect from the same space
false implies this is an URL from the user, or a redirect from
another space.
public abstract java.lang.Object Create()
Create
in interface IManagedObject
public abstract java.lang.String GetName()
GetName
in interface IMVCObject
public void SetHelpTopic(java.lang.String s)
public java.lang.String GetHelpTopic()
public void ChangeSubSpaceKey(java.lang.String subSpaceKey, java.lang.String subSpaceNewKey)
String
- the key of the sub-space to change the keyString
- the new key for that sub spacepublic void DeleteSubSpace(java.lang.String subSpaceKey)
String
- the sub-space key of the Sub-space to deletepublic AccessStyles GetAccessStyle()
GetAccessStyle
in interface IEnvironment
AccessStyles
public boolean GetIsAccessStyleStandard()
public boolean GetIsAccessStyleNonStandard()
public boolean GetIsSecuredSpace()
public IApplication GetApplication()
public IControl GetControl(java.lang.String controlName)
String
- the name of the control to get
public boolean GetControlExists(java.lang.String controlName)
String
- the name of the control to check
public IXPEnumerator GetControlsEnumerator()
public IDisplayPage GetCurrentPage()
public java.lang.String GetCurrentRequestURL()
GetCurrentRequestURL
in interface IEnvironment
public java.lang.String GetCurrentNormalizedBaseURL()
GetCurrentNormalizedBaseURL
in interface IEnvironment
com.plumtree.uiinfrastructure.statichelpers.ConfigHelpers#GetNormalizedBaseURL(String)
public IXPRequest GetCurrentHTTPRequest()
GetCurrentHTTPRequest
in interface IEnvironment
public IXPResponse GetCurrentHTTPResponse()
GetCurrentHTTPResponse
in interface IEnvironment
public XPHashtable GetCurrentFormData()
public java.lang.String GetLanguage()
GetLanguage
in interface IEnvironment
public java.lang.String GetLocale()
GetLocale
in interface IEnvironment
public IModel GetModel(java.lang.String modelName)
String
- the name of the model to get
public boolean GetModelExists(java.lang.String modelName)
String
- the name of the model to check
public IXPEnumerator GetModelsEnumerator()
public IDisplayPage GetPage(java.lang.String pageName)
String
- the name of the IDisplayPage to get
public boolean GetPageExists(java.lang.String pageName)
String
- the name of the page to check
public IXPEnumerator GetPagesEnumerator()
public AActivitySpace GetParentSpace()
public java.lang.String GetParentSpaceID()
public java.lang.String GetParentSpaceName()
public XPResourceManager GetResourceManager()
public java.lang.String GetSpaceID()
public java.lang.String GetString(int _nStringID, java.lang.String _strResourceFileName)
GetString
in interface IEnvironment
_nID
- The ID of the string to retrieve_strStringFile
- The name of the string file to use
Custom string files can also be added to the portal.
public HTMLElementCollection GetStyleSheetLinks()
public java.lang.String GetTimeZone()
GetTimeZone
in interface IEnvironment
public void CleanupTempData()
public void CleanupAllData()
public ISessionManager GetSubSession()
public ISessionManager GetPersistentSubSession()
public AActivitySpace GetSubSpace(java.lang.String subSpaceKey)
String
- the sub-space key of the Sub-space to get
public boolean GetSubSpaceExists(java.lang.String subSpaceKey)
String
- the name of the sub-space to check
public java.lang.String GetSubSpaceKey()
public IXPEnumerator GetSubSpacesEnumerator()
public java.lang.Object GetUserSession()
GetUserSession
in interface IEnvironment
public IVarPack GetVarPack(java.lang.String strVarPack)
GetVarPack
in interface IEnvironment
public IView GetView(java.lang.String viewName)
String
- the name of the view to get
public boolean GetViewExists(java.lang.String viewName)
String
- the name of the view to check
public IXPEnumerator GetViewsEnumerator()
public void Init()
public void ReInit()
public boolean IsSubSpace()
public boolean RegisterControl(java.lang.String controlName, IModel model)
String
- controlName the name of the IControl to registerIModel
- the model to initialize this IControl with
public boolean RegisterControl(java.lang.String controlName, java.lang.String storageName, IModel model)
String
- controlName the name of the IControl to registerString
- storageName the name to store this IControl underIModel
- the model to initialize this IControl with
public boolean RegisterModel(java.lang.String modelName)
String
- modelName the name of the IModel to register
public boolean RegisterModel(java.lang.String modelName, java.lang.String storageName)
String
- modelName the name of the IModel to registerString
- storageName the name to store the IModel under
public boolean RegisterSubSpace(AActivitySpace subSpace, java.lang.String storageName)
String
- the key of the Sub-space to registerAActivitySpace
- the sub-space to register
public boolean RegisterView(java.lang.String viewName, IModelRO model)
String
- viewName the name of the IView to registerIModel
- the model to initialize this IView with
public boolean RegisterView(java.lang.String viewName, java.lang.String storageName, IModelRO model)
String
- viewName the name of the IView to registerString
- storageName the name to store this IView underIModel
- the model to initialize this IView with
public void SetApplication(IApplication application)
the
- applicationpublic void SetCurrentRequestURL(java.lang.String strCurrentRequestURL)
the
- current request urlpublic void SetCurrentHTTPRequestResponseObjects(IXPRequest xpRequest, IXPResponse xpResponse)
The
- current XPRequestThe
- current XPResponsepublic void SetCurrentFormData(XPHashtable _htFormData)
_htFormData
- public void SetCurrentPage(IDisplayPage page)
IDisplayPage
- the current Display Pagepublic void SetIsASSecured(boolean _bIsSecured)
_bIsSecured
- public void SetOverWriteSubSpaces(boolean bOverWrite)
boolean
- true implies allow overwriting of sub-space
false implies ignore attempts to overwrite a sub-space (default)public void SetParentSpace(java.lang.String spaceName, java.lang.String spaceID)
String
- spaceName the name of the parent spaceString
- spaceID the ID of the parent spacepublic void SetSpaceID(java.lang.String spaceID)
the
- unique space ID for this AActivitySpacepublic void SetSubSession(ISessionManager session)
the
- subsession that the AActivitySpace can use to store
cross-space data.public void SetPersistentSubSession(ISessionManager session)
the
- subsession that the AActivitySpace can use to store
cross-space data.public void SetSubSpaceKey(java.lang.String sSubSpaceKey)
String
- sub-space keypublic void SetTrackCurrentPage(boolean bTrack)
boolean
- true implies track current page information
false implies ignore page tracking information (default)public void SetUserSession(java.lang.Object userSession)
Object
- userSession to be setpublic void UnRegisterPage(java.lang.String pageName)
String
- the name of the view to un registerpublic void UnRegisterView(java.lang.String viewName)
String
- the name of the view to un registerpublic void UnRegisterControl(java.lang.String controlName)
String
- the name of the control to unregisterpublic void UnRegisterModel(java.lang.String modelName)
String
- the name of the model to unregisterpublic boolean RegisterPage(IDisplayPage page)
IDisplayPage
- page to register
public boolean RegisterPage(IDisplayPage page, java.lang.String strStorageName)
IDisplayPage
- page to registerString
- storageName the name to store the IDisplayPage under
public java.lang.String refString(java.lang.String value)
value
-
public java.lang.String unrefString(java.lang.String key)
key
- -- This must not have the "@" in front of it
public boolean GetIsInPlaceRefreshEnabled()
public void SetIsInPlaceRefreshEnabled(boolean IsInPlaceRefreshEnabled)
boolean
- True to enabled this AS for in place refresh.public boolean GetIsInPlaceRefreshDisplayOn()
public void SetIsInPlaceRefreshDisplayOn(boolean IsInPlaceRefreshDisplayOn)
boolean
- True to show in place content.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |