com.remedy.arsys.api
Class EntryPointMultiCriteria

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

public class EntryPointMultiCriteria

extends CriteriaFlags

The EntryPointMultiCriteria class specifies the entry point properties to retrieve.

Field Summary

static int	DISCRIPTION The description of the entry point.
static int	ENTRY_POINT_DISPLAY_LABEL The display label for the entry point.
static int	HELP_TEXT The help text of the entry point.
static int	OWNER_APP_DISPLAY_LABEL The application display label of the entry point owner.
static int	OWNER_APP_NAME The application name of the entry point owner.
static int	OWNER_OBJ_LIST The list of schemas that own the entry point.
static int	PERMISSIONS Permissions (access control) of the entry point.
static int	PROPERTY_LIST Returns object property tags of specified entry point.
static int	REFERENCES Entry point reference list.
static int	TIMESTAMP The time stamp of the entry point.

Constructor Summary

EntryPointMultiCriteria()

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

ENTRY_POINT_DISPLAY_LABEL

public static final int ENTRY_POINT_DISPLAY_LABEL

The display label for the entry point.

See Also:

Constant Field Values

OWNER_APP_NAME

public static final int OWNER_APP_NAME

The application name of the entry point owner.

See Also:

Constant Field Values

OWNER_APP_DISPLAY_LABEL

public static final int OWNER_APP_DISPLAY_LABEL

The application display label of the entry point owner.

See Also:

Constant Field Values

PERMISSIONS

public static final int PERMISSIONS

Permissions (access control) of the entry point.

See Also:

Constant Field Values

OWNER_OBJ_LIST

public static final int OWNER_OBJ_LIST

The list of schemas that own the entry point.

See Also:

Constant Field Values

DISCRIPTION

public static final int DISCRIPTION

The description of the entry point.

See Also:

Constant Field Values

REFERENCES

public static final int REFERENCES

Entry point reference list.

See Also:

Constant Field Values

HELP_TEXT

public static final int HELP_TEXT

The help text of the entry point.

See Also:

Constant Field Values

TIMESTAMP

public static final int TIMESTAMP

The time stamp of the entry point.

See Also:

Constant Field Values

PROPERTY_LIST

public static final int PROPERTY_LIST

Returns object property tags of specified entry point. 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.

See Also:

Constant Field Values

Constructor Detail

EntryPointMultiCriteria

public EntryPointMultiCriteria()

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.