com.ibm.as400.resource

Class ResourceList

  • java.lang.Object
    • com.ibm.as400.resource.ResourceList
  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    ArrayResourceList, BufferedResourceList, RIFSFileList

    Deprecated. 
    Use packages com.ibm.as400.access and com.ibm.as400.access.list instead.

    public abstract class ResourceList
    extends java.lang.Object
    implements java.io.Serializable
    The ResourceList class represents a list of system resources. This is an abstract class which provides generic access to the list's contents.

    A ResourceList is always either open or closed. The ResourceList must be open in order to access its contents. Call open() to explicitly open the ResourceList. Otherwise, most access methods will implicitly open the ResourceList if needed. When you are finished using the ResourceList, call close() to ensure that it cleans up system resources as needed.

    The contents of a ResourceList are 0 or more Resource objects. Use resourceAt() to access a specific Resource from the list. All indices are 0-based.

    In order to provide immediate access to the ResourceList's contents and manage memory efficiently, most ResourceLists are loaded incrementally. This means that neither all of the contents nor the exact length is available when the ResourceList is first opened. Some subclasses may load the contents on demand, others may load them asynchronously. At some point, depending on the subclass implementation, the ResourceList will be complete. This means that all of its contents are available and the exact length is known.

    Call waitForResource() to ensure that a particular Resource is made available. Call waitForComplete() to ensure that all of the contents and the exact length are made available.

    ResourceLists can be filtered using selection values. Every selection value is identified using a selection ID. Similarly, ResourceLists can be sorted using sort values. Every sort value is identified using a sort ID. Any given subclass of ResourceList will normally document the selection IDs and sort IDs that it supports.

    One example of a concrete subclass of ResourceList is RJobList, which represents a list of server jobs. RJobList supports many selection IDs and sort IDs, each of which can be used to filter or sort the list. Here is an example which prints the contents of an RJobList:

    // Create an RJobList object to represent a list of jobs.
    AS400 system = new AS400("MYSYSTEM", "MYUSERID", "MYPASSWORD");
    RJobList jobList = new RJobList(system);
    
    // Filter the list to include only interactive jobs. jobList.setSelectionValue(RJobList.JOB_TYPE, RJob.JOB_TYPE_INTERACTIVE);
    // Sort the list by user name, then job name. Object[] sortValue = new Object[] { RJob.USER_NAME, RJob.JOB_NAME }; jobList.setSortValue(sortValue);
    // Open the list and wait for it to complete. jobList.open(); jobList.waitForComplete();
    // Read and print the contents of the list. long length = jobList.getListLength(); for(long i = 0; i < length; ++i) { System.out.println(jobList.resourceAt(i)); }
    // Close the list. jobList.close();

    In addition to using concrete subclasses directly, you can write generic code to work with any ResourceList subclass. Such code may improve reusability and maintainability and will work with future ResourceList subclasses without modification. Here is an example of generic code which prints the some of the contents of a ResourceList:

    void printContents(ResourceList resourceList, long numberOfItems) throws ResourceException
    {
        // Open the list and wait for the requested number of items
        // to become available.
        resourceList.open();
        resourceList.waitForResource(numberOfItems);
        
    for(long i = 0; i < numberOfItems; ++i) { System.out.println(resourceList.resourceAt(i)); } }

    Every selection, sort, and resource attribute has an associated meta data object which describes various properties such as the default value and possible values. In addition, every ResourceList and meta data object has an associated Presentation object which provides translated information about the ResourceList, selection, sort, or attribute. You can use the Presentation information to present this information to end users. This example prints a ResourceList and its sort values using their Presentations:

    void printCurrentSort(ResourceList resourceList) throws ResourceException
    {
        // Get the presentation for the ResourceList and print its full name.
        Presentation resourceListPresentation = resourceList.getPresentation();
        System.out.println(resourceListPresentation.getFullName());
        
    // Get the current sort value. Object[] sortIDs = resourceList.getSortValue();
    // Print each sort ID. for(int i = 0; i < sortIDs.length; ++i) { ResourceMetaData sortMetaData = resourceList.getSortMetaData(sortIDs[i]); System.out.println("Sorting by " + sortMetaData.getName()); } }

    Use ResourceListDetailsPane or ResourceListPane to present a ResourceList in a graphical user interface. Use ResourceListRowData to present a ResourceList in a servlet. Subclass notes:

    If you are extending this class to override the mechanism for getting selection values, consider whether you need to support bidirectional character conversion. If you do not plan to support bidirectional character conversion, then you only need to override getSelectionValue(Object). If you do plan to support bidirectional character conversion, then you need to override isBidiEnabled() to return true and getSelectionValue(Object, int).

    In either case, the overriding method should call the superclass's method of the same name and perform extra processing only when null is returned:

        public Object getSelectionValue(Object selectionID)
        throws ResourceException
        {
            // Call the superclass first.
            Object value = super.getSelectionValue(selectionID);
            if (value == null) {
    
    // Establish the connection if needed. if (! isConnectionEstablished()) establishConnection();
    // Go get the selection value. value = ...; } return value; }

    Extending this class to override the mechanism for setting selection values works in a similar fashion. If you do not plan to support bidirectional character conversion, then you only need to override setSelectionValue(Object, Object). If you do plan to support bidirectional character conversion, then you need to override isBidiEnabled() to return true and setSelectionValue(Object, Object, int).

    Again, the overriding method should call the superclass's method of the same name and then perform extra processing:

        public void setSelectionValue(Object selectionID, Object value)
        throws ResourceException
        {
            // Call the superclass first.
            super.setSelectionValue(selectionID, values);
    
    // Establish the connection if needed. if (! isConnectionEstablished()) establishConnection();
    // Set the selection value. // ... }
    See Also:
    Resource, Serialized Form
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addActiveStatusListener(ActiveStatusListener listener)
      Deprecated. 
      Adds an ActiveStatusListener.
      void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
      Deprecated. 
      Adds a PropertyChangeListener.
      void addResourceListListener(ResourceListListener listener)
      Deprecated. 
      Adds a ResourceListListener.
      void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
      Deprecated. 
      Adds a VetoableChangeListener.
      protected boolean arePropertiesFrozen()
      Deprecated. 
      Indicates if properties are frozen.
      void close()
      Deprecated. 
      Closes the list.
      protected void establishConnection()
      Deprecated. 
      Establishes the connection to the system, if any.
      protected void fireBusy()
      Deprecated. 
      Fires a busy active status event.
      protected void fireIdle()
      Deprecated. 
      Fires a idle active status event.
      protected void fireLengthChanged(long length)
      Deprecated. 
      Fires a lengthChanged() resource list event.
      protected void fireListClosed()
      Deprecated. 
      Fires a listClosed() ResourceListEvent.
      protected void fireListCompleted()
      Deprecated. 
      Fires a listCompleted() ResourceListEvent.
      protected void fireListInError()
      Deprecated. 
      Fires a listInError() ResourceListEvent.
      protected void fireListOpened()
      Deprecated. 
      Fires a listOpened() ResourceListEvent.
      protected void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
      Deprecated. 
      Fires a property change event.
      protected void fireResourceAdded(Resource resource, long index)
      Deprecated. 
      Fires a resourceAdded() ResourceListEvent.
      protected void fireVetoableChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
      Deprecated. 
      Fires a vetoable change event.
      protected void freezeProperties()
      Deprecated. 
      Freezes any property changes.
      ResourceMetaData[] getAttributeMetaData()
      Deprecated. 
      Returns the attribute meta data for the resources in the contents of the list.
      ResourceMetaData getAttributeMetaData(java.lang.Object attributeID)
      Deprecated. 
      Returns the attribute meta data for a specific attribute of a resource in the contents of the list.
      long getListLength()
      Deprecated. 
      Returns the total number of resources in the list.
      Presentation getPresentation()
      Deprecated. 
      Returns the presentation information.
      ResourceMetaData[] getSelectionMetaData()
      Deprecated. 
      Returns the selection meta data.
      ResourceMetaData getSelectionMetaData(java.lang.Object selectionID)
      Deprecated. 
      Returns the selection meta data for a specific selection.
      java.lang.Object getSelectionValue(java.lang.Object selectionID)
      Deprecated. 
      Returns the current value of a selection.
      java.lang.Object getSelectionValue(java.lang.Object selectionID, int bidiStringType)
      Deprecated. 
      Returns the current value of a selection.
      ResourceMetaData[] getSortMetaData()
      Deprecated. 
      Returns the sort meta data.
      ResourceMetaData getSortMetaData(java.lang.Object sortID)
      Deprecated. 
      Returns the sort meta data for a specific sort.
      boolean getSortOrder(java.lang.Object sortID)
      Deprecated. 
      Returns the current order for a particular sort.
      java.lang.Object[] getSortValue()
      Deprecated. 
      Returns the current value of the sort.
      AS400 getSystem()
      Deprecated. 
      Returns the system.
      protected boolean isBidiEnabled()
      Deprecated. 
      Indicates if this resource is enabled for bidirectional character conversion.
      boolean isComplete()
      Deprecated. 
      Indicates if the list is completely loaded.
      protected boolean isConnectionEstablished()
      Deprecated. 
      Indicates if a connection to the system is established.
      boolean isInError()
      Deprecated. 
      Indicates if the list has not been completely loaded due to an error.
      boolean isOpen()
      Deprecated. 
      Indicates if the list is open.
      boolean isResourceAvailable(long index)
      Deprecated. 
      Indicates if the resource is available.
      void open()
      Deprecated. 
      Opens the list.
      void refreshContents()
      Deprecated. 
      Refreshes the contents of the list.
      void refreshStatus()
      Deprecated. 
      Refreshes the status of the list.
      void removeActiveStatusListener(ActiveStatusListener listener)
      Deprecated. 
      Removes an ActiveStatusListener.
      void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
      Deprecated. 
      Removes a PropertyChangeListener.
      void removeResourceListListener(ResourceListListener listener)
      Deprecated. 
      Removes a ResourceListListener.
      void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
      Deprecated. 
      Removes a VetoableChangeListener.
      Resource resourceAt(long index)
      Deprecated. 
      Returns the resource specified by the index.
      java.util.Enumeration resources()
      Deprecated. 
      Returns an Enumeration of the Resource objects.
      protected void setAttributeMetaData(ResourceMetaData[] attributeMetaData)
      Deprecated. 
      Sets the attribute meta data.
      protected void setPresentation(Presentation presentation)
      Deprecated. 
      Sets the presentation.
      void setSelectionValue(java.lang.Object selectionID, java.lang.Object value)
      Deprecated. 
      Sets the current value of a selection.
      void setSelectionValue(java.lang.Object selectionID, java.lang.Object value, int bidiStringType)
      Deprecated. 
      Sets the current value of a selection.
      void setSortOrder(java.lang.Object sortID, boolean sortOrder)
      Deprecated. 
      Sets the order for a sort.
      void setSortValue(java.lang.Object[] sortValue)
      Deprecated. 
      Sets the current value of the sort.
      void setSystem(AS400 system)
      Deprecated. 
      Sets the system.
      java.lang.String toString()
      Deprecated. 
      Returns the presentation full name, if any.
      void waitForComplete()
      Deprecated. 
      Waits until the list is completely loaded.
      void waitForResource(long index)
      Deprecated. 
      Waits until the resource is available or the list is complete.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ResourceList

        public ResourceList()
        Deprecated. 
        Constructs a ResourceList object.
      • ResourceList

        public ResourceList(Presentation presentation,
                    ResourceMetaData[] attributeMetaData,
                    ResourceMetaData[] selectionMetaData,
                    ResourceMetaData[] sortMetaData)
        Deprecated. 
        Constructs a ResourceList object.
        Parameters:
        presentation - The presentation.
        attributeMetaData - The attribute meta data, or null if not applicable.
        selectionMetaData - The selection meta data, or null if not applicable.
        sortMetaData - The sort meta data, or null if not applicable.
    • Method Detail

      • addActiveStatusListener

        public void addActiveStatusListener(ActiveStatusListener listener)
        Deprecated. 
        Adds an ActiveStatusListener.
        Parameters:
        listener - The listener.
      • addPropertyChangeListener

        public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
        Deprecated. 
        Adds a PropertyChangeListener. The specified PropertyChangeListener's propertyChange() method will be called each time the value of any bound property is changed.
        Parameters:
        listener - The listener.
      • addResourceListListener

        public void addResourceListListener(ResourceListListener listener)
        Deprecated. 
        Adds a ResourceListListener.
        Parameters:
        listener - The listener.
      • addVetoableChangeListener

        public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
        Deprecated. 
        Adds a VetoableChangeListener. The specified VetoableChangeListener's vetoableChange() method will be called each time the value of any constrained property is changed.
        Parameters:
        listener - The listener.
      • arePropertiesFrozen

        protected boolean arePropertiesFrozen()
        Deprecated. 
        Indicates if properties are frozen. If this is true, property changes should not be made. Properties are not the same thing as attributes. Properties are basic pieces of information which must be set to make the object usable, such as the system or other properties that identify the resource on the system.
        Returns:
        true if properties are frozen, false otherwise.
      • close

        public void close()
                   throws ResourceException
        Deprecated. 
        Closes the list. No further resources can be loaded. The list must be closed in order to clean up resources appropriately. This method has no effect if the list is already closed. This method fires a listClosed() ResourceListEvent.
        Throws:
        ResourceException - If an error occurs.
      • establishConnection

        protected void establishConnection()
                                    throws ResourceException
        Deprecated. 
        Establishes the connection to the system, if any. Subclasses can override this method and put all connection initialization code here. It is assumed that all properties have been set when this method is called. Any subclass that overrides this method should include a call to super.establishConnection().
        Throws:
        ResourceException - If an error occurs.
      • fireBusy

        protected void fireBusy()
        Deprecated. 
        Fires a busy active status event. This indicates that a potentially long-running operation has started.
      • fireIdle

        protected void fireIdle()
        Deprecated. 
        Fires a idle active status event. This indicates that a potentially long-running operation has ended.
      • fireLengthChanged

        protected void fireLengthChanged(long length)
        Deprecated. 
        Fires a lengthChanged() resource list event.
        Parameters:
        length - The length.
      • fireListClosed

        protected void fireListClosed()
        Deprecated. 
        Fires a listClosed() ResourceListEvent.
      • fireListCompleted

        protected void fireListCompleted()
        Deprecated. 
        Fires a listCompleted() ResourceListEvent.
      • fireListInError

        protected void fireListInError()
        Deprecated. 
        Fires a listInError() ResourceListEvent.
      • fireListOpened

        protected void fireListOpened()
        Deprecated. 
        Fires a listOpened() ResourceListEvent.
      • firePropertyChange

        protected void firePropertyChange(java.lang.String propertyName,
                              java.lang.Object oldValue,
                              java.lang.Object newValue)
        Deprecated. 
        Fires a property change event.
        Parameters:
        propertyName - The property name.
        oldValue - The old value.
        newValue - The new value.
      • fireResourceAdded

        protected void fireResourceAdded(Resource resource,
                             long index)
        Deprecated. 
        Fires a resourceAdded() ResourceListEvent.
        Parameters:
        resource - The resource.
        index - The index.
      • fireVetoableChange

        protected void fireVetoableChange(java.lang.String propertyName,
                              java.lang.Object oldValue,
                              java.lang.Object newValue)
                                   throws java.beans.PropertyVetoException
        Deprecated. 
        Fires a vetoable change event.
        Parameters:
        propertyName - The property name.
        oldValue - The old value.
        newValue - The new value.
        Throws:
        java.beans.PropertyVetoException - If the property change is vetoed.
      • freezeProperties

        protected void freezeProperties()
                                 throws ResourceException
        Deprecated. 
        Freezes any property changes. After this is called, property changes should not be made. Properties are not the same thing as attributes. Properties are basic pieces of information which must be set to make the object usable, such as the system or other properties that identify the resource on the system.

        Subclasses can override this method and put initialization code here that is dependent on properties being set. Any subclass that overrides this method should include a call to super.freezeProperties().

        Throws:
        ResourceException - If an error occurs.
      • getAttributeMetaData

        public ResourceMetaData getAttributeMetaData(java.lang.Object attributeID)
        Deprecated. 
        Returns the attribute meta data for a specific attribute of a resource in the contents of the list.
        Parameters:
        attributeID - Identifies the attribute.
        Returns:
        The attribute meta data.
      • getAttributeMetaData

        public ResourceMetaData[] getAttributeMetaData()
        Deprecated. 
        Returns the attribute meta data for the resources in the contents of the list. If there is more than one type of resource in the list, this returns the union of all resources' attributes. The array will contain an element for every supported attribute.
        Returns:
        The attribute meta data. The array has zero elements if there are no attributes.
      • getListLength

        public long getListLength()
                           throws ResourceException
        Deprecated. 
        Returns the total number of resources in the list. This length reflects the most accurate estimate known. In many cases the length is not known until the list is completely loaded.

        This will implicitly open the list if needed.

        Returns:
        The total number of resources in the list.
        Throws:
        ResourceException - If an error occurs.
      • getPresentation

        public Presentation getPresentation()
        Deprecated. 
        Returns the presentation information.
        Returns:
        The presentation information.
      • getSelectionMetaData

        public ResourceMetaData getSelectionMetaData(java.lang.Object selectionID)
        Deprecated. 
        Returns the selection meta data for a specific selection.
        Parameters:
        selectionID - Identifies the selection.
        Returns:
        The selection meta data.
      • getSelectionMetaData

        public ResourceMetaData[] getSelectionMetaData()
        Deprecated. 
        Returns the selection meta data. The array will contain an element for every supported selection.
        Returns:
        The selection meta data. The array has zero elements if there are no selections.
      • getSelectionValue

        public java.lang.Object getSelectionValue(java.lang.Object selectionID)
                                           throws ResourceException
        Deprecated. 
        Returns the current value of a selection.
        Parameters:
        selectionID - Identifies the selection.
        Returns:
        The selection value, or null if the selection value has not been set.
        Throws:
        ResourceException - If an error occurs.
        See Also:
        Subclass notes
      • getSelectionValue

        public java.lang.Object getSelectionValue(java.lang.Object selectionID,
                                         int bidiStringType)
                                           throws ResourceException
        Deprecated. 
        Returns the current value of a selection.
        Parameters:
        selectionID - Identifies the selection.
        bidiStringType - The bidi string type as defined by the CDRA (Character Data Representation Architecture). See BidiStringType for more information and valid values.
        Returns:
        The selection value, or null if the selection value has not been set.
        Throws:
        ResourceException - If an error occurs.
        See Also:
        Subclass notes
      • getSortMetaData

        public ResourceMetaData getSortMetaData(java.lang.Object sortID)
        Deprecated. 
        Returns the sort meta data for a specific sort.
        Parameters:
        sortID - Identifies the sort.
        Returns:
        The sort meta data.
      • getSortMetaData

        public ResourceMetaData[] getSortMetaData()
        Deprecated. 
        Returns the sort meta data. The array will contain an element for every supported sort.
        Returns:
        The sort meta data. The array has zero elements if there are no sorts.
      • getSortOrder

        public boolean getSortOrder(java.lang.Object sortID)
                             throws ResourceException
        Deprecated. 
        Returns the current order for a particular sort.
        Parameters:
        sortID - The sort ID.
        Returns:
        true for ascending, false for descending.
        Throws:
        ResourceException - If an error occurs.
      • getSortValue

        public java.lang.Object[] getSortValue()
                                        throws ResourceException
        Deprecated. 
        Returns the current value of the sort.
        Returns:
        The array of sort IDs.
        Throws:
        ResourceException - If an error occurs.
      • getSystem

        public AS400 getSystem()
        Deprecated. 
        Returns the system.
        Returns:
        The system.
      • isBidiEnabled

        protected boolean isBidiEnabled()
        Deprecated. 
        Indicates if this resource is enabled for bidirectional character conversion. The default implementation always returns false. Subclasses that are enabled for bidirectional character conversion should override this method to return true.
        Returns:
        Always false.
        See Also:
        Subclass notes
      • isComplete

        public boolean isComplete()
        Deprecated. 
        Indicates if the list is completely loaded. A list is not considered to be complete until all of its resources are loaded. Implementations will differ as to when the list is completely loaded. For example, some implementations may load all resources in a background thread, others may load resources on demand.
        Returns:
        true if the list is completely loaded, false if it is not completely loaded, or if the list is not open.
      • isConnectionEstablished

        protected boolean isConnectionEstablished()
        Deprecated. 
        Indicates if a connection to the system is established. This means that the resource is in a state where certain properties can no longer be changed.
        Returns:
        true if a connection is established, false otherwise.
      • isInError

        public boolean isInError()
        Deprecated. 
        Indicates if the list has not been completely loaded due to an error. If an unrecoverable error occurs while loading the resources, then the list is in error and no further resources are loaded.
        Returns:
        true if the list has not been completely loaded due to an error, false if the list is not in error or if the list is not open.
      • isOpen

        public boolean isOpen()
        Deprecated. 
        Indicates if the list is open.
        Returns:
        true if the list is open, false if the list is not open.
      • isResourceAvailable

        public boolean isResourceAvailable(long index)
                                    throws ResourceException
        Deprecated. 
        Indicates if the resource is available. This means that the resource has been loaded.
        Parameters:
        index - The index.
        Returns:
        true if the resource is available, false if the resource is not available or the list is not open.
        Throws:
        ResourceException - If an error occurs.
      • open

        public void open()
                  throws ResourceException
        Deprecated. 
        Opens the list. The list must be open in order to perform most operations. This method has no effect if the list is already opened.
        Throws:
        ResourceException - If an error occurs.
      • refreshContents

        public void refreshContents()
                             throws ResourceException
        Deprecated. 
        Refreshes the contents of the list.

        This will implicitly open the list if needed.

        Throws:
        ResourceException - If an error occurs.
      • refreshStatus

        public void refreshStatus()
                           throws ResourceException
        Deprecated. 
        Refreshes the status of the list. The status includes the length and whether the list is completed or in error. If the list is complete, this method has no effect.

        This method does not refresh the contents of the list. Use refreshContents() to refresh the contents of the list.

        This will implicitly open the list if needed.

        Throws:
        ResourceException - If an error occurs.
      • removeActiveStatusListener

        public void removeActiveStatusListener(ActiveStatusListener listener)
        Deprecated. 
        Removes an ActiveStatusListener.
        Parameters:
        listener - The listener.
      • removePropertyChangeListener

        public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
        Deprecated. 
        Removes a PropertyChangeListener.
        Parameters:
        listener - The listener.
      • removeResourceListListener

        public void removeResourceListListener(ResourceListListener listener)
        Deprecated. 
        Removes a ResourceListListener.
        Parameters:
        listener - The listener.
      • removeVetoableChangeListener

        public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
        Deprecated. 
        Removes a VetoableChangeListener.
        Parameters:
        listener - The listener.
      • resourceAt

        public Resource resourceAt(long index)
                            throws ResourceException
        Deprecated. 
        Returns the resource specified by the index.

        This will implicitly open the list if needed.

        Parameters:
        index - The index.
        Returns:
        The resource specified by the index, or null if the resource is not yet available.
        Throws:
        ResourceException - If an error occurs.
      • resources

        public java.util.Enumeration resources()
                                        throws ResourceException
        Deprecated. 
        Returns an Enumeration of the Resource objects. This may be a more convenient mechanism to iterate through the Resource objects, and is provided as an alternative to using the other methods in this class.

        If the contents of the ResourceList are changed while the Enumeration is in use, the enumerated Resource objects may not be consistent.

        Returns:
        The Enumeration of Resource objects.
        Throws:
        ResourceException - If an error occurs.
      • setAttributeMetaData

        protected void setAttributeMetaData(ResourceMetaData[] attributeMetaData)
        Deprecated. 
        Sets the attribute meta data.
        Parameters:
        attributeMetaData - The attribute meta data.
      • setSelectionValue

        public void setSelectionValue(java.lang.Object selectionID,
                             java.lang.Object value)
                               throws ResourceException
        Deprecated. 
        Sets the current value of a selection. The changed selection value will take effect the next time the list is opened or refreshed.
        Parameters:
        selectionID - Identifies the selection.
        value - The selection value, or null to remove the selection.
        Throws:
        ResourceException - If an error occurs.
        See Also:
        Subclass notes
      • setSelectionValue

        public void setSelectionValue(java.lang.Object selectionID,
                             java.lang.Object value,
                             int bidiStringType)
                               throws ResourceException
        Deprecated. 
        Sets the current value of a selection. The changed selection value will take effect the next time the list is opened or refreshed.
        Parameters:
        selectionID - Identifies the selection.
        value - The selection value, or null to remove the selection.
        bidiStringType - The bidi string type as defined by the CDRA (Character Data Representation Architecture). See BidiStringType for more information and valid values.
        Throws:
        ResourceException - If an error occurs.
        See Also:
        Subclass notes
      • setPresentation

        protected void setPresentation(Presentation presentation)
        Deprecated. 
        Sets the presentation.
        Parameters:
        presentation - The presentation.
      • setSortOrder

        public void setSortOrder(java.lang.Object sortID,
                        boolean sortOrder)
                          throws ResourceException
        Deprecated. 
        Sets the order for a sort. The changed sort order will take effect the next time the list is opened or refreshed.
        Parameters:
        sortID - The sort ID.
        sortOrder - true for ascending, false for descending.
        Throws:
        ResourceException - If an error occurs.
      • setSortValue

        public void setSortValue(java.lang.Object[] sortValue)
                          throws ResourceException
        Deprecated. 
        Sets the current value of the sort. The changed sort value will take effect the next time the list is opened or refreshed.
        Parameters:
        sortValue - An array of sort IDs.
        Throws:
        ResourceException - If an error occurs.
      • setSystem

        public void setSystem(AS400 system)
                       throws java.beans.PropertyVetoException
        Deprecated. 
        Sets the system. This cannot be changed if the object has established a connection to the system.
        Parameters:
        system - The system.
        Throws:
        java.beans.PropertyVetoException - If the change is vetoed.
      • toString

        public java.lang.String toString()
        Deprecated. 
        Returns the presentation full name, if any.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The presentation full name, if any.
      • waitForComplete

        public void waitForComplete()
                             throws ResourceException
        Deprecated. 
        Waits until the list is completely loaded.

        This will implicitly open the list if needed.

        Throws:
        ResourceException - If an error occurs.
      • waitForResource

        public void waitForResource(long index)
                             throws ResourceException
        Deprecated. 
        Waits until the resource is available or the list is complete.

        This will implicitly open the list if needed.

        Parameters:
        index - The index.
        Throws:
        ResourceException - If an error occurs.