Package com.documentum.fc.client

# Interface IDfSysObjectStream

All Superinterfaces:
  `IDfPersistentObject`, `IDfSysObject`, `IDfTypedObject`, `com.documentum.fc.client.internal.IPersistentObjectInternal`, `com.documentum.fc.client.internal.ITypedObjectInternal`

public interface IDfSysObjectStream extends com.documentum.fc.client.internal.IPersistentObjectInternal, IDfSysObject
This class provides access to the any new public stream/content related api's for the IDfSysobject class. An obtained IDfSysObject should be cast to IDfSysObjectStream to make these calls.

- ## Field Summary

  ### Fields inherited from interface com.documentum.fc.client.IDfPersistentObject

  `CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `InputStream`
  `getStream(String format, int page, String pageModifier, boolean other)`
  Retrieves a content as InputStream from the Documentum server.
  `void`
  `setStream(InputStream stream, int size, String format)`
  Sets content as input stream to an associated sysobject.
  `void`
  `setStreamEx(InputStream stream, long size, String format, int page, InputStream otherStream, long otherSize)`
  This is the extended setStream() method for setting the content as InputStream to an associated sysobject.

  ### Methods inherited from interface com.documentum.fc.client.IDfPersistentObject

  `addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues`

  ### Methods inherited from interface com.documentum.fc.client.IDfSysObject

  `addDigitalSignature, addESignature, addNote, addReference, addRendition, addRenditionEx, addRenditionEx2, addRenditionEx3, appendContent, appendContentEx, appendFile, appendFileEx, appendPart, areAttributesModifiable, assemble, asVirtualDocument, attachPolicy, bindFile, branch, cancelCheckout, cancelCheckoutEx, cancelScheduledDemote, cancelScheduledPromote, cancelScheduledResume, cancelScheduledSuspend, canDemote, canPromote, canResume, canSuspend, checkin, checkinEx, checkout, checkoutEx, demote, destroyAllVersions, detachPolicy, disassemble, freeze, getAccessDate, getAccessorApplicationPermit, getAccessorCount, getAccessorName, getAccessorPermit, getAccessorPermitType, getAccessorXPermit, getAccessorXPermitNames, getACL, getACLDomain, getACLName, getAclRefValid, getAcsRequests, getAliasSet, getAliasSetId, getAntecedentId, getApplicationType, getAssembledFromId, getAuthors, getAuthorsCount, getBranchCount, getCabinetId, getChronicleId, getCollectionForContent, getCollectionForContentEx2, getCollectionForContentEx3, getCollectionForContentEx4, getComponentId, getComponentIdCount, getCompoundArchitecture, getContainId, getContainIdCount, getContent, getContentAvailability, getContentEx, getContentEx2, getContentEx3, getContentsId, getContentSize, getContentSize, getContentState, getContentStateCount, getContentType, getCreationDate, getCreatorName, getCurrentState, getCurrentStateName, getDirectDescendant, getDoubleContentAttr, getExceptionStateName, getFile, getFileEx, getFileEx2, getFolderId, getFolderIdCount, getFormat, getFrozenAssemblyCount, getFullText, getGroupName, getGroupPermit, getHasEvents, getHasFolder, getHasFrozenAssembly, getImplicitVersionLabel, getKeywords, getKeywordsCount, getLatestFlag, getLinkCount, getLinkHighCount, getLocations, getLockDate, getLockMachine, getLockOwner, getLogEntry, getMasterDocbase, getModifier, getModifyDate, getNextStateName, getObjectName, getOtherFileSize, getOwnerName, getOwnerPermit, getPageCount, getPath, getPathEx, getPathEx2, getPermissions, getPermit, getPermitEx, getPolicyId, getPolicyName, getPreviousStateName, getReferenceCount, getRemoteId, getRenditions, getResolutionLabel, getResumeState, getResumeStateName, getRetainerCount, getRetainerId, getRetainUntilDate, getRetentionDate, getRouters, getSpecialApp, getStatus, getStorageType, getStringContentAttr, getSubject, getTimeContentAttr, getTitle, getTypeName, getVdmPath, getVdmPathDQL, getVersionLabel, getVersionLabelCount, getVersionLabels, getVersionPolicy, getVersions, getWorkflows, getWorldPermit, getXPermit, getXPermitList, getXPermitNames, grant, grantPermit, hasPermission, insertContent, insertContentEx, insertFile, insertFileEx, insertPart, isArchived, isCheckedOut, isCheckedOutBy, isContentTransferCapabilityEnabled, isFrozen, isHidden, isImmutable, isLinkResolved, isPublic, isReference, isSuspended, isVirtualDocument, link, mark, mount, print, promote, prune, queue, refreshReference, removeContent, removeNote, removePart, removeRendition, removeRenditionEx, removeRenditionEx2, resolveAlias, resume, revertACL, revoke, revokePermit, saveAsNew, saveLock, scheduleDemote, schedulePromote, scheduleResume, scheduleSuspend, setACL, setACLDomain, setACLName, setApplicationType, setArchived, setAuthors, setCompoundArchitecture, setContent, setContentEx, setContentEx2, setContentType, setDoubleContentAttribute, setFile, setFileEx, setFullText, setGroupName, setGroupPermit, setHidden, setIsVirtualDocument, setKeywords, setLinkResolved, setLogEntry, setObjectName, setOwnerName, setOwnerPermit, setPath, setResolutionLabel, setSpecialApp, setStatus, setStorageType, setStringContentAttribute, setSubject, setTimeContentAttribute, setTitle, setWorldPermit, suspend, unfreeze, unlink, unmark, updatePart, updatePartEx, useACL, verifyESignature`

  ### Methods inherited from interface com.documentum.fc.client.IDfTypedObject

  `appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate`

  ### Methods inherited from interface com.documentum.fc.client.internal.IPersistentObjectInternal

  `attachAspect, destroyInternal, detachAspect, exportForFtIndexing, getAspects`

  ### Methods inherited from interface com.documentum.fc.client.internal.ITypedObjectInternal

  `executeDocbaseScopedQuery`

- ## Method Details

  - ### getStream

    InputStream getStream(String format, int page, String pageModifier, boolean other) throws DfException
    Retrieves a content as InputStream from the Documentum server. The following code example demonstrates how to get the sysobject content as stream from the Documentum server and to print it to standard output console

    >      InputStream inputStream = ((IDfSysObjectStream) sysobject).getStream("crtext", 0, null, false);
    >      String line;
    >      BufferedReader bufferedReader = new BufferedReader( new InputStreamReader( inputStream ) );
    >      while( (line = bufferedReader.readLine()) != null )
    >      {
    >           System.out.printf("%s\n", line);
    >      }

    Parameters:
      `format` - Specifies the file format of the content.
      `page` - Identifies the position of the content when the object has multiple contents; otherwise, use 0.
      `pageModifier` - uniquely identifies a rendition within the same page number and format for a document. If there already exists a rendition with the supplied page_modifier (at the given format and page) the rendition will be overwritten.
      `other` - for files created on Macintosh systems, indicates whether you want to set the data fork (the file containing the content) or the resource fork.
    Returns:
      the input stream for the specified sysobject content.
    Throws:
      `DfException` - if a server error occurs.

  - ### setStream

    void setStream(InputStream stream, int size, String format) throws DfException
    Sets content as input stream to an associated sysobject. This operation is not committed until a `save` or a `checkin` is performed.

    The following code example demonstrates how to set content as stream

    >      ((IDfSysObjectStream)sysobject).setStream(stream0, stream0.available(), "crtext");
    >      sysObj.save();

    Parameters:
      `stream` - the content as a InputStream.
      `size` - the content stream size
      `format` - Specifies the file format of the content.
    Throws:
      `DfException` - if a server error occurs.

  - ### setStreamEx

    void setStreamEx(InputStream stream, long size, String format, int page, InputStream otherStream, long otherSize) throws DfException
    This is the extended setStream() method for setting the content as InputStream to an associated sysobject.
    Parameters:
      `stream` - the content as a InputStream.
      `size` - the content stream size
      `format` - Specifies the file format of the content.
      `page` - Identifies the position of the content when the object has multiple contents; otherwise, use 0.
      `otherStream` - stream for files created on Macintosh systems.
      `otherSize` - size of stream for files created on Macintosh systems.
    Throws:
      `DfException` - if a server error occurs.