com.remedy.arsys.api
Class SchemaCriteria

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

public class SchemaCriteria

extends CriteriaFlags

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

Field Summary

static int	ADMIN_GROUP_LIST Returns groups who can administer this schema.
static int	ARCHIVE_INFO Returns archive info of specified schema
static int	CHANGE_DIARY Returns change diary of specified schema.
static int	DEFAULT_VUI Returns default view of specified schema
static int	ENTRYLIST_FIELDLIST Returns fields that identify the default query list for retrieving schema entries.
static int	HELP_TEXT Returns help text of specified schema.
static int	INDEX_LIST Returns indexes of schema.
static int	LAST_CHANGED Returns user who made last change to specified schema.
static int	NAME Returns the name of the specified schema.
static int	OWNER Returns owner of specified schema.
static int	PERMISSIONS Returns schema permissions.
static int	PROPERTY_LIST Returns object property tags of specified schema.
static int	SCHEMA_TYPE Returns specific type of schema, whether regular ("base") or join.
static int	SORT_LIST Returns fields that identify the default sort order for retrieving schema entries.
static int	TIMESTAMP Returns time stamp of specified schema.

Constructor Summary

SchemaCriteria()
Constructs a new SchemaCriteria object.

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

SCHEMA_TYPE

public static final int SCHEMA_TYPE

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

PERMISSIONS

public static final int PERMISSIONS

Returns schema permissions.

ADMIN_GROUP_LIST

public static final int ADMIN_GROUP_LIST

Returns groups who can administer this schema.

ENTRYLIST_FIELDLIST

public static final int ENTRYLIST_FIELDLIST

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

SORT_LIST

public static final int SORT_LIST

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

INDEX_LIST

public static final int INDEX_LIST

Returns indexes of schema.

HELP_TEXT

public static final int HELP_TEXT

Returns help text of specified schema.

TIMESTAMP

public static final int TIMESTAMP

Returns time stamp of specified schema.

OWNER

public static final int OWNER

Returns owner of specified schema.

LAST_CHANGED

public static final int LAST_CHANGED

Returns user who made last change to specified schema.

CHANGE_DIARY

public static final int CHANGE_DIARY

Returns change diary of specified schema.

PROPERTY_LIST

public static final int PROPERTY_LIST

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

• AR_OPROP_VENDOR_NAME: (CHAR): Indicates the vendor name. For example, ? BMC Software.?
• AR_OPROP_VENDOR_PRODUCT: (CHAR): Indicates the product name. For example, ? AR System.?
• AR_OPROP_VENDOR_VERSION: (CHAR): Indicates the vendor version. For example, ? 6.0.?
• AR_OPROP_GUID: (CHAR): Indicates the globally unique identifier for the object.
• AR_OPROP_COPYRIGHT: (CHAR): Indicates the copyright string.
• AR_OPROP_SCC_LOCKED_BY:(CHAR): Indicates the name of user who has locked the object.
• AR_OPROP_SCC_VERSION: (CHAR): Indicates the version of the Source Code Control (SCC) system.
• AR_OPROP_SCC_TIMESTAMP: (TIME): Indicates the SCC timestamp.
• AR_OPROP_SCC_USER: (CHAR): Indicates the SCC username.
• AR_OPROP_SCC_LOCATION: (CHAR): Indicates the location within the SCC system where the object may be found.
• 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.
• AR_OPROP_SCC_DATA_VERSION: (CHAR): Indicates the SCC version of the data or entries stored in a form under revision control.
• AR_OPROP_SCC_DATA_TIMESTAMP: (CHAR): Indicates the SCC timestamp of the data or entries stored in a form under revision control.
• AR_OPROP_SCC_DATA_USER : (TIME): Indicates the SCC username for the data or entries stored in a form under revision control.
• AR_OPROP_SCC_DATA_LOCATION: (CHAR): Indicates the location within the SCC system where the data or entries are stored in a form under revision control.

DEFAULT_VUI

public static final int DEFAULT_VUI

Returns default view of specified schema

ARCHIVE_INFO

public static final int ARCHIVE_INFO

Returns archive info of specified schema

NAME

public static final int NAME

Returns the name of the specified schema.

Constructor Detail

SchemaCriteria

public SchemaCriteria()

Constructs a new SchemaCriteria object. By default all schema information is retrieved.