com.remedy.arsys.api
Class ReferenceType

java.lang.Object
  |
  +--com.remedy.arsys.api.ReferenceType

public class ReferenceType

extends java.lang.Object

implements java.lang.Cloneable

The ReferenceType class specifies the type of internal and external references that can be used by the ReferenceBase.getReferenceType() method.

Field Summary

static ReferenceType	ABOUT_BOX_FORM External reference to an About box schema.
static ReferenceType	ABOUT_BOX_IMAGE External reference to an About box image
static ReferenceType	ACTIVELINK Internal reference to an active link
static ReferenceType	ALL All reference types
static ReferenceType	APPLICATION_DISABLE_BEGIN_TASK External reference to a boolean value that specifies whether the Begin a Task menu item is disabled for this application.
static ReferenceType	APPLICATION_FORM_VUI External reference to the ID of the schema view to use with the previous schema referenced in the list.
static ReferenceType	APPLICATION_FORMS External reference specifying that the next reference in the list is a schema.
static ReferenceType	APPLICATION_HAS_EXT_HELP External reference to whether application uses external help or not (boolean value)
static ReferenceType	APPLICATION_HELP_EXT External reference to a string that specifies the help filename extension
static ReferenceType	APPLICATION_HELP_FILE External reference to a bytelist that specifies the contents (not the name) of the help file to use with this application
static ReferenceType	APPLICATION_HELP_FILE_NAME External reference to an application object help file's name, without the extension
static ReferenceType	APPLICATION_HELP_INDEX_EXT External reference to an application object help file's index file extension
static ReferenceType	APPLICATION_HELP_INDEX_FILE External reference to an application object help file's index file
static ReferenceType	APPLICATION_PRIMARY_FORM External reference specifying that the next reference in the list is the primary schema for this application.
static ReferenceType	CHAR_MENU Internal reference to a character menu
static ReferenceType	CONTAINER Internal reference to a container
static ReferenceType	DISTMAPPING_DATA External reference to a packing list's reference to data in the Distributed Mapping schema
static ReferenceType	ESCALATION Internal reference to an escalation
static ReferenceType	FILTER Internal reference to a filter
static ReferenceType	GROUP_DATA External reference to a packing list's reference to data in the Group schema
static ReferenceType	ICON External reference to an icon
static ReferenceType	MAXIMIZE_FORMS External reference to a boolean value in container that specifies whether to maximize the forms of an application.
static ReferenceType	NONE No references
static ReferenceType	NULL_STRING External reference to a NULL string.
static ReferenceType	PACKINGLIST_APP External reference to a packing list's reference to an application
static ReferenceType	PACKINGLIST_GUIDE External reference to a packing list's reference to a Guide
static ReferenceType	PACKINGLIST_PACK External reference to a packing list's reference to a packing list
static ReferenceType	SCHEMA Internal reference to a schema
static ReferenceType	SMALL_ICON External reference to a small icon

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
int	toInt() Returns an integer value of the reference type.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final ReferenceType NONE

No references

ALL

public static final ReferenceType ALL

All reference types

SCHEMA

public static final ReferenceType SCHEMA

Internal reference to a schema

FILTER

public static final ReferenceType FILTER

Internal reference to a filter

ESCALATION

public static final ReferenceType ESCALATION

Internal reference to an escalation

ACTIVELINK

public static final ReferenceType ACTIVELINK

Internal reference to an active link

CONTAINER

public static final ReferenceType CONTAINER

Internal reference to a container

CHAR_MENU

public static final ReferenceType CHAR_MENU

Internal reference to a character menu

ICON

public static final ReferenceType ICON

External reference to an icon

SMALL_ICON

public static final ReferenceType SMALL_ICON

External reference to a small icon

MAXIMIZE_FORMS

public static final ReferenceType MAXIMIZE_FORMS

External reference to a boolean value in container that specifies whether to maximize the forms of an application.

APPLICATION_FORMS

public static final ReferenceType APPLICATION_FORMS

External reference specifying that the next reference in the list is a schema. Use this reference in front of each schema reference in your application except the primary schema.

ABOUT_BOX_IMAGE

public static final ReferenceType ABOUT_BOX_IMAGE

External reference to an About box image

ABOUT_BOX_FORM

public static final ReferenceType ABOUT_BOX_FORM

External reference to an About box schema.

NULL_STRING

public static final ReferenceType NULL_STRING

External reference to a NULL string.

APPLICATION_HELP_EXT

public static final ReferenceType APPLICATION_HELP_EXT

External reference to a string that specifies the help filename extension

APPLICATION_HELP_FILE

public static final ReferenceType APPLICATION_HELP_FILE

External reference to a bytelist that specifies the contents (not the name) of the help file to use with this application

APPLICATION_PRIMARY_FORM

public static final ReferenceType APPLICATION_PRIMARY_FORM

External reference specifying that the next reference in the list is the primary schema for this application. Use this reference in front of only one schema reference in your application.

APPLICATION_FORM_VUI

public static final ReferenceType APPLICATION_FORM_VUI

External reference to the ID of the schema view to use with the previous schema referenced in the list. Use this reference after each schema reference in your application.

APPLICATION_DISABLE_BEGIN_TASK

public static final ReferenceType APPLICATION_DISABLE_BEGIN_TASK

External reference to a boolean value that specifies whether the Begin a Task menu item is disabled for this application. The default is false (not disabled).

APPLICATION_HELP_INDEX_EXT

public static final ReferenceType APPLICATION_HELP_INDEX_EXT

External reference to an application object help file's index file extension

APPLICATION_HELP_INDEX_FILE

public static final ReferenceType APPLICATION_HELP_INDEX_FILE

External reference to an application object help file's index file

APPLICATION_HELP_FILE_NAME

public static final ReferenceType APPLICATION_HELP_FILE_NAME

External reference to an application object help file's name, without the extension

PACKINGLIST_GUIDE

public static final ReferenceType PACKINGLIST_GUIDE

External reference to a packing list's reference to a Guide

PACKINGLIST_APP

public static final ReferenceType PACKINGLIST_APP

External reference to a packing list's reference to an application

PACKINGLIST_PACK

public static final ReferenceType PACKINGLIST_PACK

External reference to a packing list's reference to a packing list

GROUP_DATA

public static final ReferenceType GROUP_DATA

External reference to a packing list's reference to data in the Group schema

DISTMAPPING_DATA

public static final ReferenceType DISTMAPPING_DATA

External reference to a packing list's reference to data in the Distributed Mapping schema

APPLICATION_HAS_EXT_HELP

public static final ReferenceType APPLICATION_HAS_EXT_HELP

External reference to whether application uses external help or not (boolean value)

Method Detail

toInt

public int toInt()

Returns an integer value of the reference type.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class java.lang.Object