com.ibm.as400.access

Class UserObjectsOwnedListEntry

  • java.lang.Object
    • com.ibm.as400.access.UserObjectsOwnedListEntry


  • public class UserObjectsOwnedListEntry
    extends java.lang.Object
    This entry represents a single IBM i object that a user owns or is authorized to.

    Each entry corresponds to an entry from the QSYLOBJA API (format OBJA0300 or OBJA0310).
    Instances of this class are created by the UserObjectsOwnedList.getObjectList() method.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String AUTHORITY_VALUE_ALL
      Special authority value indicating that the user has all object (operational, management, existence, alter and reference) and data (read, add, update, delete, and execute) authorities to the object.
      static java.lang.String AUTHORITY_VALUE_CHANGE
      Special authority value indicating that the user has object operational and all data authorities to the object.
      static java.lang.String AUTHORITY_VALUE_EXCLUDE
      Special authority value indicating that the user has none of the object or data authorities to the object, or authorization list management authority.
      static java.lang.String AUTHORITY_VALUE_USE
      Special authority value indicating that the user has object operational and data read and execute authorities to the object.
      static java.lang.String AUTHORITY_VALUE_USER_DEF
      Special authority value indicating that the user has some combination of object and data authorities that do not relate to a special value.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getAspDeviceNameOfLibrary()
      Returns the auxiliary storage pool (ASP) device name where the object's library is stored.
      java.lang.String getAspDeviceNameOfObject()
      Returns the auxiliary storage pool (ASP) device name where the object is stored.
      java.lang.String getAttribute()
      Returns the object's attribute.
      boolean getAuthorityHolder()
      Returns whether the object is an authority holder.
      boolean getAuthorityListManagement()
      Returns whether the user has authorization list management authority to the object.
      java.lang.String getAuthorityValue()
      Returns the special value indicating the user's authority to the object.
      boolean getDataAdd()
      Returns whether the user has data add authority to the object.
      boolean getDataDelete()
      Returns whether the user has data delete authority to the object.
      boolean getDataExecute()
      Returns whether the user has data execute authority to the object.
      boolean getDataRead()
      Returns whether the user has data read authority to the object.
      boolean getDataUpdate()
      Returns whether the user has data update authority to the object.
      java.lang.String getLibraryName()
      Returns the name of the library containing the object.
      boolean getObjectAlter()
      Returns whether the user has object alter authority to the object.
      boolean getObjectExistence()
      Returns whether the user has object existence authority to the object.
      boolean getObjectManagement()
      Returns whether the user has object management authority to the object.
      java.lang.String getObjectName()
      Returns the name of the object the user is authorized to, owns, or is the primary group for.
      boolean getObjectOperational()
      Returns whether the user has object operational authority to the object.
      boolean getObjectReference()
      Returns whether the user has object reference authority to the object.
      java.lang.String getObjectType()
      Returns the type of object the user is authorized to, owns, or is the primary group of.
      java.lang.String getOwnership()
      Returns whether the user owns the object or is the primary group for the object.
      java.lang.String getPathName()
      Returns the path name of the object the user owns, is authorized to, or is the primary group for.
      java.lang.String getTextDescription()
      Returns the text description of the object.
      boolean isQSYSObjectEntry()
      Indicates if this UserObjectsOwnedListEntry is for a QSYS library based object vs an IFS directory based object.
      java.lang.String toString()
      Returns a string representation of this object.
      • Methods inherited from class java.lang.Object

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

      • AUTHORITY_VALUE_ALL

        public static final java.lang.String AUTHORITY_VALUE_ALL
        Special authority value indicating that the user has all object (operational, management, existence, alter and reference) and data (read, add, update, delete, and execute) authorities to the object.
        See Also:
        Constant Field Values
      • AUTHORITY_VALUE_CHANGE

        public static final java.lang.String AUTHORITY_VALUE_CHANGE
        Special authority value indicating that the user has object operational and all data authorities to the object.
        See Also:
        Constant Field Values
      • AUTHORITY_VALUE_USE

        public static final java.lang.String AUTHORITY_VALUE_USE
        Special authority value indicating that the user has object operational and data read and execute authorities to the object.
        See Also:
        Constant Field Values
      • AUTHORITY_VALUE_EXCLUDE

        public static final java.lang.String AUTHORITY_VALUE_EXCLUDE
        Special authority value indicating that the user has none of the object or data authorities to the object, or authorization list management authority.
        See Also:
        Constant Field Values
      • AUTHORITY_VALUE_USER_DEF

        public static final java.lang.String AUTHORITY_VALUE_USER_DEF
        Special authority value indicating that the user has some combination of object and data authorities that do not relate to a special value. The individual authorities for the user should be checked to determine what authority the user has to the object. This value is returned if the user owns an object and all authority for the user to the object has been removed. If this happens, all individual authority fields are set to false.
        See Also:
        Constant Field Values
    • Method Detail

      • getObjectName

        public java.lang.String getObjectName()
        Returns the name of the object the user is authorized to, owns, or is the primary group for.
        Returns:
        The object name. Will return null when isQSYSObjectEntry() is false.
      • getLibraryName

        public java.lang.String getLibraryName()
        Returns the name of the library containing the object.
        Returns:
        The object library. Will return null when isQSYSObjectEntry() is false.
      • getObjectType

        public java.lang.String getObjectType()
        Returns the type of object the user is authorized to, owns, or is the primary group of.
        Returns:
        The object type.
      • getAuthorityHolder

        public boolean getAuthorityHolder()
        Returns whether the object is an authority holder.
        Returns:
        true if the object is an authority holder; false otherwise
      • getOwnership

        public java.lang.String getOwnership()
        Returns whether the user owns the object or is the primary group for the object. If the user owns the object, this field is Y. If the user is the primary group for the object, this field is G. Otherwise, this field is N.
        Returns:
        ownership
      • getAuthorityValue

        public java.lang.String getAuthorityValue()
        Returns the special value indicating the user's authority to the object.
        Returns:
        authority value Possible values:
      • getAuthorityListManagement

        public boolean getAuthorityListManagement()
        Returns whether the user has authorization list management authority to the object. This field is only valid if the object type is *AUTL.
        Returns:
        true if user has authorization list management authority to the object; false otherwise
      • getObjectOperational

        public boolean getObjectOperational()
        Returns whether the user has object operational authority to the object.
        Returns:
        true if user has object operational authority to the object; false otherwise
      • getObjectManagement

        public boolean getObjectManagement()
        Returns whether the user has object management authority to the object.
        Returns:
        true if user has object management authority to the object; false otherwise
      • getObjectExistence

        public boolean getObjectExistence()
        Returns whether the user has object existence authority to the object.
        Returns:
        true if user has object existence authority to the object; false otherwise
      • getDataRead

        public boolean getDataRead()
        Returns whether the user has data read authority to the object.
        Returns:
        true if user has data read authority to the object; false otherwise
      • getDataAdd

        public boolean getDataAdd()
        Returns whether the user has data add authority to the object.
        Returns:
        true if user has data add authority to the object; false otherwise
      • getDataUpdate

        public boolean getDataUpdate()
        Returns whether the user has data update authority to the object.
        Returns:
        true if user has data update authority to the object; false otherwise
      • getDataDelete

        public boolean getDataDelete()
        Returns whether the user has data delete authority to the object.
        Returns:
        true if user has data delete authority to the object; false otherwise
      • getAttribute

        public java.lang.String getAttribute()
        Returns the object's attribute.
        Returns:
        attribute
      • getTextDescription

        public java.lang.String getTextDescription()
        Returns the text description of the object.
        Returns:
        text description
      • getDataExecute

        public boolean getDataExecute()
        Returns whether the user has data execute authority to the object.
        Returns:
        true if user has data execute authority to the object; false otherwise
      • getObjectAlter

        public boolean getObjectAlter()
        Returns whether the user has object alter authority to the object.
        Returns:
        true if user has object alter authority to the object; false otherwise
      • getObjectReference

        public boolean getObjectReference()
        Returns whether the user has object reference authority to the object.
        Returns:
        true if user has object reference authority to the object; false otherwise
      • getAspDeviceNameOfLibrary

        public java.lang.String getAspDeviceNameOfLibrary()
        Returns the auxiliary storage pool (ASP) device name where the object's library is stored. If the object's library is in the system ASP or one of the basic user ASPs, this field contains *SYSBAS.
        Returns:
        asp device name of library. Will return null when isQSYSObjectEntry() is false.
      • getAspDeviceNameOfObject

        public java.lang.String getAspDeviceNameOfObject()
        Returns the auxiliary storage pool (ASP) device name where the object is stored. If the object is in the system ASP or one of the basic user ASPs, this field contains *SYSBAS.
        Returns:
        asp device name of object
      • getPathName

        public java.lang.String getPathName()
        Returns the path name of the object the user owns, is authorized to, or is the primary group for.
        Returns:
        path name of the object. Will return null when isQSYSObjectEntry() is true.
      • isQSYSObjectEntry

        public boolean isQSYSObjectEntry()
        Indicates if this UserObjectsOwnedListEntry is for a QSYS library based object vs an IFS directory based object. A QSYS library based objects resides in a library in the QSYS file system. Other IBM i objects would reside in an IFS directory based file system.

        Some fields are not valid for QSYS vs IFS directory based objects. Refer to:

        Returns:
        true if this entry is for a QSYS based object; false otherwise
      • toString

        public java.lang.String toString()
        Returns a string representation of this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representing the object by path name or by library name, object name, and object type