Overview  Package   Class  Tree  Deprecated  Index  Help 
Action Request System Java API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

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.
 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()
          Sets 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).
 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
equals, finalize, getClass, hashCode, 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. Its length is limited by Constants.ARMAX_CON_LABEL_LEN (255 bytes).

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. Its length is limited by Constants.ARMAX_CON_DESCRIPTION_LEN (2000 bytes).

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()
Sets 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):

Remedy-defined external references

setDataType

public void setDataType(int nType)
Sets an integer specifying the type of reference. Possible values include the following constants:

Remedy-defined external references

Overview  Package   Class  Tree  Deprecated  Index  Help 
Action Request System Java API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD