com.remedy.arsys.api
Class Filter

java.lang.Object
  com.remedy.arsys.api.ObjectBase
      com.remedy.arsys.api.Filter

All Implemented Interfaces:

java.lang.Cloneable, IARPersistentObject

public class Filter

extends ObjectBase

implements IARPersistentObject, java.lang.Cloneable

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.

Field Summary

Fields inherited from class com.remedy.arsys.api.ObjectBase

m_changeFlags, m_permissionList

Method Summary

void	activate() Remedy reserved method.
void	clear() Clears all of the references to member objects.
java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
void	create() Creates this object on the AR System server.
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
boolean	equals(java.lang.Object anObject, java.lang.String lhsServer, java.lang.String rhsServer)
FilterActionInfo[]	getActionList() Returns the set of actions performed if the condition defined by the query parameter is satisfied.
FilterActionInfo[]	getElseList() Returns a list of actions performed if the condition defined by the query parameter is not satisfied.
long	getEnable() Returns the flag to enable or disable this filter.
FilterKey	getKey() Returns the unique identifier for filter.
PropInfo[]	getObjPropList() Returns a list of server object property tags you can specify.
long	getOpSet() Returns the form operations that trigger the filter.
long	getOrder() Returns a value between 0 and 1000 (inclusive) that determines the filter execution order.
QualifierInfo	getQualifier() Returns the qualification that determines which set of If/Else actions should be executed.
WorkflowConnectInfo	getWorkflowConnect() Returns the list of form names the filter is linked to.
int	hashCode() Returns the hash code value for this instance of the current class.
void	load() Populates this object with information from the AR System server.
void	load(FilterCriteria criteria) Populates this object with information specified by FilterCriteria from the AR System server.
void	passivate() Remedy reserved method.
void	remove() Removes this object on the AR System server.
void	setActionList(FilterActionInfo[] actionList) Sets a list of actions performed if the condition defined by the query parameter is satisfied.
void	setContext(ARServerUser ctx) Associates ARServerUser information with this AR System server object.
void	setDeleteOption(int option) Sets the delete option indicating the action to take if specified in the filter.
void	setElseList(FilterActionInfo[] elseList) Sets a list of actions performed if the condition defined by the query parameter is not satisfied.
void	setEnable(long enable) Sets the flag to enable or disable this filter.
void	setKey(FilterKey key) Sets the unique identifier for filter.
void	setObjPropList(PropInfo[] objPropList) Sets a list of server object property tags you can specify.
void	setOpSet(long opSet) Sets the form operations that trigger the filter.
void	setOrder(long order) Sets a value between 0 and 1000 (inclusive) that determines the filter execution order.
void	setQualifier(QualifierInfo query) Sets the qualification that determines which set of If/Else actions should be executed.
void	setWorkflowConnect(WorkflowConnectInfo workflowConnect) Sets the list of form names the filter is linked to.
void	store() Updates this filter on the database
void	unsetContext() Removes the association to a specific user context.

Methods inherited from class com.remedy.arsys.api.ObjectBase

getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, resetChangeFlags, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

setContext

public void setContext(ARServerUser ctx)

Description copied from interface: IARPersistentObject

Associates ARServerUser information with this AR System server object.

Specified by:

setContext in interface IARPersistentObject

unsetContext

public void unsetContext()

Description copied from interface: IARPersistentObject

Removes the association to a specific user context. This is equal to setContext(null).

Specified by:

unsetContext in interface IARPersistentObject

clear

public void clear()

Description copied from interface: IARPersistentObject

Clears all of the references to member objects.

Specified by:

clear in interface IARPersistentObject

Overrides:

clear in class ObjectBase

setDeleteOption

public void setDeleteOption(int option)

Sets the delete option indicating the action to take if specified in the filter.

Parameters:

option - Possible values are:

• 0: Do not delete the filter.
• 1: Delete the entire block to which the filter belongs.

create

public void create()
            throws ARException

Creates this object on the AR System server.

Specified by:

create in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not created

remove

public void remove()
            throws ARException

Removes this object on the AR System server.

Specified by:

remove in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not removed

load

public void load()
          throws ARException

Populates this object with information from the AR System server.

Specified by:

load in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not loaded

load

public void load(FilterCriteria criteria)
          throws ARException

Populates this object with information specified by FilterCriteria from the AR System server.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not loaded

store

public void store()
           throws ARException

Updates this filter on the database

Specified by:

store in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not saved

activate

public void activate()

Remedy reserved method.

Specified by:

activate in interface IARPersistentObject

passivate

public void passivate()

Remedy reserved method.

Specified by:

passivate in interface IARPersistentObject

getOrder

public long getOrder()

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

setOrder

public void setOrder(long 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 long getOpSet()

Returns the form operations that trigger the filter.

setOpSet

public void setOpSet(long opSet)

Sets the form operations that trigger the filter. You can use the following constants:

• Constants.AR_OPERATION_NONE -- Do not execute the filter.
• Constants.AR_OPERATION_GET -- Execute the filter on get operations.
• Constants.AR_OPERATION_SET -- Execute the filter on set operations.
• Constants.AR_OPERATION_CREATE -- Execute the filter on create operations.
• Constants.AR_OPERATION_DELETE -- Execute the filter on delete operations.
• Constants.AR_OPERATION_MERGE -- Execute the filter on merge operations.
• Constants.AR_OPERATION_GUIDE -- Execute the filter in a filter guide. .

getEnable

public long getEnable()

Returns the flag to enable or disable this filter. A value of 0 means the filter is disabled. A value of 1 means the filter is enabled.

setEnable

public void setEnable(long 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.

getWorkflowConnect

public WorkflowConnectInfo getWorkflowConnect()

Returns the list of form names the filter is linked to.

setWorkflowConnect

public void setWorkflowConnect(WorkflowConnectInfo workflowConnect)

Sets the list of form names the filter is linked to. The filter must be associated with a single form or a list of forms that currently exists on the server.

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.

getObjPropList

public PropInfo[] getObjPropList()

Returns a list of server object property tags you can specify. If getObjPropList parameter is NULL, a list of zero properties is returned.

setObjPropList

public void setObjPropList(PropInfo[] objPropList)

Sets a list of server object property tags you can specify. The constant values listed below are defined by AR System:

• Constants.AR_OPROP_VENDOR_NAME: (CHAR): Indicates the vendor name. For example, ? BMC Software.?
• Constants.AR_OPROP_VENDOR_PRODUCT: (CHAR): Indicates the product name. For example, ? AR System.?
• Constants.AR_OPROP_VENDOR_VERSION: (CHAR): Indicates the vendor version. For example, ? 6.0?
• Constants.AR_OPROP_GUID: (CHAR): Indicates the globally unique identifier for the object.
• Constants.AR_OPROP_COPYRIGHT: (CHAR): Indicates the copyright string.
• Constants.AR_OPROP_SCC_LOCKED_BY:(CHAR): Indicates the name of user who has locked the object.
• Constants.AR_OPROP_SCC_VERSION: (CHAR): Indicates the version of the Source Code Control (SCC) system.
• Constants.AR_OPROP_SCC_TIMESTAMP: (TIME): Indicates the SCC timestamp.
• Constants.AR_OPROP_SCC_USER: (CHAR): Indicates the SCC username.
• Constants.AR_OPROP_SCC_LOCATION: (CHAR): Indicates the location within the SCC system where the object may be found.
• Constants.AR_OPROP_SCC_DATA_LOCKED_BY: (CHAR): Indicates the name of the user who has "locked" the data or entries stored in a form under revision control. The AR System server does not enforce this lock and thus it is to be considered an advisory lock only.
• Constants.AR_OPROP_SCC_DATA_VERSION: (CHAR): Indicates the SCC version of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_TIMESTAMP: (CHAR): Indicates the SCC version of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_USER: (TIME): Indicates the SCC username fore the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_LOCATION: (CHAR): Indicates the location within the SCC system where the data or entries stored in a form under revision control.

getActionList

public FilterActionInfo[] getActionList()

Returns the set of actions performed if the condition defined by the query parameter is satisfied.

setActionList

public void setActionList(FilterActionInfo[] 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 FilterActionInfo[] getElseList()

Returns a list of actions performed if the condition defined by the query parameter is not satisfied.

setElseList

public void setElseList(FilterActionInfo[] 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 FilterKey getKey()

Returns the unique identifier for filter.

setKey

public void setKey(FilterKey key)

Sets the unique identifier for filter.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class ObjectBase

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality. The result is true only if the argument is not null, is of same type and represents the same content.

Overrides:

equals in class ObjectBase

equals

public boolean equals(java.lang.Object anObject,
                      java.lang.String lhsServer,
                      java.lang.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