com.ptc.windchill.counterpart
Class CounterPartBundle

java.lang.Object
  extended bycom.ptc.windchill.counterpart.CounterPartBundle
All Implemented Interfaces:
Serializable

public class CounterPartBundle
extends Object
implements Serializable

This is what is passed to the CounterPart service on upload and what the CounterPart service returns on download. It contains the major elements of the classification. Because attachments might easily be so numerous or so large as to overflow available java memory, it contains a locator-list in place of the actual attachments. The locator list is not supplied on upload. Upload returns its list. The system ID is used in connection with attachments to determine whether the attachments to be uploaded or downloaded really match those that CounterPart has. initializeDelta() behaves very much like upload() except that it only changes the Delta. Notice that the download process collects its information from the delta content holders whenever it detects that the classification is "checked out", so the delta content holders must be capable of supplying everything in this bundle. In other words, when the classification is "checked out", the delta actually is a complete snapshot.

See Also:
Serialized Form

Field Summary
private  AttachmentLocator[] fAttachmentLocators
           
private  nitidus.sil.be.clf.iMasterClassificationIO fMasterClfWithAttachments
           
private  byte[] fPublicClassification
           
private  String fSystemID
           
private  nitidus.sil.be.unit.iUnitWorldIO fUnits
           
 
Constructor Summary
CounterPartBundle(nitidus.sil.be.clf.iMasterClassificationIO clfWithAttachments, nitidus.sil.be.unit.iUnitWorldIO units, byte[] publicClf, AttachmentLocator[] attachmentLocators, String systemId)
          Constructor for download - everything.
CounterPartBundle(nitidus.sil.be.clf.iMasterClassificationIO clfWithAttachments, nitidus.sil.be.unit.iUnitWorldIO units, byte[] publicClf, String systemId)
          Constructor for upload - no attachment locators.
CounterPartBundle(nitidus.sil.be.clf.iMasterClassificationIO clfWithAttachments, nitidus.sil.be.unit.iUnitWorldIO units, String systemId)
          Constructor for validate - no attachment locators and no public classification
 
Method Summary
 AttachmentLocator[] getAttachmentLocators()
           
 nitidus.sil.be.clf.iMasterClassificationIO getMasterClassification()
           
 byte[] getPublicClassification()
          Returns public classification as an XML stream compressed using GZIPOutputStream.
 String getSystemID()
           
 nitidus.sil.be.unit.iUnitWorldIO getUnits()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fMasterClfWithAttachments

private nitidus.sil.be.clf.iMasterClassificationIO fMasterClfWithAttachments

fUnits

private nitidus.sil.be.unit.iUnitWorldIO fUnits

fPublicClassification

private byte[] fPublicClassification

fAttachmentLocators

private AttachmentLocator[] fAttachmentLocators

fSystemID

private String fSystemID
Constructor Detail

CounterPartBundle

public CounterPartBundle(nitidus.sil.be.clf.iMasterClassificationIO clfWithAttachments,
                         nitidus.sil.be.unit.iUnitWorldIO units,
                         byte[] publicClf,
                         AttachmentLocator[] attachmentLocators,
                         String systemId)
Constructor for download - everything.


CounterPartBundle

public CounterPartBundle(nitidus.sil.be.clf.iMasterClassificationIO clfWithAttachments,
                         nitidus.sil.be.unit.iUnitWorldIO units,
                         byte[] publicClf,
                         String systemId)
Constructor for upload - no attachment locators. Also constructor for initializeDelta().


CounterPartBundle

public CounterPartBundle(nitidus.sil.be.clf.iMasterClassificationIO clfWithAttachments,
                         nitidus.sil.be.unit.iUnitWorldIO units,
                         String systemId)
Constructor for validate - no attachment locators and no public classification

Method Detail

getUnits

public nitidus.sil.be.unit.iUnitWorldIO getUnits()

getMasterClassification

public nitidus.sil.be.clf.iMasterClassificationIO getMasterClassification()

getPublicClassification

public byte[] getPublicClassification()
Returns public classification as an XML stream compressed using GZIPOutputStream. Returns null if there is no public classification.


getAttachmentLocators

public AttachmentLocator[] getAttachmentLocators()

getSystemID

public String getSystemID()