com.bmc.arsys.api
Class FormCriteria

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

All Implemented Interfaces:

Serializable, Cloneable

public class FormCriteria
extends ObjectBaseCriteria
implements Serializable

This class is used to provide the criteria of the various forms. The criteria can be used in retrieving the required form.

See Also:

Serialized Form

Field Summary

static int	ADMIN_GROUP_LIST Returns groups who can administer this form.
static int	ARCHIVE_INFO Returns archive info of specified form
static int	ASSIGNED_GROUPS Returns the list of group actually assigned to the specified form
static int	AUDIT_INFO Returns the audit info of the specified form
static int	DEFAULT_CRITERIA The default criteria -- allows for setting all other criteria flags.
static int	DEFAULT_VUI Returns default view of specified form
static int	ENTRYLIST_FIELDLIST Returns fields that identify the default query list for retrieving form entries.
static int	INDEX_LIST Returns indexes of form.
static int	SCHEMA_TYPE Returns specific type of form, whether regular ("base") or join.
static int	SORT_LIST Returns fields that identify the default sort order for retrieving form entries.
static int	USE_REALNAME Overlay: Returns forms 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

FormCriteria()
Constructs a new FormCriteria object.

Method Summary

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

equals, hashCode, toString

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

SCHEMA_TYPE

public static final int SCHEMA_TYPE

Returns specific type of form, whether regular ("base") or join.

ADMIN_GROUP_LIST

public static final int ADMIN_GROUP_LIST

Returns groups who can administer this form.

ENTRYLIST_FIELDLIST

public static final int ENTRYLIST_FIELDLIST

Returns fields that identify the default query list for retrieving form entries.

SORT_LIST

public static final int SORT_LIST

Returns fields that identify the default sort order for retrieving form entries.

INDEX_LIST

public static final int INDEX_LIST

Returns indexes of form.

DEFAULT_VUI

public static final int DEFAULT_VUI

Returns default view of specified form

ARCHIVE_INFO

public static final int ARCHIVE_INFO

Returns archive info of specified form

AUDIT_INFO

public static final int AUDIT_INFO

Returns the audit info of the specified form

ASSIGNED_GROUPS

public static final int ASSIGNED_GROUPS

Returns the list of group actually assigned to the specified form

USE_REALNAME

public static final int USE_REALNAME

Overlay: Returns forms with real name.

DEFAULT_CRITERIA

public static final int DEFAULT_CRITERIA

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

Constructor Detail

FormCriteria

public FormCriteria()

Constructs a new FormCriteria object. By default all form information is retrieved.