public class CriteriaFlags extends Object implements Cloneable, Serializable
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 and Description |
---|
CriteriaFlags(int nSize)
Constructs a new
Criteria object with the given properties. |
Modifier and Type | Method and Description |
---|---|
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[] |
getParameters() |
int |
getPropertiesToRetrieve()
Returns an integer value that represents the bitmask of all the properties that the user has selected to
retrieve.
|
int |
hashCode()
Returns the hash code value for this instance of the current class.
|
void |
resetCriteriaFlags()
reset all flags to false -- sets not to retrieve any of the object properties
|
void |
setParameter(long index,
boolean bValue) |
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.
|
String |
toString()
Returns a string description of the object.
|
public CriteriaFlags(int nSize)
Criteria
object with the given properties.public void setParameter(long index, boolean bValue)
public boolean[] getParameters()
public void setRetrieveAll(boolean flag)
public int getPropertiesToRetrieve()
getPropertiesToRetrieve()
method and that property. A "true" result
indicates that the property is set.public void setPropertiesToRetrieve(int i)
public void resetCriteriaFlags()
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
public String toString()
public int hashCode()
public boolean equals(Object obj)
? Copyright 2013 BMC Software, Inc.