com.ibm.as400.access

Class SaveFileEntry

  • java.lang.Object
    • com.ibm.as400.access.SaveFileEntry
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable


    public class SaveFileEntry
    extends java.lang.Object
    implements java.io.Serializable, java.lang.Comparable
    Represents an entry in a save file. Instances of this class are created by SaveFile.listEntries()
    See Also:
    Serialized Form
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int compareTo(java.lang.Object obj)
      Compares this object with the specified object for order.
      boolean equals(java.lang.Object obj)
      Determines whether this object is equal to another object.
      int getASP()
      Returns the auxiliary storage pool (ASP) of the object when it was saved.
      java.lang.String getASPDevice()
      Returns the auxiliary storage pool device name.
      java.lang.String getDescription()
      Returns the text description of the object.
      java.lang.String getDLOName()
      Returns the document library object (DLO) name.
      java.lang.String getExtendedObjectAttribute()
      Returns extended information about the object type.
      java.lang.String getFolder()
      Returns the name of the folder that was saved.
      java.lang.String getLibrary()
      Returns the name of the library from which the object is saved.
      java.lang.String getName()
      Returns the name of the object saved.
      java.lang.String getOwner()
      Returns the name of the object owner's user profile.
      java.util.Date getSaveDate()
      Returns the time at which the object was saved.
      long getSize()
      Returns the total size of the object in bytes.
      java.lang.String getType()
      Returns the type of object.
      int hashCode()
      Returns a hash code value for the object.
      boolean isDataSaved()
      Indicates whether the data for this object was saved with the object.
      java.lang.String toString()
      Returns the String representation of this object.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • >
    • Method Detail

      • compareTo

        public int compareTo(java.lang.Object obj)
        Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
        Specified by:
        compareTo in interface java.lang.Comparable
        Throws:
        java.lang.ClassCastException - if obj is not an instance of SaveFileEntry.
      • equals

        public boolean equals(java.lang.Object obj)
        Determines whether this object is equal to another object.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true if the two instances are equal
      • getName

        public java.lang.String getName()
        Returns the name of the object saved. If the object is a DLO object, this field will contain the system name of the object.
        Returns:
        The object name.
      • getLibrary

        public java.lang.String getLibrary()
        Returns the name of the library from which the object is saved.
        Returns:
        the object library.
      • getType

        public java.lang.String getType()
        Returns the type of object. For examples: *LIB, *PGM, or *FILE.
        Returns:
        The object type.
      • getExtendedObjectAttribute

        public java.lang.String getExtendedObjectAttribute()
        Returns extended information about the object type. If there is no extended information, returns an empty String.
        Returns:
        The object's extended information.
      • getSaveDate

        public java.util.Date getSaveDate()
        Returns the time at which the object was saved.
        Returns:
        The object save date.
      • getSize

        public long getSize()
        Returns the total size of the object in bytes.
        Returns:
        The object size in bytes.
      • getASP

        public int getASP()
        Returns the auxiliary storage pool (ASP) of the object when it was saved.
        Returns:
        The auxiliary storage pool.
      • isDataSaved

        public boolean isDataSaved()
        Indicates whether the data for this object was saved with the object.
        Returns:
        true if the data was saved; false otherwise.
      • getOwner

        public java.lang.String getOwner()
        Returns the name of the object owner's user profile.
        Returns:
        The object owner.
      • getDLOName

        public java.lang.String getDLOName()
        Returns the document library object (DLO) name. This is the name of the document, folder, or mail object that was saved. If the save file does not contain DLO information, this field will be an empty String.
        Returns:
        The DLO name.
      • getFolder

        public java.lang.String getFolder()
        Returns the name of the folder that was saved. If the object is not a *FLR or *DOC object, this field will be empty. For *DOC and *FLR objects, this field will be set to the qualified name of the folder or to *NONE.
        Returns:
        The folder.
      • getDescription

        public java.lang.String getDescription()
        Returns the text description of the object.
        Returns:
        The description.
      • getASPDevice

        public java.lang.String getASPDevice()
        Returns the auxiliary storage pool device name. This is the name of the independent auxiliary storage pool (ASP) device of the object when it was saved.
        Returns:
        The ASP device name.
      • hashCode

        public int hashCode()
        Returns a hash code value for the object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code value for this object.
      • toString

        public java.lang.String toString()
        Returns the String representation of this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The String representation of this object.