com.remedy.arsys.api
Class ContainerCriteria

java.lang.Object
  com.remedy.arsys.api.CriteriaFlags
      com.remedy.arsys.api.ContainerCriteria

public class ContainerCriteria

extends CriteriaFlags

The ContainerCriteria class is used to specify the list of Container information to retrieve on a findByKey or findObjects call.

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	CHANGE_DIARY Flag used to set or get the change diary associated with the 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	DESCRIPTION Flag used to set or get the description for this container.
static int	HELP_TEXT Flag used to set or get the Help text associated with the container.
static int	LABEL Flag used to set or get the label for this container.
static int	LAST_CHANGED Flag used to set or get the user who made the last change to the container.
static int	NAME Returns the name of the container.
static int	OWNER Flag used to set or get the owning user for the container.
static int	PERMISSIONS Flag used to set or get the list of zero or more groups who can access this container.
static int	PROPERTY_LIST Flag used to set or get the object properties list associated with the container.
static int	REFERENCES Flag used to set or get the pointers to the objects (for example, forms or filters) referenced by this container.
static int	TIMESTAMP Flag used to set or get the time stamp identifying the last change to the container.

Constructor Summary

ContainerCriteria()
Constructs a new ContainerCriteria object.

Method Summary

ReferenceType[]	getReferenceTypes() Returns list of the types of references (for example, forms and filters).
void	setReferenceTypes(ReferenceType[] refs) Sets list of the types of references (for example, forms and filters).

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

getParameters, getPropertiesToRetrieve, resetChangeFlags, setParameter, setPropertiesToRetrieve, setRetrieveAll

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSIONS

public static final int PERMISSIONS

Flag used to set or get the list of zero or more groups who can access this container.

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.

HELP_TEXT

public static final int HELP_TEXT

Flag used to set or get the Help text associated with the container.

OWNER

public static final int OWNER

Flag used to set or get the owning user for the container.

TIMESTAMP

public static final int TIMESTAMP

Flag used to set or get the time stamp identifying the last change to the container.

LAST_CHANGED

public static final int LAST_CHANGED

Flag used to set or get the user who made the last change to the container.

CHANGE_DIARY

public static final int CHANGE_DIARY

Flag used to set or get the change diary associated with the container.

PROPERTY_LIST

public static final int PROPERTY_LIST

Flag used to set or get the object properties list associated with the container.

NAME

public static final int NAME

Returns the name of the container.

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.