com.sas.actionprovider.util.relational
Class HttpRelationalActionUtil

com.sas.actionprovider.util.relational.HttpRelationalActionUtil

All Implemented Interfaces:

ActionStatusKeysInterface, TableViewAreaInterface, DynamicValueKeys, RelationalDynamicValueKeys

public class HttpRelationalActionUtil
implements TableViewAreaInterface, RelationalDynamicValueKeys, ActionStatusKeysInterface

Field Summary

static java.lang.String	EDIT_URL_TEMPLATE Default url pattern to be used with edit actions.
static java.lang.String	EDIT_URL_TEMPLATE_PPR Default url pattern to be used with edit actions.
static java.lang.String	ROW_EDIT_URL_TEMPLATE Default url pattern to be used with edit actions.
static java.lang.String	ROW_EDIT_URL_TEMPLATE_FOR_DELETE Default url pattern to be used with edit actions.
static java.lang.String	ROW_EDIT_URL_TEMPLATE_FOR_DELETE_PPR Default url pattern to be used with edit actions.
static java.lang.String	ROW_EDIT_URL_TEMPLATE_PPR Default url pattern to be used with edit actions.

Fields inherited from interface com.sas.actionprovider.support.tableview.TableViewAreaInterface

COLUMN_HEADER_AREA, DATA_CELL_AREA, EDIT_COLUMN_AREA, EDIT_ROW_AREA, ROW_HEADER_AREA, TITLE_AREA

Fields inherited from interface com.sas.actionprovider.util.relational.RelationalDynamicValueKeys

AUTO_COMMIT, CHANGED_CELLS, COLUMN, COLUMN_NAME, COMMIT_AUTO_COMMIT, COMMIT_MODEL, COMMIT_ROW, DELETE_AUTO_COMMIT, DELETE_MODEL, DELETE_PROMPT_ON_DELETE, DELETE_ROW, DISTANCE_TO_MOVE_COLUMN, DISTANCE_TO_MOVE_Row, EDIT_ENABLED, FORM_NAME, HELD_COLUMN, HELD_COLUMNS, HELD_ROW, HELD_ROWS, HIDDEN_COLUMN, HIDDEN_ROW, HOLD_INTERFACE, MODE, MODEL, MODEL_COLUMN, MODEL_ROW, MOVE_COLUMN, MOVE_COLUMN_INTERFACE, MOVE_COLUMN_LEFT_AMOUNT, MOVE_COLUMN_RIGHT_AMOUNT, MOVE_MOVE_COLUMN, MOVE_MOVE_COLUMN_INTERFACE, MOVE_ROW, MOVE_ROW_DOWN_AMOUNT, MOVE_ROW_INTERFACE, MOVE_ROW_UP_AMOUNT, ORIENTATION, PROMPT_ON_DELETE, ROW, SELECTED_ROWS, SELECTOR, SORT_ASCENDING_IMAGE, SORT_COLUMN, SORT_DESCENDING_IMAGE, SORT_MODEL, SORT_STATUS, TABLE, URL_TEMPLATE, VIEWER_COLUMN, VIEWER_ROW

Fields inherited from interface com.sas.actionprovider.util.DynamicValueKeys

AREA_VALUE, AREA_VALUE_ATTRKEY, VIEWER, VIEWER_COMPONENT

Fields inherited from interface com.sas.actionprovider.ActionStatusKeysInterface

AREA_DISABLED, DISABLED, ENABLED, IS_CURRENT_STATE_DISABLED, MODEL_MEMBER_DISABLED, MODEL_STATE_DISABLED, MODEL_TYPE_DISABLED, UNSUPPORTED, VIEWER_DISABLED

Constructor Summary

HttpRelationalActionUtil()

Method Summary

static java.lang.Object	getAreaValue(ActionSupportFilter filter)
java.lang.Object	getColumnHeaderShortDescription(ActionSupportFilter filter) This will return back the column header description based on what popUp menu launch event has been registered against the viewer.
int	getCommitDeleteStatus(ActionSupportFilter filter, int currentStatus, BaseAction action)
java.lang.Object	getCustomAttributeValue(java.lang.String attributeName, ActionSupportFilter filter)
int	getSortAscendingActionStatus(ActionSupportFilter filter, int currentStatus)
java.lang.Object	getSortAscendingImage(ActionSupportFilter filter)
int	getSortDescendingActionStatus(ActionSupportFilter filter, int currentStatus)
java.lang.Object	getSortDescendingImage(ActionSupportFilter filter)
int	getViewerDisabledIfEditDisabledOrNotSortable(ActionSupportFilter filter, int currentStatus)
int	getViewerDisabledIfSingleRowEditEnabled(ActionSupportFilter filter, int currentStatus)
static int	validateColumnHeaderArea(TableViewActionSupportFilter filter) Validates if the current area, as specified via various attributes on the filter, matches any of the ColumnHeaderArea objects on the filter's validAreaValues list.
static int	validateDataCellArea(TableViewActionSupportFilter filter) Validates if the current area, as specified via various attributes on the filter, matches any of the DataCellArea objects on the filter's validAreaValues list.

Methods inherited from class com.sas.actionprovider.util.relational.RelationalActionUtil

getHeldColumn, getHeldColumnIndex, getHeldRow, getHeldRowIndex, getHiddenColumn, getHiddenColumnIndex, getSelectedHeldColumn, getSelectedHeldColumnIndex, getSelectedHeldRow, getSelectedHeldRowIndex, getViewerDisabledIfEditDisabled, getViewerDisabledIfEditEnabled, getViewerDisabledIfHeldColumn, getViewerDisabledIfRowOrColumnMax, getViewerDisabledIfUncommittedRow

Field Detail

EDIT_URL_TEMPLATE

public static final java.lang.String EDIT_URL_TEMPLATE

Default url pattern to be used with edit actions.

See Also:

Constant Field Values

EDIT_URL_TEMPLATE_PPR

public static final java.lang.String EDIT_URL_TEMPLATE_PPR

Default url pattern to be used with edit actions.

See Also:

Constant Field Values

ROW_EDIT_URL_TEMPLATE_FOR_DELETE

public static final java.lang.String ROW_EDIT_URL_TEMPLATE_FOR_DELETE

Default url pattern to be used with edit actions.

See Also:

Constant Field Values

ROW_EDIT_URL_TEMPLATE_FOR_DELETE_PPR

public static final java.lang.String ROW_EDIT_URL_TEMPLATE_FOR_DELETE_PPR

Default url pattern to be used with edit actions.

See Also:

Constant Field Values

ROW_EDIT_URL_TEMPLATE

public static final java.lang.String ROW_EDIT_URL_TEMPLATE

Default url pattern to be used with edit actions.

See Also:

Constant Field Values

ROW_EDIT_URL_TEMPLATE_PPR

public static final java.lang.String ROW_EDIT_URL_TEMPLATE_PPR

Default url pattern to be used with edit actions.

See Also:

Constant Field Values

Constructor Detail

HttpRelationalActionUtil

public HttpRelationalActionUtil()

Method Detail

getAreaValue

public static java.lang.Object getAreaValue(ActionSupportFilter filter)

getCustomAttributeValue

public java.lang.Object getCustomAttributeValue(java.lang.String attributeName,
                                                ActionSupportFilter filter)

Overrides:

getCustomAttributeValue in class RelationalActionUtil

getColumnHeaderShortDescription

public java.lang.Object getColumnHeaderShortDescription(ActionSupportFilter filter)

This will return back the column header description based on what popUp menu launch event has been registered against the viewer. The default value returned is 'Right Click for Options'.

getSortAscendingImage

public java.lang.Object getSortAscendingImage(ActionSupportFilter filter)

getSortDescendingImage

public java.lang.Object getSortDescendingImage(ActionSupportFilter filter)

getViewerDisabledIfEditDisabledOrNotSortable

public int getViewerDisabledIfEditDisabledOrNotSortable(ActionSupportFilter filter,
                                                        int currentStatus)

getViewerDisabledIfSingleRowEditEnabled

public int getViewerDisabledIfSingleRowEditEnabled(ActionSupportFilter filter,
                                                   int currentStatus)

getCommitDeleteStatus

public int getCommitDeleteStatus(ActionSupportFilter filter,
                                 int currentStatus,
                                 BaseAction action)

getSortAscendingActionStatus

public int getSortAscendingActionStatus(ActionSupportFilter filter,
                                        int currentStatus)

getSortDescendingActionStatus

public int getSortDescendingActionStatus(ActionSupportFilter filter,
                                         int currentStatus)

validateColumnHeaderArea

public static int validateColumnHeaderArea(TableViewActionSupportFilter filter)

Validates if the current area, as specified via various attributes on the filter, matches any of the ColumnHeaderArea objects on the filter's validAreaValues list. The validAreaValues list comes from the Area object used when registering an Action via the ActionProvider's setAction() method.

Parameters:

filter - The object that holds the current area specification as well as the list of valid ColumnHeaderArea objects for which an Action is registered.

Returns:

int Value is ENABLED if there is a match. AREA_DISABLED otherwise.

validateDataCellArea

public static int validateDataCellArea(TableViewActionSupportFilter filter)

Validates if the current area, as specified via various attributes on the filter, matches any of the DataCellArea objects on the filter's validAreaValues list. The validAreaValues list comes from the Area object used when registering an Action via the ActionProvider's setAction() method.

Parameters:

filter - The object that holds the current area specification as well as the list of valid DataCellArea objects for which an Action is registered.

Returns:

ENABLED if there is a match. AREA_DISABLED otherwise.