com.bmc.arsys.api
Class ContainerCriteria

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

All Implemented Interfaces:

Serializable, Cloneable

public class ContainerCriteria
extends ObjectBaseCriteria
implements Serializable

The ContainerCriteria class is used to specify the list of Container information.

See Also:

Serialized Form

Field Summary

static int	ADMIN_GROUP_LIST Flag used to set or get the list of zero or more groups who can administer this container (and the referenced objects).
static int	ASSIGNED_GROUP Flag used to set or get the pointers to the objects (for example, forms or filters) referenced by this container.
static int	CONTAINER_OWNER Flag used to set or get the form that owns this container.
static int	CONTAINER_TYPE Flag used to set or get the type for this container.
static int	DEFAULT_CRITERIA The default criteria -- allows for setting all other criteria flags.
static int	DESCRIPTION Flag used to set or get the description for this container.
static int	LABEL Flag used to set or get the label for this container.
static int	REFERENCES Flag used to set or get the pointers to the objects (for example, forms or filters) referenced by this container.
int	USE_REALNAME Overlay: Returns container object with real name.

Fields inherited from class com.bmc.arsys.api.ObjectBaseCriteria

CHANGE_DIARY, HELP_TEXT, LAST_CHANGED, NAME, OWNER, PERMISSIONS, PROPERTY_LIST, TIMESTAMP

Constructor Summary

ContainerCriteria()
Constructs a new ContainerCriteria object.

Method Summary

boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
ReferenceType[]	getReferenceTypes() Returns list of the types of references (for example, forms and filters).
int	hashCode() Returns the hash code value for this instance of the current class.
void	setReferenceTypes(ReferenceType[] refs) Sets list of the types of references (for example, forms and filters).
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

ADMIN_GROUP_LIST

public static final int ADMIN_GROUP_LIST

Flag used to set or get the list of zero or more groups who can administer this container (and the referenced objects). If ownerObj does not return NULL, this list is the Subadministrator group list of the owning form. Users must belong to both a specified group and the Subadministrator group to obtain these privileges. Specify NULL for this parameter if you do not want to retrieve the administrator group list.

CONTAINER_OWNER

public static final int CONTAINER_OWNER

Flag used to set or get the form that owns this container.

LABEL

public static final int LABEL

Flag used to set or get the label for this container.

DESCRIPTION

public static final int DESCRIPTION

Flag used to set or get the description for this container.

CONTAINER_TYPE

public static final int CONTAINER_TYPE

Flag used to set or get the type for this container.

REFERENCES

public static final int REFERENCES

Flag used to set or get the pointers to the objects (for example, forms or filters) referenced by this container.

ASSIGNED_GROUP

public static final int ASSIGNED_GROUP

Flag used to set or get the pointers to the objects (for example, forms or filters) referenced by this container.

USE_REALNAME

public final int USE_REALNAME

Overlay: Returns container object with real name.

DEFAULT_CRITERIA

public static final int DEFAULT_CRITERIA

The default criteria -- allows for setting all other criteria flags.

Constructor Detail

ContainerCriteria

public ContainerCriteria()

Constructs a new ContainerCriteria object. By default none of Container information is retrieved.

Method Detail

setReferenceTypes

public void setReferenceTypes(ReferenceType[] refs)

Sets list of the types of references (for example, forms and filters). You can specify individual types of references to set, specify that all (Constants.ARREF_ALL) or none (Constants.ARREF_NONE) of the references be set, or specify negative numbers to treat the types of references as exclude reference types. The exclude reference types take precedence over the include list; this means that if you specify a type as positive as well as negative, then all references of that type are excluded.

getReferenceTypes

public ReferenceType[] getReferenceTypes()

Returns list of the types of references (for example, forms and filters). You can specify individual types of references to return, specify that all (Constants.ARREF_ALL) or none (Constants.ARREF_NONE) of the references be returned, or specify negative numbers to treat the types of references as exclude reference types.

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class ObjectBaseCriteria

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 ObjectBaseCriteria

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 ObjectBaseCriteria

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal