com.remedy.arsys.api
Class CriteriaFlags

java.lang.Object
  |
  +--com.remedy.arsys.api.CriteriaFlags

Direct Known Subclasses:

ActiveLinkCriteria, AlertMessageCriteria, ContainerCriteria, EscalationCriteria, FieldCriteria, FilterCriteria, LocalizedValueCriteria, MenuCriteria, SchemaCriteria, SupportFileCriteria, VerifyUserCriteria, ViewCriteria

public class CriteriaFlags

extends java.lang.Object

The CriteriaFlags class is used to describe the properties needed to be retrieved for many of the server objects.

The CriteriaFlags class is the superclass of the different <Object>Criteria classes. The <Object>Criteria sub-classes (for example, ActiveLinkCriteria) are derived from the CriteriaFlags class, and they are used for retrieving information from their particular server object.

Constructor Summary

protected	CriteriaFlags() Constructs a new Criteria object.
	CriteriaFlags(int nSize) Constructs a new Criteria object with the given properties.

Method Summary

int	getPropertiesToRetrieve() Returns an integer value that represents the bitmask of all the properties that the user has selected to retrieve.
void	setPropertiesToRetrieve(int i) Sets an integer value that represents the bitmask of all the properties that the user has selected to retrieve.
void	setRetrieveAll(boolean flag) Sets whether all the object properties are to be retrieved or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

CriteriaFlags

protected CriteriaFlags()

Constructs a new Criteria object.

CriteriaFlags

public CriteriaFlags(int nSize)

Constructs a new Criteria object with the given properties.

Method Detail

setRetrieveAll

public void setRetrieveAll(boolean flag)

Sets whether all the object properties are to be retrieved or not.

getPropertiesToRetrieve

public int getPropertiesToRetrieve()

Returns an integer value that represents the bitmask of all the properties that the user has selected to retrieve. To find out whether a particular property is set or not, the user has to do a "logical and" (&&) operation on the value returned by the getPropertiesToRetrieve() method and that property. A "true" result indicates that the property is set.

setPropertiesToRetrieve

public void setPropertiesToRetrieve(int i)

Sets an integer value that represents the bitmask of all the properties that the user has selected to retrieve. This method takes the integer value of a bitmask that specifies the list of object properties to retrieve. To retrieve several properties, the user can use the logical OR (||) operation.