asjava.uniclientlibs
Class UniRecord

java.lang.Object
  extended byasjava.uniclientlibs.UniString
      extended byasjava.uniclientlibs.UniDynArray
          extended byasjava.uniclientlibs.UniRecord
All Implemented Interfaces:
java.io.Serializable

public class UniRecord
extends UniDynArray
implements java.io.Serializable

UniRecord is used to control UniVerse Record interaction. It is an extension of the UniDynArray object, and thus behaves in a similar fashion. All UniDynArray operations can be performed, and will be performed on the data portion of this object.

Since:
UNICLIENTLIBS 1.0
Version:
Version 1.0
Author:
David T. Meeks
See Also:
Serialized Form

Field Summary
 
Fields inherited from class asjava.uniclientlibs.UniString
count, inPacket, outPacket, uniConnection, uniReturnCode, uniStatus, value
 
Constructor Summary
UniRecord()
          Constructs a UniRecord with no data in it.
UniRecord(java.lang.Object aRecID)
          Constructs a UniRecord with just the record ID
UniRecord(java.lang.Object aRecID, java.lang.Object aRecVal)
          Constructs a UniRecord with the record ID and record data
UniRecord(java.lang.Object aRecID, java.lang.Object aRecVal, int aStatus)
          Constructs a UniRecord with the record ID and record data, setting the initial status as well
 
Method Summary
 UniDynArray getRecord()
          return the objects data value
 UniDynArray getRecordID()
          return the objects RecordID
 int returnCode()
          return the objects return code
 void setRecord(java.lang.Object aRecVal)
          sets the objects data value param aRecVal UniDynArray representing the objects record data value
 void setRecord(java.lang.String aRecVal)
          sets the objects data value param aRecVal UniDynArray representing the objects record data value
 void setRecord(UniDynArray aRecVal)
          sets the objects data value param aRecVal UniDynArray representing the objects record data value
 void setRecordID(java.lang.Object aRecID)
          sets the objects RecordID value param aRecID UniDynArray representing the objects record ID
 void setRecordID(UniDynArray aRecID)
          sets the objects RecordID value param aRecID UniDynArray representing the objects record ID
 void setReturnCode(int aReturnCode)
          sets the objects return value param aReturnCode integer representing the objects return code
 void setStatus(int aStatusVal)
          sets the objects status value param aStatusVal integer representing the objects status
 int status()
          return the objects stats
 java.lang.String toString()
          returns the String representation of the object.
 UniDynArray toUniDynArray()
          returns the UniDynArray representation of the object.
 UniString toUniString()
          returns the UniString representation of the object.
 
Methods inherited from class asjava.uniclientlibs.UniDynArray
count, count, count, count, dcount, dcount, dcount, dcount, delete, delete, delete, extract, extract, extract, insert, insert, insert, length, length, length, regenerateDynArray, remove, remove, remove, replace, replace, replace, setValue, setValue
 
Methods inherited from class asjava.uniclientlibs.UniString
alpha, alpha, append, append, append, append, append, append, append, append, append, append, change, change, change, charAt, compareTo, convert, convert, count, dcount, equals, equalsIgnoreCase, getBytes, getBytes, getChars, getInternalMarkCharacter, getMarkCharacter, iconv, insert, insert, insert, insert, insert, insert, insert, left, length, oconv, quote, quote, right, setCharAt, substring, substring, toCharArray, toLowerCase, toUpperCase
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UniRecord

public UniRecord()
Constructs a UniRecord with no data in it.

Since:
UNICLIENTLIBS 1.0

UniRecord

public UniRecord(java.lang.Object aRecID)
Constructs a UniRecord with just the record ID

Parameters:
aRecID - the record ID this record represents
Since:
UNICLIENTLIBS 1.0

UniRecord

public UniRecord(java.lang.Object aRecID,
                 java.lang.Object aRecVal)
Constructs a UniRecord with the record ID and record data

Parameters:
aRecID - the record ID this record represents
aRecVal - the record Data this record represents...
Since:
UNICLIENTLIBS 1.0

UniRecord

public UniRecord(java.lang.Object aRecID,
                 java.lang.Object aRecVal,
                 int aStatus)
Constructs a UniRecord with the record ID and record data, setting the initial status as well

Parameters:
aRecID - the record ID this record represents
aRecVal - the record Data this record represents...
aStatus - the initial status value of this record
Since:
UNICLIENTLIBS 1.0
Method Detail

getRecordID

public UniDynArray getRecordID()
return the objects RecordID

Returns:
UniDynArray representing the objects record ID
Since:
UNICLIENTLIBS 1.0

getRecord

public UniDynArray getRecord()
return the objects data value

Returns:
UniDynArray representing the objects record data
Since:
UNICLIENTLIBS 1.0

returnCode

public int returnCode()
return the objects return code

Returns:
integer representing the objects record return code
Since:
UNICLIENTLIBS 1.0

status

public int status()
return the objects stats

Overrides:
status in class UniString
Returns:
integer representing the objects status
Since:
UNICLIENTLIBS 1.0

setRecordID

public void setRecordID(java.lang.Object aRecID)
sets the objects RecordID value param aRecID UniDynArray representing the objects record ID

Since:
UNICLIENTLIBS 1.0

setRecordID

public void setRecordID(UniDynArray aRecID)
sets the objects RecordID value param aRecID UniDynArray representing the objects record ID

Since:
UNICLIENTLIBS 1.0

setRecord

public void setRecord(java.lang.Object aRecVal)
sets the objects data value param aRecVal UniDynArray representing the objects record data value

Since:
UNICLIENTLIBS 1.0

setRecord

public void setRecord(UniDynArray aRecVal)
sets the objects data value param aRecVal UniDynArray representing the objects record data value

Since:
UNICLIENTLIBS 1.0

setRecord

public void setRecord(java.lang.String aRecVal)
sets the objects data value param aRecVal UniDynArray representing the objects record data value

Since:
UNICLIENTLIBS 1.0

setReturnCode

public void setReturnCode(int aReturnCode)
sets the objects return value param aReturnCode integer representing the objects return code

Since:
UNICLIENTLIBS 1.0

setStatus

public void setStatus(int aStatusVal)
sets the objects status value param aStatusVal integer representing the objects status

Since:
UNICLIENTLIBS 1.0

toString

public java.lang.String toString()
returns the String representation of the object. The recordID and record data are combined, being separated by a uniVerse @IM character. return String representing the objects string representation

Overrides:
toString in class UniDynArray
Returns:
a String object representing the dynamic array
Since:
UNICLIENTLIBS 1.0

toUniDynArray

public UniDynArray toUniDynArray()
returns the UniDynArray representation of the object. return UniDynArray representing the objects as a UniDynArray

Since:
UNICLIENTLIBS 1.0

toUniString

public UniString toUniString()
returns the UniString representation of the object. return UniString representing the objects as a UniString

Since:
UNICLIENTLIBS 1.0