com.bmc.arsys.api

Class CriteriaFlags

java.lang.Object

com.bmc.arsys.api.CriteriaFlags

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

AlertMessageCriteria, LocalizedValueCriteria, ObjectBaseCriteria, SupportFileCriteria

public class CriteriaFlags
extends Object
implements Cloneable, Serializable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CriteriaFlags(int nSize) Constructs a new Criteria object with the given properties.

Method Summary

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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CriteriaFlags

public CriteriaFlags(int nSize)

Constructs a new Criteria object with the given properties.

Method Detail

setParameter

public void setParameter(long index,
                         boolean bValue)

getParameters

public boolean[] getParameters()

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.

resetCriteriaFlags

public void resetCriteriaFlags()

reset all flags to false -- sets not to retrieve any of the object properties

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object

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 Object

Returns:

returns the hash code for this instance

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 Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal