Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.remotebuild
Class RBSourceFile

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.RBFile
              extended by com.ibm.etools.iseries.remotebuild.RBSourceFile

public class RBSourceFile
extends RBFile


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
RBSourceFile(AbstractISeriesNativeObject resource)
          Constructs an RBResource from a model resource.
RBSourceFile(String name, long localStamp, long targetStamp)
          Constructs an RBSourceFile from its metadata.
 
Method Summary
 RBStatus checkPropertiesOn(RBSystem system)
          Checks the properties of the local resource agains those of the remote resource.
 RBStatus createOn(RBSystem system)
          Pushes a creation of a source file to the target system from a folder resource.
 List getAllProperties()
          Returns a set of all the property names this resource.
 String getCCSID()
          Returns the CCSID of this file as a string value.
 String getDBCS()
          Returns the DBCS property of this file as a string value, will be *YES or *NO.
 String getDescription()
           
 int getGender()
          Returns the gender of this resource.
 Collection<String> getModifiedProperties(com.ibm.etools.iseries.projects.internal.snapshots.SnapshotRecord sr)
           
 String getRecordLength()
          Returns the record length of this file as a string value.
 String getSnapshotType()
          Returns the tag name for this resource.
 String getText()
          Returns the text property of this file as a string value.
static String makeKey(String name)
          Makes a key for this type.
 RBStatus pushPropertiesTo(RBSystem system, Collection properties)
          Pushes the properties of a source file to the target system from a folder resource.
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBFile
checkName, existsOn, getIFSName, getObjectName, getProjectRelativePath, getQSYSName, getQualifiedName, getSimpleObjectType
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBQSYSResource
getLibraryName, getNameSpace, getObjectType, getShortKey
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBResource
accept, addChild, attach, checkAuthorities, checkContentsOn, checkExistence, checkProperty, clearMark, clearMarks, copy, findResource, getAdapter, getAncestors, getBaseResource, getChild, getChildren, getCompanion, getContext, getDescendents, getHome, getHome, getKeyPath, getLocalStamp, getLocation, getLongKey, getModelChildren, getModelParent, getModelProject, getModelProperty, getModelResource, getName, getNumberOfChildren, getParent, getPersistentProperty, getProject, getProjectProperty, getPropertiesModel, getRemoteName, getResourcePath, getSessionProperty, getSourceType, getSystem, getSystemName, getTargetStamp, hasChildren, hasContents, hasContext, hashCode, hasMark, isEquivalentTo, isHome, isLocal, isMarked, isProject, isRemote, isSnapshot, makeFrom, makeFrom, makeFrom, pushContentsTo, 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

RBSourceFile

public RBSourceFile(AbstractISeriesNativeObject resource)
Constructs an RBResource from a model resource.


RBSourceFile

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

Method Detail

makeKey

public static String makeKey(String name)
Makes a key for this type.


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.

Specified by:
getSnapshotType in class RBResource

getCCSID

public String getCCSID()
Returns the CCSID of this file as a string value. May be *HEX or *JOB in addition to an integer.

Overrides:
getCCSID in class RBResource
Returns:
the CCSID for this resource. This is null unless the resource supports CCSIDs. Should be overridden by subclasses that support CCSIDs.

getRecordLength

public String getRecordLength()
Returns the record length of this file as a string value.

Overrides:
getRecordLength in class RBResource
Returns:
the record length for this resource. This is null unless the resource supports record lengths. Should be overridden by subclasses that support record lengths.

getDBCS

public String getDBCS()
Returns the DBCS property of this file as a string value, will be *YES or *NO.

Overrides:
getDBCS in class RBResource
Returns:
the DBCS property for this resource. This is null unless the resource supports a DBCS property. Should be overridden by subclasses that support a DBCS property.

getText

public String getText()
Returns the text property of this file as a string value.


createOn

public RBStatus createOn(RBSystem system)
Pushes a creation of a source file to the target system from a folder resource.

Specified by:
createOn in class RBResource

checkPropertiesOn

public RBStatus checkPropertiesOn(RBSystem system)
Checks the properties of the local resource agains those of the remote resource. If there is a conflict, report it. The resource is in charge of selecting those properties that will be examined.

Overrides:
checkPropertiesOn in class RBResource

pushPropertiesTo

public RBStatus pushPropertiesTo(RBSystem system,
                                 Collection properties)
Pushes the properties of a source file to the target system from a folder resource.

Overrides:
pushPropertiesTo 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

getDescription

public String getDescription()
Overrides:
getDescription in class RBResource
Returns:
the text description for this resource. This is null unless the resource supports descriptions. Should be overridden by subclasses that support descriptions.

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.