Uiinfrastructure API Docs  
 

Redirect Members

Redirect overview

Public Instance Constructors

Redirect Constructor Creates a new Redirect object.

Public Instance Methods

AddControlArgumentOverloaded. Optionally set single String arguments for the IControl.
AddControlArguments Adds a map of String name/String[] values pairs to the redirect (overwriting previous versions)
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetCachedNoID Returns whether to look in the cache for an instance of this space (not a particular instance). This should only be true for common Spaces, like myPage, where a user should only have one instance, unlike Editors, where a user could easily have multiple instances of an Editor open simultaneously.
GetControl Return the name of the IControl.
GetControlArgument Return the value of the specified control argument.
GetControlArguments Return a map of the IControl arguments in String name/String[] values pairs.
GetDisplayPage Return the name of the IDisplayPage.
GetExternalURL This method returns the external URL to do a 302 redirect on. This will not return useful information if the redirect does not point to an external URL.
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.
GetIsErrorRedirect This method returns whether or not this redirect should be handled as an error bounce by the Interpreter. If it is, and the user is not logged on, they will be redirected to the login page, and then be redirected back to this redirect after a succesful login. If they are not logged in, they will see an error page and then be redirected back.
GetIsExternalURL This method returns whether this is an internal redirect to an Activity Space (potentially a server redirect or a 302 redirect) or an external 302 redirect to another web site.
GetIsHTTPRedirect This method returns whether or not this redirect should be handled as a true 302 redirect or an internal server redirect. 302 redirects will cause a roundtrip to the server, and the URL will show up in the browser window. This will allow you to safely refresh the page. Server redirects don't incur a roundtrip to the server, but the new URL will not show up in the browser. This can cause form data to be submitted twice if the user refreshes the page. In general, we should use internal server redirects to save time. However, destructive/constructive actions (saving an object, etc...) should use real 302 redirects.
GetParentSpaceID Returns the ID of the parent activity space of this space.
GetParentSpaceName Returns the name of the parent activity space of this space.
GetQueryString Returns a query string for the redirect containing all the control arguments.
GetSpaceID Return the ID of the AActivitySpace.
GetSpaceName Return the name of the AActivitySpace.
GetStripParentSpace Gets whether or not to strip the parent space arguments from the URL.
GetSubSpaceKey Returns the Sub-space key. If this is null or empty, this is not a sub-space.
GetType (inherited from Object)Gets the Type of the current instance.
RemoveControlArgument Optionally remove single arguments for the IControl.
SetControl Optionally set the name of an IControl to redirect to.
SetDisplayPage Optionally set the name of an IDisplayPage to redirect to.
SetIsErrorRedirect This method sets whether or not this redirect should be handled as an error bounce by the Interpreter. If it is, and the user is not logged on, they will be redirected to the login page, and then be redirected back to this redirect after a succesful login. If they are not logged in, they will see an error page and then be redirected back.
SetIsHTTPRedirect This method sets whether or not this redirect should be handled as a true 302 redirect or an internal server redirect. 302 redirects will cause a roundtrip to the server, and the URL will show up in the browser window. This will allow you to safely refresh the page. Server redirects don't incur a roundtrip to the server, but the new URL will not show up in the browser. This can cause form data to be submitted twice if the user refreshes the page. In general, we should use internal server redirects to save time. However, destructive/constructive actions (saving an object, etc...) should use real 302 redirects. The default is internal server redirect.
SetLinkCreateNewSpace This method creates a brand new AActivitySpace.
SetLinkGetCachedSpace This constructor takes a specific space and returns a link to that (including space ID)
SetLinkGetSpaceIfCached This method gets a named AActivitySpace from the cache if it is there, or creates a new one if it is not in the cache. This method should be used to get common AActivitySpaces such as MyPage and Community, not minor spaces like Tree and Editors. The SetSpaceGetCached(AActivitySpace) should be used instead of this one when you can.
SetLinkToExternalURL This method sets the Redirect to do a true HTTP 302 redirect to an external URL. This cannot be used to redirect to another Activity Space. That should be done through the normal SetLink* methods. The URL parameter is assumed to be properly URL encoded, and this method will not do any encoding. It is the responsibility of the method caller to properly encode the URL.
SetStripParentSpace Sets whether or not to strip the parent space arguments from the URL.
SetSubSpaceKey This method sets the sub space key. If this is not called, or is empty, the space will not be a sub-space. Otherwise it will be. This is null by default (meaning not a sub-space).
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

Redirect Class | com.plumtree.uiinfrastructure.activityspace Namespace