com.bmc.arsys.api
Class ObjectBaseCriteria

java.lang.Object
  com.bmc.arsys.api.CriteriaFlags
      com.bmc.arsys.api.ObjectBaseCriteria

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ActiveLinkCriteria, ContainerCriteria, EscalationCriteria, FieldCriteria, FilterCriteria, FormCriteria, ImageCriteria, MenuCriteria, ViewCriteria

public class ObjectBaseCriteria
extends CriteriaFlags
implements Serializable

This class is base class of all the object criteria class. The criteria is used to filter the specified objects that are required.

See Also:

Serialized Form

Field Summary

static int	CHANGE_DIARY Returns change diary of specified object.
static int	HELP_TEXT Returns help text of specified object.
static int	LAST_CHANGED Returns user who made last change to specified object.
static int	NAME Returns the name of the specified object.
static int	OWNER Returns owning user of specified object.
static int	PERMISSIONS Returns list of groups who can access specified object.
static int	PROPERTY_LIST Returns object property tags of specified object.
static int	TIMESTAMP Returns time stamp of specified object.

Method Summary

boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
int	hashCode() Returns the hash code value for this instance of the current class.
String	toString() Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.CriteriaFlags

clone, getParameters, getPropertiesToRetrieve, resetCriteriaFlags, setParameter, setPropertiesToRetrieve, setRetrieveAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final int NAME

Returns the name of the specified object.

PERMISSIONS

public static final int PERMISSIONS

Returns list of groups who can access specified object. Access to this information is limited to users with AR System administrator privileges only.

HELP_TEXT

public static final int HELP_TEXT

Returns help text of specified object.

TIMESTAMP

public static final int TIMESTAMP

Returns time stamp of specified object.

OWNER

public static final int OWNER

Returns owning user of specified object.

LAST_CHANGED

public static final int LAST_CHANGED

Returns user who made last change to specified object.

CHANGE_DIARY

public static final int CHANGE_DIARY

Returns change diary of specified object.

PROPERTY_LIST

public static final int PROPERTY_LIST

Returns object property tags of specified object. These are defined by AR System. You can use the following constants:

• 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 timestamp of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_USER: (TIME): Indicates the SCC username for 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.

Method Detail

toString

public String toString()

Description copied from class: CriteriaFlags

Returns a string description of the object.

Overrides:

toString in class CriteriaFlags

hashCode

public int hashCode()

Description copied from class: CriteriaFlags

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 CriteriaFlags

Returns:

returns the hash code for this instance

equals

public boolean equals(Object obj)

Description copied from class: CriteriaFlags

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 CriteriaFlags

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal