com.esri.gpt.framework.request
Class ActionCriteria

java.lang.Object
  com.esri.gpt.framework.request.Criteria
      com.esri.gpt.framework.request.ActionCriteria

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HeActionCriteria, HjActionCriteria, HrActionCriteria, MmdActionCriteria

public class ActionCriteria
extends Criteria

Represents the criteria associated with an action.

An action is typically associated with a database modification (create/update/delete).

See Also:

Serialized Form

Constructor Summary

ActionCriteria()
Default constructor.

ActionCriteria(ActionCriteria criteriaToDuplicate)
Construct by duplicating a supplied action criteria.

Method Summary

String	getActionKey() Gets the key representing the action to be performed.
String	getSelectedRecordIds() Gets a delimited string (comma space ;) of record ids selected for an action.
StringSet	getSelectedRecordIdSet() Gets the set of selected record ids.
void	reset() Resets the criteria.
void	setActionKey(String actionKey) Sets the key representing the action to be performed.
void	setSelectedRecordIds(String ids) Sets a delimited string (comma space ;) of record ids selected for an action.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionCriteria

public ActionCriteria()

Default constructor.

ActionCriteria

public ActionCriteria(ActionCriteria criteriaToDuplicate)

Construct by duplicating a supplied action criteria.

Parameters:

criteriaToDuplicate - the criteria to duplicate

Method Detail

getActionKey

public String getActionKey()

Gets the key representing the action to be performed.

Returns:

the action key

setActionKey

public void setActionKey(String actionKey)

Sets the key representing the action to be performed.

Parameters:

actionKey - the action key

getSelectedRecordIds

public String getSelectedRecordIds()

Gets a delimited string (comma space ;) of record ids selected for an action.
This property is just a store supporting the transfer of UI selection criteria to the back-end action.

Returns:

the delimited string of ids

setSelectedRecordIds

public void setSelectedRecordIds(String ids)

Sets a delimited string (comma space ;) of record ids selected for an action.
This property is just a store supporting the transfer of UI selection criteria to the back-end action.

Parameters:

ids - the delimited string of ids

getSelectedRecordIdSet

public StringSet getSelectedRecordIdSet()

Gets the set of selected record ids.

Returns:

the set of selected record ids

reset

public void reset()

Resets the criteria.

Specified by:

reset in class Criteria