AR System Java API

com.bmc.arsys.api
Class Filter

java.lang.Object
  extended by com.bmc.arsys.api.ObjectBase
      extended by com.bmc.arsys.api.Filter
All Implemented Interfaces:
IARPersistentObject, Serializable, Cloneable

public class Filter
extends ObjectBase
implements IARPersistentObject, Cloneable, Serializable

The Filter class and methods are used to represent the properties of filter objects.

Note: All the constants used in the Filter class are found in the Constants class.

See Also:
Serialized Form

Constructor Summary
Filter()
           
Filter(int order, List<String> formList, int opSet, boolean enable, QualifierInfo query, List<FilterAction> actionList, List<FilterAction> elseList, ObjectPropertyMap objPropList, String name, String helpText, int lastUpdateTime, String owner, String lastChangedBy, String diaryStr)
           
 
Method Summary
 void clear()
          Clears all of the references to member objects.
 Object clone()
          Clone implementation that returns an Object with data cloned from self.
 boolean equals(Object obj)
          Use this method for checking equality between the current object and the provided one.
 boolean equals(Object anObject, String lhsServer, String rhsServer)
           
 List<FilterAction> getActionList()
          Returns the set of actions performed if the condition defined by the query parameter is satisfied.
 List<FilterAction> getElseList()
          Returns a list of actions performed if the condition defined by the query parameter is not satisfied.
 int getErrorFilterOptions()
           
 String getErrorHandlingFilter()
           
 List<String> getFormList()
           
 String getKey()
          Returns the unique identifier for filter.
 int getOpSet()
          Returns the form operations that trigger the filter.
 int getOrder()
          Returns a value between 0 and 1000 (inclusive) that determines the filter execution order.
 String getPrimaryForm()
           
 ObjectPropertyMap getProperties()
          Returns a list of server object property tags you can specify.
 QualifierInfo getQualifier()
          Returns the qualification that determines which set of If/Else actions should be executed.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 boolean isEnable()
          Returns the flag to enable or disable this filter.
 void setActionList(List<FilterAction> actionList)
          Sets a list of actions performed if the condition defined by the query parameter is satisfied.
 void setElseList(List<FilterAction> elseList)
          Sets a list of actions performed if the condition defined by the query parameter is not satisfied.
 void setEnable(boolean enable)
          Sets the flag to enable or disable this filter.
 void setErrorFilterOptions(int errorFilterOptions)
           
 void setErrorHandlingFilter(String errorHandlingFilter)
           
 void setFormList(List<String> formList)
           
 void setKey(String key)
          Sets the unique identifier for filter.
 void setOpSet(int opSet)
          Sets the form operations that trigger the filter.
 void setOrder(int order)
          Sets a value between 0 and 1000 (inclusive) that determines the filter execution order.
 void setPrimaryForm(String primaryForm)
           
 void setProperties(ObjectPropertyMap objPropList)
          Sets a list of server object property tags you can specify.
 void setQualifier(QualifierInfo query)
          Sets the qualification that determines which set of If/Else actions should be executed.
 String toString()
          Returns a string description of the object.
 
Methods inherited from class com.bmc.arsys.api.ObjectBase
appendDiaryText, getChangeFlags, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setChangeFlags, setDiary, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.bmc.arsys.api.IARPersistentObject
appendDiaryText, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions
 

Constructor Detail

Filter

public Filter()

Filter

public Filter(int order,
              List<String> formList,
              int opSet,
              boolean enable,
              QualifierInfo query,
              List<FilterAction> actionList,
              List<FilterAction> elseList,
              ObjectPropertyMap objPropList,
              String name,
              String helpText,
              int lastUpdateTime,
              String owner,
              String lastChangedBy,
              String diaryStr)
Method Detail

clear

public void clear()
Description copied from class: ObjectBase
Clears all of the references to member objects.

Overrides:
clear in class ObjectBase

getOrder

public int getOrder()
Returns a value between 0 and 1000 (inclusive) that determines the filter execution order.


setOrder

public void setOrder(int order)
Sets a value between 0 and 1000 (inclusive) that determines the filter execution order. When multiple filters are associated with a form, the value associated with each filter determines the order in which they are processed (from lowest to highest).


getOpSet

public int getOpSet()
Returns the form operations that trigger the filter.


setOpSet

public void setOpSet(int opSet)
Sets the form operations that trigger the filter. You can use the following constants:


isEnable

public boolean isEnable()
Returns the flag to enable or disable this filter.


setEnable

public void setEnable(boolean enable)
Sets the flag to enable or disable this filter. A value of 0 disables the filter, causing its condition checks and associated actions to not be performed. A value of 1 enables the filter, causing its conditions to be checked for each form operation specified by the getOpSet() parameter.


getFormList

public List<String> getFormList()

setFormList

public void setFormList(List<String> formList)

getPrimaryForm

public String getPrimaryForm()

setPrimaryForm

public void setPrimaryForm(String primaryForm)

getQualifier

public QualifierInfo getQualifier()
Returns the qualification that determines which set of If/Else actions should be executed.


setQualifier

public void setQualifier(QualifierInfo query)
Sets the qualification that determines which set of If/Else actions should be executed. Specify NULL or assign an operation value of 0 (Constants.AR_COND_OP_NONE) if the filter has no qualification. Specify to execute the filter unconditionally.


getProperties

public ObjectPropertyMap getProperties()
Returns a list of server object property tags you can specify. If getProperties parameter is NULL, a list of zero properties is returned.


setProperties

public void setProperties(ObjectPropertyMap objPropList)
Sets a list of server object property tags you can specify. The constant values listed below are defined by AR System:


getActionList

public List<FilterAction> getActionList()
Returns the set of actions performed if the condition defined by the query parameter is satisfied.


setActionList

public void setActionList(List<FilterAction> actionList)
Sets a list of actions performed if the condition defined by the query parameter is satisfied. This list can contain from 1 to 25 actions (limited by Constants.AR_MAX_ACTIONS).


getElseList

public List<FilterAction> getElseList()
Returns a list of actions performed if the condition defined by the query parameter is not satisfied.


setElseList

public void setElseList(List<FilterAction> elseList)
Sets a list of actions performed if the condition defined by the query parameter is not satisfied. This list can contain from 0 to 25 actions (limited by Constants.AR_MAX_ACTIONS.


getKey

public String getKey()
Returns the unique identifier for filter.


setKey

public void setKey(String key)
Sets the unique identifier for filter.


clone

public Object clone()
             throws CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self.

Overrides:
clone in class ObjectBase
Throws:
CloneNotSupportedException

equals

public boolean equals(Object obj)
Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:
equals in class ObjectBase
Parameters:
obj - the object that we are comparing to
Returns:
returns a boolean that tells if the two objects equal

equals

public boolean equals(Object anObject,
                      String lhsServer,
                      String rhsServer)

hashCode

public int hashCode()
Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:
hashCode in class ObjectBase
Returns:
returns the hash code for this instance

toString

public String toString()
Returns a string description of the object.

Overrides:
toString in class ObjectBase

getErrorFilterOptions

public int getErrorFilterOptions()
Returns:
the errorFilterOptions

setErrorFilterOptions

public void setErrorFilterOptions(int errorFilterOptions)
Parameters:
errorFilterOptions - the errorFilterOptions to set

getErrorHandlingFilter

public String getErrorHandlingFilter()
Returns:
the errorHandlingFilter

setErrorHandlingFilter

public void setErrorHandlingFilter(String errorHandlingFilter)
Parameters:
errorHandlingFilter - the errorHandlingFilter to set

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.