|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectasjava.uniobjects.UniBase
asjava.uniobjects.UniSelectList
UniSelectList
is used to control, access, and manipulate server
side select lists.
Field Summary |
---|
Fields inherited from class asjava.uniobjects.UniBase |
---|
inPacket, outPacket, uniConnection, uniEncryptionType, uniParentSession, uniStatus |
Constructor Summary | |
---|---|
UniSelectList()
|
|
UniSelectList(UniSession aSession,
int aSelectListNumber)
Returns the runtime class of the object |
Method Summary | |
---|---|
void |
clearList()
Clears the selected list, emptying the contents and preparing for a new select list to be generated. |
void |
formList(java.lang.Object aString)
creates a new select list from the supplied list of record IDs |
void |
formList(UniDataSet aDataSet)
creates a new select list from the supplied list of record IDs contained in the UniDataSet object |
void |
getList(java.lang.Object aListName)
activates the named select list from the &SAVEDLISTS& file on the server |
boolean |
isLastRecordRead()
boolean entry denoting whether or not the last record has been read. |
UniString |
next()
returns the next record ID in the select list. |
UniDynArray |
readList()
reads the entire contents of the select list and returns it all at once |
void |
saveList(java.lang.Object aListNameObj)
Saves the current select list in &SAVEDLISTS& file on the server with the name supplied |
void |
select(UniDictionary uniFile)
creates a new select list by selecting the UniDictionary object and
generating a select list of all the record IDs from that file. |
void |
select(UniFile uniFile)
creates a new select list by selecting the UniFile object and
generating a select list of all the record IDs from that file. |
void |
selectAlternateKey(UniDictionary unid,
java.lang.Object aIndexName)
generate a select list from the given UniDictionary from values in the
secondary key index that is specified. |
void |
selectAlternateKey(UniFile uniFile,
java.lang.Object aIndexName)
generate a select list from the given UniFile from values in the
secondary key index that is specified. |
void |
selectMatchingAK(UniDictionary unid,
java.lang.Object aIndexName,
java.lang.Object aIndexValue)
generate a select list from the given UniDictionary from values in the
secondary key index that is specified whose value matches that in the named
value. |
void |
selectMatchingAK(UniFile uniFile,
java.lang.Object aIndexName,
java.lang.Object aIndexValue)
generate a select list from the given UniFile from values in the
secondary key index that is specified whose value matches that in the named
value. |
Methods inherited from class asjava.uniobjects.UniBase |
---|
getEncryptionType, isCommandActive, setEncryptionType, status |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public UniSelectList() throws UniSelectListException
public UniSelectList(UniSession aSession, int aSelectListNumber) throws UniSelectListException
Method Detail |
public void clearList() throws UniSelectListException
UniSelectListException
- is thrown if an error condition occurspublic void formList(java.lang.Object aString) throws UniSelectListException
aString
- a delimited String or UniDynArray containing the records IDs to use
UniSelectListException
- is thrown if an error condition occurspublic void formList(UniDataSet aDataSet) throws UniSelectListException
aDataSet
- an existing UniDataSet object
UniSelectListException
- is thrown if an error condition occurspublic void getList(java.lang.Object aListName) throws UniSelectListException
aListName
- String denoting the name of which select list to activate
UniSelectListException
- is thrown if an error condition occurspublic boolean isLastRecordRead()
true
denotes that no more records are left in the select list.
true
means the select list has no more records
false
means the select list still has records IDs
public UniString next() throws UniSelectListException
null
value and the isLastRecordRead
method will return
true
null
if exhausted
UniSelectListException
- is thrown if an error condition occursisLastRecordRead()
public UniDynArray readList() throws UniSelectListException
UniSelectListException
- is thrown if an error condition occurspublic void saveList(java.lang.Object aListNameObj) throws UniSelectListException
aListNameObj
- String denoting the name the select list should be saved to
UniSelectListException
- is thrown if an error condition occurspublic void select(UniFile uniFile) throws UniSelectListException
UniFile
object and
generating a select list of all the record IDs from that file. It will overwrite
any previous select list and the select list pointer will be reset to the first
record in the list.
uniFile
- UniFile
object to be selected
UniSelectListException
- is thrown if an error condition occurspublic void select(UniDictionary uniFile) throws UniSelectListException
UniDictionary
object and
generating a select list of all the record IDs from that file. It will overwrite
any previous select list and the select list pointer will be reset to the first
record in the list.
uniFile
- UniDictionary
object to be selected
UniSelectListException
- is thrown if an error condition occurspublic void selectAlternateKey(UniFile uniFile, java.lang.Object aIndexName) throws UniSelectListException
UniFile
from values in the
secondary key index that is specified.
uniFile
- UniFile
to be selectedaIndexName
- index name to select on
UniSelectListException
- is thrown if an error condition occurspublic void selectAlternateKey(UniDictionary unid, java.lang.Object aIndexName) throws UniSelectListException
UniDictionary
from values in the
secondary key index that is specified.
unid
- UniDictionary
to be selectedaIndexName
- index name to select on
UniSelectListException
- is thrown if an error condition occurspublic void selectMatchingAK(UniFile uniFile, java.lang.Object aIndexName, java.lang.Object aIndexValue) throws UniSelectListException
UniFile
from values in the
secondary key index that is specified whose value matches that in the named
value.
uniFile
- UniFile
to be selectedaIndexName
- index name to select onaIndexValue
- value within the index to select to
UniSelectListException
- is thrown if an error condition occurspublic void selectMatchingAK(UniDictionary unid, java.lang.Object aIndexName, java.lang.Object aIndexValue) throws UniSelectListException
UniDictionary
from values in the
secondary key index that is specified whose value matches that in the named
value.
unid
- UniDictionary
to be selectedaIndexName
- index name to select onaIndexValue
- value from the secondary key index. Records are selected when the
indexed field matches this value.
UniSelectListException
- is thrown if an error condition occurs
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |