Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.services.qsys.api
Interface IQSYSResource

All Known Subinterfaces:
IQSYSCommand, IQSYSDatabaseFile, IQSYSDataFile, IQSYSDataMember, IQSYSDDMFile, IQSYSDisplayFile, IQSYSFile, IQSYSLibrary, IQSYSLogicalFile, IQSYSMember, IQSYSMessageFile, IQSYSModule, IQSYSObject, IQSYSPhysicalFile, IQSYSPrinterFile, IQSYSProgram, IQSYSProgramBase, IQSYSSaveFile, IQSYSServiceProgram, IQSYSSourceFile, IQSYSSourceMember
All Known Implementing Classes:
QSYSHostCommand, QSYSHostDatabaseFile, QSYSHostDataFile, QSYSHostDataMember, QSYSHostDDMFile, QSYSHostDisplayFile, QSYSHostFile, QSYSHostLibrary, QSYSHostLogicalFile, QSYSHostMember, QSYSHostMessageFile, QSYSHostModule, QSYSHostObject, QSYSHostPhysicalFile, QSYSHostPrinterFile, QSYSHostProgram, QSYSHostSaveFile, QSYSHostServiceProgram, QSYSHostSourceFile, QSYSHostSourceMember, QSYSRemoteBaseProgram, QSYSRemoteCommand, QSYSRemoteDatabaseFile, QSYSRemoteDataFile, QSYSRemoteDataMember, QSYSRemoteDDMFile, QSYSRemoteDisplayFile, QSYSRemoteFile, QSYSRemoteLibrary, QSYSRemoteLogicalFile, QSYSRemoteMember, QSYSRemoteMessageFile, QSYSRemoteModule, QSYSRemoteObject, QSYSRemotePhysicalFile, QSYSRemotePrinterFile, QSYSRemoteProgram, QSYSRemoteProgramModule, QSYSRemoteSaveFile, QSYSRemoteServiceProgram, QSYSRemoteSourceFile, QSYSRemoteSourceMember

public interface IQSYSResource

Generic interface for working with libraries, objects and members. Provides basic methods for accessing name, type and subtype.


Field Summary
static String copyright
           
 
Method Summary
 boolean exists()
          Test if the remote resource exists
 String getAbsoluteName()
          Get the absolute name (includes type) for the resource
 Date getDateCreated()
          Returns the date the resource was created.
 Date getDateModified()
          Returns the date the resource was last modified.
 String getDescription()
          Return the description of the resource
 String getFullName()
          Get the fully qualified name for the resource (does not include type)
 String getLibrary()
          Return the library the resource is contained in
 String getName()
          Return the name of the resource
 IQSYSResource getParent()
          Return the parent of this object
 long getSize()
          Returns the size of the resource.
 String getSubType()
          Return the subtype of the resource
 String getType()
          Return the type of the resource
 void setDescription(String text)
          Sets the description of the resource
 void setLibrary(String name)
          Set the library the resource is contained in
 void setName(String name)
          Set the name of the resource.
 void setSubType(String subtype)
          Return the subtype of the resource
 void setType(String type)
          Sets the type of the resource
 

Field Detail

copyright

static final String copyright
See Also:
Constant Field Values
Method Detail

getName

String getName()
Return the name of the resource


setName

void setName(String name)
Set the name of the resource.


getType

String getType()
Return the type of the resource


getDateCreated

Date getDateCreated()
Returns the date the resource was created.


getDateModified

Date getDateModified()
Returns the date the resource was last modified.


getSize

long getSize()
Returns the size of the resource.


setType

void setType(String type)
Sets the type of the resource


getSubType

String getSubType()
Return the subtype of the resource


setSubType

void setSubType(String subtype)
Return the subtype of the resource


getLibrary

String getLibrary()
Return the library the resource is contained in


setLibrary

void setLibrary(String name)
Set the library the resource is contained in


getDescription

String getDescription()
Return the description of the resource


setDescription

void setDescription(String text)
Sets the description of the resource


exists

boolean exists()
               throws SystemMessageException,
                      InterruptedException
Test if the remote resource exists

Throws:
SystemMessageException
InterruptedException

getFullName

String getFullName()
Get the fully qualified name for the resource (does not include type)


getAbsoluteName

String getAbsoluteName()
Get the absolute name (includes type) for the resource


getParent

IQSYSResource getParent()
                        throws SystemMessageException,
                               InterruptedException
Return the parent of this object

Throws:
SystemMessageException
InterruptedException

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.