com.plumtree.uiinfrastructure.approval
Class ApprovalControl

java.lang.Object
  com.plumtree.uiinfrastructure.form.RepostControl
      com.plumtree.uiinfrastructure.editor.EditorRepostControl
          com.plumtree.uiinfrastructure.approval.ApprovalControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

Direct Known Subclasses:

DocumentApprovalControl

public class ApprovalControl
extends EditorRepostControl
implements IControl

Author:

$author$

Field Summary

static java.lang.String	PARAM_ADD_COMMENT
static java.lang.String	PARAM_APPLY
static java.lang.String	PARAM_APPROVE_ALL
static java.lang.String	PARAM_CLEAR
static java.lang.String	PARAM_CURRENT_TYPE
static java.lang.String	PARAM_EDIT_ITEM
static java.lang.String	PARAM_FINISH
static java.lang.String	PARAM_GOTO_PAGE
static java.lang.String	PARAM_GOTO_TYPE
static java.lang.String	PARAM_HOLD_ALL
static java.lang.String	PARAM_NEXT_PAGE
static java.lang.String	PARAM_PREV_PAGE
static java.lang.String	PARAM_REJECT_ALL
static int	POSTTOSELF_ACTION_ADD_COMMENT
static int	POSTTOSELF_ACTION_APPLY
static int	POSTTOSELF_ACTION_APPROVE_ALL
static int	POSTTOSELF_ACTION_CLEAR
static int	POSTTOSELF_ACTION_GOTO_RANGE
static int	POSTTOSELF_ACTION_GOTO_TYPE
static int	POSTTOSELF_ACTION_HOLD_ALL
static int	POSTTOSELF_ACTION_NEXT_PAGE
static int	POSTTOSELF_ACTION_PREVIOUS_PAGE
static int	POSTTOSELF_ACTION_REJECT_ALL
static int	POSTTOSELF_ACTION_SELECT_ALL
static int	POSTTOSELF_ACTION_SORT_DATE
static int	POSTTOSELF_ACTION_SORT_NAME
static int	POSTTOSELF_ACTION_SORT_SUBMITTEDBY
static int	POSTTOSELF_ACTION_UNSELECT_ALL
static java.lang.String	STR_MVC_CLASS_NAME

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorRepostControl

POSTTOSELF_ACTION_ONRETURN_FROM_SUBEDITOR

Fields inherited from class com.plumtree.uiinfrastructure.form.RepostControl

HTMLINPUT_PASSTHRU_ARGS, HTMLINPUT_PASSTHRU_CONTROL, HTMLINPUT_POSTTOSELF, HTMLSUBMIT_508_POSTTOSELF, m_asOwner, m_bInitialized, m_htFormData, m_model, m_nAction, m_nPageStatus, m_rRedirect, PAGE_STATUS_INVALID, PAGE_STATUS_VALID, POSTTOSELF_ACTION_APPLY_CHANGES, POSTTOSELF_ACTION_CANCEL, POSTTOSELF_ACTION_FINISH, POSTTOSELF_ACTION_GOTOPAGE, POSTTOSELF_ACTION_IN_PLACE_REFRESH, POSTTOSELF_ACTION_PASSTHRU, POSTTOSELF_ACTION_SIMPLEREPOST, POSTTOSELF_ACTION_UNDEFINED

Constructor Summary

ApprovalControl()

Method Summary

void	Apply(XPHashtable arguments, ApprovalItemType type)
void	ApproveAll(ApprovalItemType type)
Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) This code is called by the AS Servlet each time there is a repost.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
java.lang.String	GetName() Returns the Class name.
void	HoldAll(ApprovalItemType type)
protected void	PerformAction(int _nAction) Performs repost actions.
void	PerformFinishAction() Helper method to implement the Finish action.
void	RejectAll(ApprovalItemType type)
protected void	SaveCurrentPage() Get the current page name and call the save method on the model.
void	SelectUnselectAll(ApprovalItemType type, boolean bSelect)

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorRepostControl

CheckMandatoryPages, PerformCancelAction, PerformReadOnlyAction, SetRedirectToCloseSubEditor

Methods inherited from class com.plumtree.uiinfrastructure.form.RepostControl

GetPageStatus, GetRepostAction, Init, PerformPassthruAction, SetPageStatus, SetRedirect, SetRepostAction

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IControl

Init

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

PARAM_APPLY

public static final java.lang.String PARAM_APPLY

See Also:

Constant Field Values

PARAM_FINISH

public static final java.lang.String PARAM_FINISH

See Also:

Constant Field Values

PARAM_ADD_COMMENT

public static final java.lang.String PARAM_ADD_COMMENT

See Also:

Constant Field Values

PARAM_APPROVE_ALL

public static final java.lang.String PARAM_APPROVE_ALL

See Also:

Constant Field Values

PARAM_REJECT_ALL

public static final java.lang.String PARAM_REJECT_ALL

See Also:

Constant Field Values

PARAM_HOLD_ALL

public static final java.lang.String PARAM_HOLD_ALL

See Also:

Constant Field Values

PARAM_CURRENT_TYPE

public static final java.lang.String PARAM_CURRENT_TYPE

See Also:

Constant Field Values

PARAM_PREV_PAGE

public static final java.lang.String PARAM_PREV_PAGE

See Also:

Constant Field Values

PARAM_NEXT_PAGE

public static final java.lang.String PARAM_NEXT_PAGE

See Also:

Constant Field Values

PARAM_GOTO_PAGE

public static final java.lang.String PARAM_GOTO_PAGE

See Also:

Constant Field Values

PARAM_GOTO_TYPE

public static final java.lang.String PARAM_GOTO_TYPE

See Also:

Constant Field Values

PARAM_EDIT_ITEM

public static final java.lang.String PARAM_EDIT_ITEM

See Also:

Constant Field Values

PARAM_CLEAR

public static final java.lang.String PARAM_CLEAR

See Also:

Constant Field Values

POSTTOSELF_ACTION_SORT_SUBMITTEDBY

public static final int POSTTOSELF_ACTION_SORT_SUBMITTEDBY

See Also:

Constant Field Values

POSTTOSELF_ACTION_SORT_NAME

public static final int POSTTOSELF_ACTION_SORT_NAME

See Also:

Constant Field Values

POSTTOSELF_ACTION_SORT_DATE

public static final int POSTTOSELF_ACTION_SORT_DATE

See Also:

Constant Field Values

POSTTOSELF_ACTION_APPLY

public static final int POSTTOSELF_ACTION_APPLY

See Also:

Constant Field Values

POSTTOSELF_ACTION_PREVIOUS_PAGE

public static final int POSTTOSELF_ACTION_PREVIOUS_PAGE

See Also:

Constant Field Values

POSTTOSELF_ACTION_NEXT_PAGE

public static final int POSTTOSELF_ACTION_NEXT_PAGE

See Also:

Constant Field Values

POSTTOSELF_ACTION_ADD_COMMENT

public static final int POSTTOSELF_ACTION_ADD_COMMENT

See Also:

Constant Field Values

POSTTOSELF_ACTION_GOTO_TYPE

public static final int POSTTOSELF_ACTION_GOTO_TYPE

See Also:

Constant Field Values

POSTTOSELF_ACTION_APPROVE_ALL

public static final int POSTTOSELF_ACTION_APPROVE_ALL

See Also:

Constant Field Values

POSTTOSELF_ACTION_REJECT_ALL

public static final int POSTTOSELF_ACTION_REJECT_ALL

See Also:

Constant Field Values

POSTTOSELF_ACTION_HOLD_ALL

public static final int POSTTOSELF_ACTION_HOLD_ALL

See Also:

Constant Field Values

POSTTOSELF_ACTION_CLEAR

public static final int POSTTOSELF_ACTION_CLEAR

See Also:

Constant Field Values

POSTTOSELF_ACTION_SELECT_ALL

public static final int POSTTOSELF_ACTION_SELECT_ALL

See Also:

Constant Field Values

POSTTOSELF_ACTION_GOTO_RANGE

public static final int POSTTOSELF_ACTION_GOTO_RANGE

See Also:

Constant Field Values

POSTTOSELF_ACTION_UNSELECT_ALL

public static final int POSTTOSELF_ACTION_UNSELECT_ALL

See Also:

Constant Field Values

Constructor Detail

ApprovalControl

public ApprovalControl()

Method Detail

Apply

public void Apply(XPHashtable arguments,
                  ApprovalItemType type)

Parameters:

arguments -

type -

ApproveAll

public void ApproveAll(ApprovalItemType type)

Parameters:

type -

SelectUnselectAll

public void SelectUnselectAll(ApprovalItemType type,
                              boolean bSelect)

Parameters:

type -

bSelect - true is select, false is unselect

CheckActionSecurityAndExecute

public Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

Description copied from class: RepostControl

This code is called by the AS Servlet each time there is a repost. First it saves the page and then performs any repost action. If the Redirect object returned is not null, the Servlet will go to the page specified by the Redirect. If the Redirect is null, the Servlet will get the current page from the AS and display it.

Specified by:

CheckActionSecurityAndExecute in interface IControl

Overrides:

CheckActionSecurityAndExecute in class EditorRepostControl

Returns:

Redirect

See Also:

com.plumtree.xpshared.activityspace.IControl#execute()

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 EditorRepostControl

Returns:

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

See Also:

IManagedObject.Create()

GetName

public java.lang.String GetName()

Description copied from class: EditorRepostControl

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Overrides:

GetName in class EditorRepostControl

Returns:

String

See Also:

IMVCObject.GetName()

HoldAll

public void HoldAll(ApprovalItemType type)

Parameters:

type -

PerformFinishAction

public void PerformFinishAction()

Description copied from class: EditorRepostControl

Helper method to implement the Finish action. If this is a sub Editor we don't want to call the Finish method. If this is the main Editor and it has some sub Editors we also want to call the Finish method on each sub Editor.

Overrides:

PerformFinishAction in class EditorRepostControl

RejectAll

public void RejectAll(ApprovalItemType type)

Parameters:

type -

PerformAction

protected void PerformAction(int _nAction)

Description copied from class: EditorRepostControl

Performs repost actions.

Overrides:

PerformAction in class EditorRepostControl

Parameters:

_nAction -

SaveCurrentPage

protected void SaveCurrentPage()

Description copied from class: RepostControl

Get the current page name and call the save method on the model.

Overrides:

SaveCurrentPage in class EditorRepostControl

See Also:

RepostControl.SaveCurrentPage()