com.remedy.arsys.api
Class ReferenceBase

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

Direct Known Subclasses:

ExternalReferenceInfo, ReferenceInfo

public class ReferenceBase

extends java.lang.Object

The ReferenceBase class is the base class for SYSTEM_REFERENCE and EXTERNAL_REFERENCE. (getDataType()) Used to set and return the objects referenced by a container.

Field Summary

static int	EXTERNAL_REFERENCE External reference data type (ExternalReferenceInfo)
static int	SYSTEM_REFERENCE Internal reference data type (InternalID)

Constructor Summary

protected

ReferenceBase(java.lang.String label, java.lang.String desc, ReferenceType refType, int dataType)

Method Summary

java.lang.Object	clone() Makes a deep copy of the object.
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
int	getDataType() Returns an integer specifying the type of reference.
char[]	getDescription() Returns a string specifying a display-only description for the reference.
char[]	getLabel() Returns a string specifying a display-only label for the reference.
ReferenceType	getReferenceType() Returns union that defines either an internal or external reference depending on its datatype,which is either 0 (Constants.ARREF_DATA_ARSREF) or 1 (Constants.ARREF_DATA_EXTREF).
int	hashCode() This method can be used to populate a hash table.
void	setDataType(int nType) Sets an integer specifying the type of reference.
void	setDescription(char[] desc) Sets a character string specifying a display-only description for the reference.
void	setDescription(java.lang.String desc) Sets a string specifying a display-only description for the reference.
void	setLabel(char[] label) Sets a character string specifying a display-only label for the reference.
void	setLabel(java.lang.String label) Sets a string specifying a display-only label for the reference.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYSTEM_REFERENCE

public static final int SYSTEM_REFERENCE

Internal reference data type (InternalID)

EXTERNAL_REFERENCE

public static final int EXTERNAL_REFERENCE

External reference data type (ExternalReferenceInfo)

Constructor Detail

ReferenceBase

protected ReferenceBase(java.lang.String label,
                        java.lang.String desc,
                        ReferenceType refType,
                        int dataType)

Method Detail

clone

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

Makes a deep copy of the object.

Overrides:

clone in class java.lang.Object

getLabel

public char[] getLabel()

Returns a string specifying a display-only label for the reference.

setLabel

public void setLabel(java.lang.String label)

Sets a string specifying a display-only label for the reference. Its length is limited by Constants.ARMAX_CON_LABEL_LEN (255 bytes).

setLabel

public void setLabel(char[] label)

Sets a character string specifying a display-only label for the reference. Its length is limited by Constants.ARMAX_CON_LABEL_LEN (255 bytes).

getDescription

public char[] getDescription()

Returns a string specifying a display-only description for the reference.

setDescription

public void setDescription(java.lang.String desc)

Sets a string specifying a display-only description for the reference. Its length is limited by Constants.ARMAX_CON_DESCRIPTION_LEN (2000 bytes).

setDescription

public void setDescription(char[] desc)

Sets a character string specifying a display-only description for the reference. Its length is limited by Constants.ARMAX_CON_DESCRIPTION_LEN (2000 bytes).

getReferenceType

public ReferenceType getReferenceType()

Returns union that defines either an internal or external reference depending on its datatype,which is either 0 (Constants.ARREF_DATA_ARSREF) or 1 (Constants.ARREF_DATA_EXTREF).

getDataType

public int getDataType()

Returns an integer specifying the type of reference. Possible values include the following constants (reference types):

• Constants.ARREF_NONE
• Constants.ARREF_ALL
• Constants.ARREF_SCHEMA
• Constants.ARREF_FILTER
• Constants.ARREF_ESCALATION
• Constants.ARREF_ACTLINK
• Constants.ARREF_CONTAINER
• Constants.ARREF_CHAR_MENU
• Constants.ARREF_LAST_SERVER_OBJ

AR System-defined external references

• Constants.ARREF_ICON
• Constants.ARREF_SMALL_ICON
• Constants.ARREF_MAXIMIZE_FORMS
• Constants.ARREF_APPLICATION_FORMS
• Constants.ARREF_ABOUT_BOX_IMAGE
• Constants.ARREF_NULL_STRING
• Constants.ARREF_APPLICATION_HELP_EXT
• Constants.ARREF_APPLICATION_HELP_FILE
• Constants.ARREF_APPLICATION_PRIMARY_FORM
• Constants.ARREF_APPLICATION_FORM_VUI
• Constants.ARREF_APPLICATION_DISABLE_BEGIN_TASK
• Constants.ARREF_APPLICATION_HELP_INDEX_EXT
• Constants.ARREF_APPLICATION_HELP_INDEX_FILE
• Constants.ARREF_APPLICATION_HELP_FILE_NAME
• Constants.ARREF_PACKINGLIST_GUIDE
• Constants.ARREF_PACKINGLIST_APP
• Constants.ARREF_PACKINGLIST_PACK
• Constants.ARREF_GROUP_DATA
• Constants.ARREF_DISTMAPPING_DATA
• Constants.ARREF_APPLICATION_HAS_EXT_HELP
• Constants.ARREF_APPLICATION_SUPPORT_FILES
• Constants.ARREF_ACTIVELINK_GUIDE_HAS_QUERY_LIST_LOOP
• Constants.ARREF_ACTIVELINK_GUIDE_QUERY_LIST_LOOP_FIELD
• Constants.ARREF_PACKINGLIST_DSOPOOL
• Constants.ARREF_PACKINGLIST_FILTER_GUIDE
• Constants.ARREF_LAST_RESERVED

setDataType

public void setDataType(int nType)

Sets an integer specifying the type of reference. Possible values include the following constants:

• Constants.ARREF_NONE
• Constants.ARREF_ALL
• Constants.ARREF_SCHEMA
• Constants.ARREF_FILTER
• Constants.ARREF_ESCALATION
• Constants.ARREF_ACTLINK
• Constants.ARREF_CONTAINER
• Constants.ARREF_CHAR_MENU
• Constants.ARREF_LAST_SERVER_OBJ

AR System-defined external references

• Constants.ARREF_ICON
• Constants.ARREF_SMALL_ICON
• Constants.ARREF_MAXIMIZE_FORMS
• Constants.ARREF_APPLICATION_FORMS
• Constants.ARREF_ABOUT_BOX_IMAGE
• Constants.ARREF_NULL_STRING
• Constants.ARREF_APPLICATION_HELP_EXT
• Constants.ARREF_APPLICATION_HELP_FILE
• Constants.ARREF_APPLICATION_PRIMARY_FORM
• Constants.ARREF_APPLICATION_FORM_VUI
• Constants.ARREF_APPLICATION_DISABLE_BEGIN_TASK
• Constants.ARREF_APPLICATION_HELP_INDEX_EXT
• Constants.ARREF_APPLICATION_HELP_INDEX_FILE
• Constants.ARREF_APPLICATION_HELP_FILE_NAME
• Constants.ARREF_PACKINGLIST_GUIDE
• Constants.ARREF_PACKINGLIST_APP
• Constants.ARREF_PACKINGLIST_PACK
• Constants.ARREF_GROUP_DATA
• Constants.ARREF_DISTMAPPING_DATA
• Constants.ARREF_APPLICATION_HAS_EXT_HELP
• Constants.ARREF_APPLICATION_SUPPORT_FILES
• Constants.ARREF_ACTIVELINK_GUIDE_HAS_QUERY_LIST_LOOP
• Constants.ARREF_ACTIVELINK_GUIDE_QUERY_LIST_LOOP_FIELD
• Constants.ARREF_PACKINGLIST_DSOPOOL
• Constants.ARREF_PACKINGLIST_FILTER_GUIDE
• Constants.ARREF_LAST_RESERVED

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality. The result is true if and only if the argument is not null, is of same type and represents the same content.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

This method can be used to populate a hash table. Implicitly used method to test equality of objects.

Overrides:

hashCode in class java.lang.Object