All Packages Class Hierarchy This Package Previous Next Index
Class asjava.uniobjects.UniSelectList
java.lang.Object
|
+----asjava.uniobjects.UniBase
|
+----asjava.uniobjects.UniSelectList
- public class UniSelectList
- extends UniBase
UniSelectList
is used to control, access, and manipulate server
side select lists.
- Version:
- Version 1.0
- Author:
- David T. Meeks
-
UniSelectList()
-
-
UniSelectList(UniSession, int)
- Returns the runtime class of the object
-
clearList()
- Clears the selected list, emptying the contents and preparing for a new select
list to be generated.
-
formList(Object)
- creates a new select list from the supplied list of record IDs
-
formList(UniDataSet)
- creates a new select list from the supplied list of record IDs contained in the
UniDataSet object
-
getList(Object)
- activates the named select list from the &SAVEDLISTS& file on the server
-
isLastRecordRead()
-
boolean entry denoting whether or not the last record has been read.
-
next()
- returns the next record ID in the select list.
-
readList()
- reads the entire contents of the select list and returns it all at once
-
saveList(Object)
- Saves the current select list in &SAVEDLISTS& file on the server with the name
supplied
-
select(UniDictionary)
- creates a new select list by selecting the
UniDictionary
object and
generating a select list of all the record IDs from that file.
-
select(UniFile)
- creates a new select list by selecting the
UniFile
object and
generating a select list of all the record IDs from that file.
-
selectAlternateKey(UniDictionary, Object)
- generate a select list from the given
UniDictionary
from values in the
secondary key index that is specified.
-
selectAlternateKey(UniFile, Object)
- generate a select list from the given
UniFile
from values in the
secondary key index that is specified.
-
selectMatchingAK(UniDictionary, Object, Object)
- 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.
-
selectMatchingAK(UniFile, Object, Object)
- 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.
UniSelectList
public UniSelectList() throws UniSelectListException
UniSelectList
public UniSelectList(UniSession aSession,
int aSelectListNumber) throws UniSelectListException
- Returns the runtime class of the object
clearList
public void clearList() throws UniSelectListException
- Clears the selected list, emptying the contents and preparing for a new select
list to be generated.
- Throws: UniSelectListException
- is thrown if an error condition occurs
formList
public void formList(Object aString) throws UniSelectListException
- creates a new select list from the supplied list of record IDs
- Parameters:
- aString - a delimited String or UniDynArray containing the records IDs to use
- Throws: UniSelectListException
- is thrown if an error condition occurs
formList
public void formList(UniDataSet aDataSet) throws UniSelectListException
- creates a new select list from the supplied list of record IDs contained in the
UniDataSet object
- Parameters:
- aDataSet - an existing UniDataSet object
- Throws: UniSelectListException
- is thrown if an error condition occurs
getList
public void getList(Object aListName) throws UniSelectListException
- activates the named select list from the &SAVEDLISTS& file on the server
- Parameters:
- aListName - String denoting the name of which select list to activate
- Throws: UniSelectListException
- is thrown if an error condition occurs
isLastRecordRead
public boolean isLastRecordRead()
- boolean entry denoting whether or not the last record has been read.
true
denotes that no more records are left in the select list.
- Returns:
- the boolean value representing whether the last record was read.
-
true
means the select list has no more records
-
false
means the select list still has records IDs
next
public UniString next() throws UniSelectListException
- returns the next record ID in the select list. If exhausted, it will return a
null
value and the isLastRecordRead
method will return
true
- Returns:
- the next record ID from the select list, or a
null
if exhausted
- Throws: UniSelectListException
- is thrown if an error condition occurs
- See Also:
- isLastRecordRead
readList
public UniDynArray readList() throws UniSelectListException
- reads the entire contents of the select list and returns it all at once
- Returns:
- UniDynArray representing the entire select list
- Throws: UniSelectListException
- is thrown if an error condition occurs
saveList
public void saveList(Object aListNameObj) throws UniSelectListException
- Saves the current select list in &SAVEDLISTS& file on the server with the name
supplied
- Parameters:
- aListNameObj - String denoting the name the select list should be saved to
- Throws: UniSelectListException
- is thrown if an error condition occurs
select
public void select(UniFile uniFile) throws UniSelectListException
- creates a new select list by selecting the
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.
- Parameters:
- uniFile -
UniFile
object to be selected
- Throws: UniSelectListException
- is thrown if an error condition occurs
select
public void select(UniDictionary uniFile) throws UniSelectListException
- creates a new select list by selecting the
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.
- Parameters:
- uniFile -
UniDictionary
object to be selected
- Throws: UniSelectListException
- is thrown if an error condition occurs
selectAlternateKey
public void selectAlternateKey(UniFile uniFile,
Object aIndexName) throws UniSelectListException
- generate a select list from the given
UniFile
from values in the
secondary key index that is specified.
- Parameters:
- uniFile -
UniFile
to be selected
- aIndexName - index name to select on
- Throws: UniSelectListException
- is thrown if an error condition occurs
selectAlternateKey
public void selectAlternateKey(UniDictionary unid,
Object aIndexName) throws UniSelectListException
- generate a select list from the given
UniDictionary
from values in the
secondary key index that is specified.
- Parameters:
- unid -
UniDictionary
to be selected
- aIndexName - index name to select on
- Throws: UniSelectListException
- is thrown if an error condition occurs
selectMatchingAK
public void selectMatchingAK(UniFile uniFile,
Object aIndexName,
Object aIndexValue) throws UniSelectListException
- 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.
- Parameters:
- uniFile -
UniFile
to be selected
- aIndexName - index name to select on
- aIndexVal - value within the index to select to
- Throws: UniSelectListException
- is thrown if an error condition occurs
selectMatchingAK
public void selectMatchingAK(UniDictionary unid,
Object aIndexName,
Object aIndexValue) throws UniSelectListException
- 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.
- Parameters:
- unid -
UniDictionary
to be selected
- aIndexName - index name to select on
- aIndexVal - value from the secondary key index. Records are selected when the
indexed field matches this value.
- Throws: UniSelectListException
- is thrown if an error condition occurs
All Packages Class Hierarchy This Package Previous Next Index