planetj.magic
Class AssociationRequest

java.lang.Object
  planetj.magic.AbstractMagicRequest
      planetj.magic.MagicRequest
          planetj.magic.AbstractSelectionRequest
              planetj.magic.AssociationRequest

All Implemented Interfaces:

IFeature, IMagicRequest, IOperation, java.io.Serializable

Direct Known Subclasses:

BlobDownloadRequest, ViewSelectionAssociationRequest

public class AssociationRequest

extends AbstractSelectionRequest

implements IOperation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

Fields inherited from interface planetj.dataengine.operation.IOperation

ALLOW_DELETES, ALLOW_DETAILS, ALLOW_INSERTS, ALLOW_UPDATES, APPLICABLE_CODE_ONLY, APPLICABLE_ONLY_FOR_DISPLAY, APPLICABLE_ONLY_FOR_SQL, APPLICATION_ID, AUTHORIZE_EXECUTE_OPERATION, AUTO_RUN_ID, AUTO_RUN_STATUS, CACHE_LEVEL, CONNECTION_ALIAS, CSS_LINK_CLASS, CURRENT_FIELD, CURRENT_REQUEST, CURRENT_RESPONSE, CURRENT_ROW, CURRENT_ROW_COLLECTION, CURRENT_SERVLET, CURRENT_USER, DEPENDS_ON_ID, DESCRIPTION, DETAILS_JSP_FILE, DISPLAY_COLUMNS, DISPLAY_LOCATION, DISPLAY_LOCATION_LEFT, DISPLAY_LOCATION_TOP, DISPLAY_ORDER, DISPLAY_RULE, DISPLAY_RULE_HIDE, DISPLAY_RULE_UNKNOWN, ENCRYPTION_ID, EXECUTION_MODE, EXECUTION_MODE_NO, EXECUTION_MODE_YES, EXECUTION_RULE, EXECUTION_RULE_EXECUTE_ONLY, EXECUTION_RULE_EXECUTE_THEN_PROMPT, EXECUTION_RULE_PROMPT_THEN_EXECUTE, INSTRUCTIONS, JSP_FILE, LABEL, OPERATION_CLASS, OPERATION_CODE, OPERATION_DISPLAY_MODE, OPERATION_DISPLAY_MODE_FULL, OPERATION_DISPLAY_MODE_SKINNY, OPERATION_HTTP_ID, OPERATION_ID, OPERATION_SET, OPERATION_SQL, OPERATION_TABLE_NAME, OUTPUT_ALIAS, OWNER_ID, PARAMETERS_JSP_FILE, PARENT_ID, PERFORMACE_STATISTICS_ID, PROPERTIES, ROW_CLASS, ROW_COLLECTION_CLASS, ROW_COUNT, SECURITY_ID, SECURITY_TYPE, SET_NAME, THEME_ID, TITLE, TYPE, TYPE_ASSOCIATED_EXECUTION_GROUP, TYPE_ASSOCIATED_JAVA_OPERATION, TYPE_ASSOCIATED_JOIN, TYPE_ASSOCIATION_1_TO_1, TYPE_ASSOCIATION_1_TO_MANY, TYPE_AUTHENTICATION, TYPE_AUTO_POPULATE, TYPE_AUTORUN_BATCH_PROCESS, TYPE_AUTORUN_EMAIL, TYPE_BLOB_DOWNLOAD, TYPE_EMAIL, TYPE_EXECUTION_GROUP, TYPE_FILE_UPLOAD, TYPE_HTML_CODE, TYPE_HTML_CODE_ASSOCIATION, TYPE_HTML_REFERENCE, TYPE_HTML_REFERENCE_ASSOCIATION, TYPE_JAVA_OPERATION, TYPE_JSP_REFERENCE, TYPE_JSP_REFERENCE_ASSOCIATION, TYPE_POSSIBLE_VALUES, TYPE_POSSIBLE_VALUES_SEARCH, TYPE_POSSIBLE_VALUES_SELECTOR, TYPE_REFERER_AUTHORIZATION_OPERATION, TYPE_SQL, TYPE_TABBED, TYPE_TABBED_ASSOCIATION, TYPE_UNKNOWN, TYPE_USER_AUTHENTICATION_LIST_OPERATION, TYPE_USER_AUTHORIZATION_LIST_OPERATION, TYPE_USER_AUTHORIZATION_OPERATION, TYPE_VIEW_SELECTED_ASSOCIATION, USAGE_ID

Fields inherited from interface planetj.magic.IMagicRequest

IS_COMPLETE, MAGIC_REQUEST, MAGIC_REQUEST_CLASS, MAGIC_REQUEST_PARAM1, MAGIC_REQUEST_RC, SAME_URI, TYPE, TYPE_PAGE, TYPE_SESSION, TYPE_STATIC, USER_REQUEST_ATTRIBUTES_STORED

Fields inherited from interface planetj.dataengine.IFeature

DEFAULT_MESSAGE_FEATURE, FEATURE_DELETE, FEATURE_INSERT, FEATURE_LEVEL_ENTERPRISE, FEATURE_LEVEL_ENTRY, FEATURE_LEVEL_PROFESSIONAL, FEATURE_LEVEL_STANDARD, FEATURE_UPDATE, MESSAGE_END, MESSAGE_START

Constructor Summary

AssociationRequest(HttpServletRequest request, HttpServletResponse response)
AssociationRequest constructor comment.

AssociationRequest(java.lang.String id, HttpServletRequest request, HttpServletResponse response)
Deprecated. id no longer needed - use AssociationRequest(request, response)

AssociationRequest(java.lang.String id, java.lang.String rcKey, java.lang.String rowKey, HttpServletRequest request, HttpServletResponse response)
Deprecated. AssociationRequest no longer uses given rcKey and rowKey, rather it extracts these keys as well as the field from the request

Method Summary

IMagicRequest	execute(HttpServletRequest request, HttpServletResponse response, DataEngineServlet servlet) Execute method comment.
void	executeOperation(Field field, Operation operation, HttpServletRequest request, HttpServletResponse response, DataEngineServlet servlet)
void	executeOperation(Field field, Row row, Operation operation, HttpServletRequest request, HttpServletResponse response, DataEngineServlet servlet)
int	getFeatureLevel() Gets the minimum feature level requried to execute this operation
Operation	getOperation() Get the operation for this request.
Operation	getPleaseWaitOperation(ExecutingContext ec) Gets the Operation used to control the please wait functionality for this MR.
boolean	isStartNewNavigationGroup() Tests whether or not this magic request needs to start a new navigation group.
void	setNextURIs(Operation operation, HttpServletRequest request)
void	setOperation(Operation operation)

Methods inherited from class planetj.magic.AbstractSelectionRequest

getSelectedField, getSelectedFieldName, getSelectedRow, getSelectedRowCollection, getSelectedRowCollectionKey, getSelectedRowKey

Methods inherited from class planetj.magic.MagicRequest

getCurrentMagicRequest, getPrimaryMagicRequest, getType, store

Methods inherited from class planetj.magic.AbstractMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, appendUnsupportedHTMLMessage, changeMode, clone, clone, equals, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, getDefaultPageType, getFailMessage, getFirstRequest, getId, getKey, getLastRequest, getMagicRequestParameter, getMagicServletURI, getMagicURI, getNextURI, getPleaseWaitJSP, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isLoadParameterValuesFromRequest, isOverridePrimaryNavigation, isPleaseWait, isPopup, isRepeatable, isReturnToRequester, isSaveResults, postexecute, postExecute, preexecute, preExecute, processPleaseWait, removeRequestAttribute, removeSessionAttribute, removeSharedSessionAttribute, setAnchorName, setBaseField, setBaseRow, setBaseRowCollection, setCompleted, setEndNavigationGroup, setFailMessage, setId, setLoadParameterValuesFromRequest, setNextURI, setNextURI, setNextURI, setNextURIs, setOverridePrimaryNavigation, setPopup, setRepeatable, setRequestGroupAttribute, setRequestPageAttribute, setRequestPersistentAttribute, setRequestTransientAttribute, setReturnToRequester, setRowEventListener, setSessionAttribute, setSessionSharedAttribute, setStartNewNavigationGroup, setSuccessMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface planetj.magic.IMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, executeAll, getBaseField, getBaseRow, getCurrentURI, getFirstRequest, getId, getKey, getLastRequest, getMagicRequestParameter, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isOverridePrimaryNavigation, isRepeatable, isReturnToRequester, isSaveResults, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup

Methods inherited from interface planetj.dataengine.IFeature

appendUnsupportedHTMLMessage, isApplicable

Constructor Detail

AssociationRequest

public AssociationRequest(java.lang.String id,
                          java.lang.String rcKey,
                          java.lang.String rowKey,
                          HttpServletRequest request,
                          HttpServletResponse response)

Deprecated. AssociationRequest no longer uses given rcKey and rowKey, rather it extracts these keys as well as the field from the request

AssociationRequest constructor comment.

AssociationRequest

public AssociationRequest(HttpServletRequest request,
                          HttpServletResponse response)

AssociationRequest constructor comment.

AssociationRequest

public AssociationRequest(java.lang.String id,
                          HttpServletRequest request,
                          HttpServletResponse response)

Deprecated. id no longer needed - use AssociationRequest(request, response)

AssociationRequest constructor comment.

Method Detail

execute

public final IMagicRequest execute(HttpServletRequest request,
                                   HttpServletResponse response,
                                   DataEngineServlet servlet)
                            throws CMException

Execute method comment.

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

Throws:

CMException

executeOperation

public void executeOperation(Field field,
                             Operation operation,
                             HttpServletRequest request,
                             HttpServletResponse response,
                             DataEngineServlet servlet)
                      throws CMException

Throws:

CMException

executeOperation

public void executeOperation(Field field,
                             Row row,
                             Operation operation,
                             HttpServletRequest request,
                             HttpServletResponse response,
                             DataEngineServlet servlet)
                      throws CMException

Throws:

CMException

setNextURIs

public void setNextURIs(Operation operation,
                        HttpServletRequest request)

getOperation

public Operation getOperation()
                       throws CMException

Get the operation for this request.

Throws:

CMException

setOperation

public void setOperation(Operation operation)

getFeatureLevel

public int getFeatureLevel()

Gets the minimum feature level requried to execute this operation

Specified by:

getFeatureLevel in interface IFeature

Overrides:

getFeatureLevel in class AbstractMagicRequest

getPleaseWaitOperation

public Operation getPleaseWaitOperation(ExecutingContext ec)
                                 throws CMException

Gets the Operation used to control the please wait functionality for this MR. (Null may be returned, in which case this MR will not use the please wait functionality)

Overrides:

getPleaseWaitOperation in class AbstractMagicRequest

Throws:

CMException

isStartNewNavigationGroup

public boolean isStartNewNavigationGroup()

Description copied from interface: IMagicRequest

Tests whether or not this magic request needs to start a new navigation group.

Specified by:

isStartNewNavigationGroup in interface IMagicRequest

Overrides:

isStartNewNavigationGroup in class AbstractMagicRequest