com.ibm.as400.access

Class ObjectList

  • All Implemented Interfaces:
    Serializable


    public class ObjectList
    extends Object
    implements Serializable
    Represents a list of system objects in a specific library, multiple libraries, or system-wide.

    Implementation note: This class internally uses the Open List APIs (e.g. QGYOLOBJ).

    See Also:
    ObjectDescription, Serialized Form
    • Field Detail

      • ASP_NAME_ALL

        public static final String ASP_NAME_ALL
        Constant indicating that the auxiliary storage pools that are currently part of the the thread's library name space will be searched to locate the library. This includes the system ASP (ASP 1), all defined basic user ASPs (ASPs 2-32), and, if the thread has an ASP group, the primary and secondary ASPs in the thread's ASP group.
        See Also:
        Constant Field Values
      • ASP_NAME_SYSBAS

        public static final String ASP_NAME_SYSBAS
        Constant indicating that the system ASP (ASP 1) and all defined basic user ASPs (ASPs 2-32) will be searched to locate the library. No primary or secondary ASPs will be searched, even if the thread has an ASP group.
        See Also:
        Constant Field Values
      • ASP_NAME_CURASPGRP

        public static final String ASP_NAME_CURASPGRP
        Constant indicating if the thread has an ASP group, the primary and secondary ASPs in the ASP group will be searched to locate the library. The system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32) will not be searched.
        See Also:
        Constant Field Values
      • ASP_NAME_ALLAVL

        public static final String ASP_NAME_ALLAVL
        Constant indicating that all available ASPs will be searched. This includes the system ASP (ASP 1), all defined basic user ASPs (ASPs 2-32), and all available primary and secondary ASPs (ASPs 33-255 with a status of 'Available'). The ASP groups are searched in alphabetical order by the primary ASP. The system ASP and all defined basic user ASPs are searched after the ASP groups. ASPs and libraries to which the user is not authorized are bypassed and no authority error messages are sent. The search ends when the first object is found of the specified object name, library name, and object type. If the user is not authorized to the object, an authority error message is sent.
        See Also:
        Constant Field Values
      • ASP_SEARCH_TYPE_ASP

        public static final String ASP_SEARCH_TYPE_ASP
        Constant indicating that only the single ASP named in the auxiliary storage pool device name field will be searched.
        See Also:
        Constant Field Values
      • ASP_SEARCH_TYPE_ASPGRP

        public static final String ASP_SEARCH_TYPE_ASPGRP
        Constant indicating that all ASPs in the auxiliary storage pool group named in the auxiliary storage pool device name field will be searched. The device name must be the name of the primary auxiliary storage pool in the group.
        See Also:
        Constant Field Values
      • AUTH_CHANGE

        public static final String AUTH_CHANGE
        Selection value representing an authority of *CHANGE.
        See Also:
        Constant Field Values
      • AUTH_DATA_ADD

        public static final String AUTH_DATA_ADD
        Selection value representing a data authority of *ADD.
        See Also:
        Constant Field Values
      • AUTH_DATA_DELETE

        public static final String AUTH_DATA_DELETE
        Selection value representing a data authority of *DLT.
        See Also:
        Constant Field Values
      • AUTH_DATA_EXECUTE

        public static final String AUTH_DATA_EXECUTE
        Selection value representing a data authority of *EXECUTE.
        See Also:
        Constant Field Values
      • AUTH_DATA_READ

        public static final String AUTH_DATA_READ
        Selection value representing a data authority of *READ.
        See Also:
        Constant Field Values
      • AUTH_DATA_UPDATE

        public static final String AUTH_DATA_UPDATE
        Selection value representing a data authority of *UPD.
        See Also:
        Constant Field Values
      • AUTH_LIST_MANAGEMENT

        public static final String AUTH_LIST_MANAGEMENT
        Selection value representing an authority of *AUTLMGT.
        See Also:
        Constant Field Values
      • AUTH_OBJECT_ALTER

        public static final String AUTH_OBJECT_ALTER
        Selection value representing an object authority of *OBJALTER.
        See Also:
        Constant Field Values
      • AUTH_OBJECT_EXISTENCE

        public static final String AUTH_OBJECT_EXISTENCE
        Selection value representing an object authority of *OBJEXIST.
        See Also:
        Constant Field Values
      • AUTH_OBJECT_MANAGEMENT

        public static final String AUTH_OBJECT_MANAGEMENT
        Selection value representing an object authority of *OBJMGT.
        See Also:
        Constant Field Values
      • AUTH_OBJECT_OPERATIONAL

        public static final String AUTH_OBJECT_OPERATIONAL
        Selection value representing an object authority of *OBJOPR.
        See Also:
        Constant Field Values
      • AUTH_OBJECT_REFERENCE

        public static final String AUTH_OBJECT_REFERENCE
        Selection value representing an object authority of *OBJREF.
        See Also:
        Constant Field Values
      • USER_LIBRARY_LIST

        public static final String USER_LIBRARY_LIST
        Selection value representing *USRLIBL.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ObjectList

        public ObjectList(AS400 system)
        Constructs an ObjectList object. The selection values default to:
        • Object library - ALL
        • Object name - ALL
        • Object type - ALL
        Parameters:
        system - The system.
      • ObjectList

        public ObjectList(AS400 system,
                  String objectLibrary,
                  String objectName,
                  String objectType)
        Constructs an ObjectList with the specified selection criteria.
        Parameters:
        system - The system.
        objectLibrary - The library or set of libraries that are searched for objects. Valid values are a specific name, a generic name, or one of the following special values:
        objectName - The object name. Valid values are a specific name, a generic name, or one of the following special values:
        • ALL - All object names are searched.
        • ALL_USER - All objects that are libraries in QSYS or the library list are searched. The object library must either be LIBRARY_LIST or QSYS. The object type must be *LIB. A list of user libraries is returned.
        • IBM - All objects that are libraries in QSYS or the library list are searched. The object library must either be LIBRARY_LIST or QSYS. The object type must be *LIB. A list of saved (SAVLIB) and restored (RSTLIB) libraries is returned.
        objectType - The type of objects that are searched. Valid values include a specific object type (*LIB, *FILE, *OUTQ, etc) or ALL.
      • ObjectList

        public ObjectList(AS400 system,
                  String objectLibrary,
                  String objectName,
                  String objectType,
                  String aspDeviceName)
        Constructs an ObjectList with the specified selection criteria.
        Parameters:
        system - The system.
        objectLibrary - The library or set of libraries that are searched for objects. Valid values are a specific name, a generic name, or one of the following special values:
        objectName - The object name. Valid values are a specific name, a generic name, or one of the following special values:
        • ALL - All object names are searched.
        • ALL_USER - All objects that are libraries in QSYS or the library list are searched. The object library must either be LIBRARY_LIST or QSYS. The object type must be *LIB. A list of user libraries is returned.
        • IBM - All objects that are libraries in QSYS or the library list are searched. The object library must either be LIBRARY_LIST or QSYS. The object type must be *LIB. A list of saved (SAVLIB) and restored (RSTLIB) libraries is returned.
        objectType - The type of objects that are searched. Valid values include a specific object type (*LIB, *FILE, *OUTQ, etc) or ALL.
        aspDeviceName - The name of an auxiliary storage pool (ASP) device in which storage is allocated for the library that contains the object or one of the following special values: