Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.remotebuild
Class RBLibrary

java.lang.Object
  extended by com.ibm.etools.iseries.remotebuild.RBResource
      extended by com.ibm.etools.iseries.remotebuild.RBQSYSResource
          extended by com.ibm.etools.iseries.remotebuild.RBLibrary

public class RBLibrary
extends RBQSYSResource

This class implements a library resource. The name is the library name on the as/400 system. The base resource is an IProject. The model resource is an AbstractISeriesNativeLibrary. The library resource is always a child of a project resource and as such is always a home node. The children of library will be objects -- usually source files and save files.


Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.iseries.remotebuild.RBResource
G_BINARYOBJECT, G_LIBRARY, G_MEMBER, G_PROJECT, G_SAVEFILE, G_SOURCEFILE, G_UNKNOWN, NS_LOCAL, NS_NETWORK, NS_QSYS, NS_UNKNOWN, RB_QUALIFIER
 
Constructor Summary
RBLibrary(AbstractISeriesNativeLibrary resource)
          Constructs an RBResource from a model resource.
RBLibrary(String name, long localStamp, long targetStamp)
          Constructs an RBLibrary from its metadata.
 
Method Summary
 RBStatus checkName()
          Checks the library name.
 RBStatus createOn(RBSystem system)
          Pushes a creation of this library to the target system.
 boolean existsOn(RBSystem system)
          Tests for the existence of a library.
 List getAllProperties()
          Returns a set of all the property names this resource.
 int getGender()
          Returns the gender of this resource.
 String getIFSName()
          Returns the IFS name of this library.
 String getLibraryName()
          Returns the library name of this object.
 Collection<String> getModifiedProperties(com.ibm.etools.iseries.projects.internal.snapshots.SnapshotRecord sr)
           
 String getName()
          Returns the name of this resource
 IPath getProjectRelativePath()
          Returns the project relative path of this resource.
 String getQSYSName()
          Returns the name of this object in the QSYS name space.
 CLQualifiedName getQualifiedName()
          Returns the fully-qualified system-relative object name for a resource in the QSYS namespace.
 String getSimpleObjectType()
          Returns the simple object type for this resource.
 String getSnapshotType()
          Returns the tag name for this resource.
 RBSourceFile[] getSourceFiles()
          Returns an array of source file resources in this library.
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBQSYSResource
getNameSpace, getObjectType, getShortKey
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBResource
accept, addChild, attach, checkAuthorities, checkContentsOn, checkExistence, checkPropertiesOn, checkProperty, clearMark, clearMarks, copy, findResource, getAdapter, getAncestors, getBaseResource, getCCSID, getChild, getChildren, getCompanion, getContext, getDBCS, getDescendents, getDescription, getHome, getHome, getKeyPath, getLocalStamp, getLocation, getLongKey, getModelChildren, getModelParent, getModelProject, getModelProperty, getModelResource, getNumberOfChildren, getParent, getPersistentProperty, getProject, getProjectProperty, getPropertiesModel, getRecordLength, getRemoteName, getResourcePath, getSessionProperty, getSourceType, getSystem, getSystemName, getTargetStamp, hasChildren, hasContents, hasContext, hashCode, hasMark, isEquivalentTo, isHome, isLocal, isMarked, isProject, isRemote, isSnapshot, makeFrom, makeFrom, makeFrom, pushContentsTo, pushPropertiesTo, pushPropertiesTo, pushSourceTypeTo, qualify, removeChild, saveModelProperties, setCompanion, setContext, setLocalStamp, setMark, setModelProperty, setName, setPersistentProperty, setProjectProperty, setSessionProperty, setSourceType, setTargetStamp, synchronize, toString, updateFrom, wasCreated, wasDeleted, wasModified
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

RBLibrary

public RBLibrary(AbstractISeriesNativeLibrary resource)
Constructs an RBResource from a model resource.


RBLibrary

public RBLibrary(String name,
                 long localStamp,
                 long targetStamp)
Constructs an RBLibrary from its metadata.

Method Detail

getName

public String getName()
Description copied from class: RBResource
Returns the name of this resource

Overrides:
getName in class RBResource
Returns:
the name of this resource.

getGender

public int getGender()
Returns the gender of this resource.

Specified by:
getGender in class RBResource

getSnapshotType

public String getSnapshotType()
Returns the tag name for this resource. Used during construction of snapshots.

Should not be used by clients.

Specified by:
getSnapshotType in class RBResource

getLibraryName

public String getLibraryName()
Returns the library name of this object. This may be null.

Overrides:
getLibraryName in class RBQSYSResource

getSimpleObjectType

public String getSimpleObjectType()
Returns the simple object type for this resource.

Specified by:
getSimpleObjectType in class RBQSYSResource

getQualifiedName

public CLQualifiedName getQualifiedName()
Returns the fully-qualified system-relative object name for a resource in the QSYS namespace. For libraries this is simply the library name.

Specified by:
getQualifiedName in class RBQSYSResource

getProjectRelativePath

public IPath getProjectRelativePath()
Returns the project relative path of this resource. For libraries this is the empty path since there is no corresponding local resource.

Specified by:
getProjectRelativePath in class RBResource

getIFSName

public String getIFSName()
Returns the IFS name of this library. Useful when attempting to perform an IFS related action on this library.

Specified by:
getIFSName in class RBResource

getQSYSName

public String getQSYSName()
Returns the name of this object in the QSYS name space. For libraries this is simply the library name.

Specified by:
getQSYSName in class RBResource

getSourceFiles

public RBSourceFile[] getSourceFiles()
Returns an array of source file resources in this library. Used by clients to determine the source files of this libary.


checkName

public RBStatus checkName()
Checks the library name. Determines that the name of this library is a legal iSeries name.

Overrides:
checkName in class RBResource

existsOn

public boolean existsOn(RBSystem system)
Tests for the existence of a library. Returns true if the library exists on a particular system.

Specified by:
existsOn in class RBResource

createOn

public RBStatus createOn(RBSystem system)
Pushes a creation of this library to the target system.

Specified by:
createOn in class RBResource

getModifiedProperties

public Collection<String> getModifiedProperties(com.ibm.etools.iseries.projects.internal.snapshots.SnapshotRecord sr)
Specified by:
getModifiedProperties in class RBResource

getAllProperties

public List getAllProperties()
Description copied from class: RBResource
Returns a set of all the property names this resource. If there are no properties this list will be empty.

Specified by:
getAllProperties in class RBResource

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.