Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.remotebuild
Class RBBinaryObject

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

public class RBBinaryObject
extends RBFile


Field Summary
 
Fields inherited from class com.ibm.etools.iseries.remotebuild.RBFile
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
RBBinaryObject(AbstractISeriesNativeObject resource)
           
 
Method Summary
 RBStatus checkContentsOn(RBSystem system)
          Checks the contents of the local resource against those of the target system resource.
 RBStatus checkName()
          Checks the name of this path for validity.
 RBStatus createOn(RBSystem system)
          Pushes a creation of a save file to the target system from a file resource.
 boolean existsOn(RBSystem system)
          Tests for existence of files on a target system.
 List getAllProperties()
          Returns a set of all the property names this resource.
 String getDescription()
           
 int getGender()
          Returns the type of this resource -- see constants.
 String getLocation()
          Returns the absolute path string to the local resource unpacked in a temp directory
 Collection<String> getModifiedProperties(com.ibm.etools.iseries.projects.internal.snapshots.SnapshotRecord sr)
           
 String getName()
          Returns the name of the resource inside iproject, without the extension for operation on remote commands.
 File getObjectArchiveResource()
           
 String getObjectName()
          Returns the name of the save file containing this object
 String getObjectResourceName()
          Returns the resource name for a given resource path inside iproject
 String getObjectType()
          Returns the type of this object
 String getOriginalObjectName()
          Returns the original object name, before it was packed into save file
 String getQSYSName()
          Returns the name of this object in the QSYS name space.
 String getSaveFromLibraryName()
          Returns the library name of this object
 String getShortKey()
          Returns a value that may be used as a key for this resource.
 String getSnapshotType()
          Returns the snapshot type for this class.
 RBStatus pushContentsTo(RBSystem system)
          Pushes the contents of a save file to the target system.
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBFile
getIFSName, getProjectRelativePath, getQualifiedName, getSimpleObjectType
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBQSYSResource
getLibraryName, getNameSpace
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBResource
accept, addChild, attach, checkAuthorities, checkExistence, checkPropertiesOn, checkProperty, clearMark, clearMarks, copy, findResource, getAdapter, getAncestors, getBaseResource, getCCSID, getChild, getChildren, getCompanion, getContext, getDBCS, getDescendents, getHome, getHome, getKeyPath, getLocalStamp, 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, 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
 

Constructor Detail

RBBinaryObject

public RBBinaryObject(AbstractISeriesNativeObject resource)
Method Detail

getObjectArchiveResource

public File getObjectArchiveResource()

existsOn

public boolean existsOn(RBSystem system)
Description copied from class: RBFile
Tests for existence of files on a target system.

Overrides:
existsOn in class RBFile
See Also:
RBFile.existsOn(RBSystem)

checkContentsOn

public RBStatus checkContentsOn(RBSystem system)
Description copied from class: RBResource
Checks the contents of the local resource against those of the target system resource. Reports a conflict if one exists.

The default implementation returns an OK status.

Overrides:
checkContentsOn in class RBResource

getQSYSName

public String getQSYSName()
Returns the name of this object in the QSYS name space.

Overrides:
getQSYSName in class RBFile

createOn

public RBStatus createOn(RBSystem system)
Pushes a creation of a save file to the target system from a file resource. Save files can only be created with their contents. An empty save file cannot be created.

Specified by:
createOn in class RBResource

pushContentsTo

public RBStatus pushContentsTo(RBSystem system)
Pushes the contents of a save file to the target system. Modification of a save file will normally destroy it. It can safely be modified only if the contents are binary copied from another save file.

Overrides:
pushContentsTo 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.

getGender

public int getGender()
Description copied from class: RBResource
Returns the type of this resource -- see constants.

Specified by:
getGender in class RBResource

getModifiedProperties

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

getSnapshotType

public String getSnapshotType()
Description copied from class: RBResource
Returns the snapshot type for this class. There is a 1-1 correspondence between gender and snapshot type.

Specified by:
getSnapshotType in class RBResource

checkName

public RBStatus checkName()
Checks the name of this path for validity.

Overrides:
checkName in class RBFile

getName

public String getName()
Returns the name of the resource inside iproject, without the extension for operation on remote commands.

Overrides:
getName in class RBResource

getObjectResourceName

public String getObjectResourceName()
Returns the resource name for a given resource path inside iproject


getSaveFromLibraryName

public String getSaveFromLibraryName()
Returns the library name of this object


getObjectName

public String getObjectName()
Returns the name of the save file containing this object

Overrides:
getObjectName in class RBFile

getOriginalObjectName

public String getOriginalObjectName()
Returns the original object name, before it was packed into save file


getObjectType

public String getObjectType()
Returns the type of this object

Overrides:
getObjectType in class RBQSYSResource

getLocation

public String getLocation()
Returns the absolute path string to the local resource unpacked in a temp directory

Overrides:
getLocation in class RBResource

getShortKey

public String getShortKey()
Returns a value that may be used as a key for this resource.

Overrides:
getShortKey in class RBQSYSResource

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.