|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.as400.access.MemberList
public class MemberList extends Object
Represents a list of database file members.
Implementation note: This class internally calls the "List Database File Members" API (QUSLMBR). Information from formats MBRL0100 and MBRL0200 is retrieved.
This class is mostly based on a prototype contributed by Mihael Schmidt.
MemberDescription
,
AS400File
Constructor and Description |
---|
MemberList(AS400File file)
Constructs a MemberList object. |
MemberList(AS400 system,
QSYSObjectPathName path)
Constructs a MemberList object. |
MemberList(AS400 system,
String libraryName,
String objectName)
Constructs a MemberList object. |
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(int attributeKey)
Adds an attribute to the attribute list which specifies which attributes of the member are to be retrieved. |
void |
clear()
Removes all member descriptions from this object. |
void |
clearAttributeList()
Clears the attribute list which specifies which attributes should be retrieved. |
MemberDescription[] |
getMemberDescriptions()
Returns an array of retrieved member descriptions. |
void |
load()
Loads all members from the specified file(s). |
void |
refresh()
Reloads all member descriptions that have been specified via addAttribute() . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MemberList(AS400File file)
file
- A database file.public MemberList(AS400 system, QSYSObjectPathName path)
system
- AS400 system object.path
- IFS path to the database file or member.public MemberList(AS400 system, String libraryName, String objectName)
system
- AS400 system objectlibraryName
- Library where the physical file is located.objectName
- The name of the physical file.Method Detail |
---|
public void clear()
public void clearAttributeList()
public void addAttribute(int attributeKey)
MemberDescription
.
attributeKey
- The attribute to be added.public void refresh() throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
addAttribute()
.
ObjectDoesNotExistException
- If a system object necessary for the call does not exist on the system.InterruptedException
- If this thread is interrupted.IOException
- If an error occurs while communicating with the system.ErrorCompletingRequestException
- If an error occurs before the request is completed.AS400SecurityException
- If a security or authority error occurs.public void load() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, IOException, InterruptedException, ObjectDoesNotExistException
ObjectDoesNotExistException
- If an object necessary for the call does not exist on the system.InterruptedException
- If this thread is interrupted.IOException
- If an error occurs while communicating with the system.ErrorCompletingRequestException
- If an error occurs before the request is completed.AS400SecurityException
- If a security or authority error occurs.AS400Exception
- If the program on the server sends an escape message.public MemberDescription[] getMemberDescriptions()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |