com.ibm.as400.access
Class SaveFileEntry

java.lang.Object
  extended bycom.ibm.as400.access.SaveFileEntry
All Implemented Interfaces:
Comparable, Serializable

public class SaveFileEntry
extends Object
implements Serializable, Comparable

Represents an entry in a save file. Instances of this class are created by SaveFile.listEntries()

See Also:
Serialized Form

Method Summary
 int compareTo(Object otherObj)
          Compares this object with the specified object for order.
 int getASP()
          Returns the auxiliary storage pool (ASP) of the object when it was saved.
 String getASPDevice()
          Returns the auxiliary storage pool device name.
 String getDescription()
          Returns the text description of the object.
 String getDLOName()
          Returns the document library object (DLO) name.
 String getExtendedObjectAttribute()
          Returns extended information about the object type.
 String getFolder()
          Returns the name of the folder that was saved.
 String getLibrary()
          Returns the name of the library from which the object is saved.
 String getName()
          Returns the name of the object saved.
 String getOwner()
          Returns the name of the object owner's user profile.
 Date getSaveDate()
          Returns the time at which the object was saved.
 long getSize()
          Returns the total size of the object in bytes.
 String getType()
          Returns the type of object.
 boolean isDataSaved()
          Indicates whether the data for this object was saved with the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

compareTo

public int compareTo(Object otherObj)
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 Comparable
Throws:
ClassCastException - if otherObj is not an instance of SaveFileEntry.

getName

public 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 String getLibrary()
Returns the name of the library from which the object is saved.

Returns:
the object library.

getType

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

Returns:
The object type.

getExtendedObjectAttribute

public 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 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 String getOwner()
Returns the name of the object owner's user profile.

Returns:
The object owner.

getDLOName

public 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 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 String getDescription()
Returns the text description of the object.

Returns:
The description.

getASPDevice

public 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.