com.plumtree.portalpages.rest.dojo
Class KDDocumentDataStoreControl

java.lang.Object
  com.plumtree.portalpages.rest.dojo.QueryStoreControl
      com.plumtree.portalpages.rest.dojo.KDDocumentDataStoreControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class KDDocumentDataStoreControl
extends QueryStoreControl
implements IControl

Processes AJAX Request from Dojo QueryDataStore. Checks for folderid parameter to get documents in that folder

Author:

rozhang

Field Summary

static java.lang.String	QS_DATETIMEFORMAT
static java.lang.String	QS_FOLDERID Specifies what kd folder to get documents from
static java.lang.String	QS_LOCALE
static java.lang.String	QS_QUERYPROPIDS Additional properties to query for
static java.lang.String	STR_MVC_CLASS_NAME

Fields inherited from class com.plumtree.portalpages.rest.dojo.QueryStoreControl

m_model, m_space, QS_ORDERBY, QS_QUERY, QS_RESULTSIZE, QS_STARTINDEX

Constructor Summary

KDDocumentDataStoreControl()

Method Summary

Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
Redirect	GetDPRedirect()
java.lang.String	GetName() Return the name of the MVC object.
void	Init(IModel model, AActivitySpace space) Initialize the control with the model it should use and it's parent AActivitySpace.
Redirect	ProcessError(IRESTError _error) This helper method sets the error on the model and redirects to the REST API display page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

QS_FOLDERID

public static final java.lang.String QS_FOLDERID

Specifies what kd folder to get documents from

See Also:

Constant Field Values

QS_QUERYPROPIDS

public static final java.lang.String QS_QUERYPROPIDS

Additional properties to query for

See Also:

Constant Field Values

QS_DATETIMEFORMAT

public static final java.lang.String QS_DATETIMEFORMAT

See Also:

Constant Field Values

QS_LOCALE

public static final java.lang.String QS_LOCALE

See Also:

Constant Field Values

Constructor Detail

KDDocumentDataStoreControl

public KDDocumentDataStoreControl()

Method Detail

CheckActionSecurityAndExecute

public Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

Description copied from interface: IControl

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().

Specified by:

CheckActionSecurityAndExecute in interface IControl

Overrides:

CheckActionSecurityAndExecute in class QueryStoreControl

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.

See Also:

com.plumtree.uiinfrastructure.activityspace.IControl#CheckActionSecurityAndExecute(com.plumtree.openfoundation.util.XPHashtable)

GetDPRedirect

public Redirect GetDPRedirect()

ProcessError

public Redirect ProcessError(IRESTError _error)

This helper method sets the error on the model and redirects to the REST API display page.

Parameters:

_nErrorID - the current error code.

Returns:

The redirect to the User REST API display page.

Init

public void Init(IModel model,
                 AActivitySpace space)

Description copied from interface: IControl

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.

Specified by:

Init in interface IControl

Overrides:

Init in class QueryStoreControl

See Also:

IControl.Init(com.plumtree.uiinfrastructure.activityspace.IModel, com.plumtree.uiinfrastructure.activityspace.AActivitySpace)

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Overrides:

GetName in class QueryStoreControl

Returns:

the name of the object.

See Also:

IMVCObject.GetName()

Create

public java.lang.Object Create()

Description copied from interface: IManagedObject

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Overrides:

Create in class QueryStoreControl

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()