com.ibm.cics.zos.model
Interface IZOS

All Superinterfaces:
IConnectable

public interface IZOS
extends IConnectable

Service interface for interacting with z/OS resources.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.io.ByteArrayOutputStream getContents(DataEntry dataEntry, FileType aFileType)
          Get the contents of a DataEntry as a ByteArrayOutputStream
 Member getDataSetMember(PartitionedDataSet dataSet, java.lang.String memberName)
          Retrieve metadata about a specific member of a PDS
 java.util.List<Member> getMembers(PartitionedDataSet aDataSet)
          Retrieve metadata about all members of a PDS
 void save(DataEntry aMember, java.io.InputStream aStream)
          Save the contents of an InputStream to a DataEntry.
 
Methods inherited from interface com.ibm.cics.core.comm.IConnectable
addListener, disconnect, getConnection, getConnectionType, isConnected, setConnection
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getMembers

java.util.List<Member> getMembers(PartitionedDataSet aDataSet)
                                  throws PermissionDeniedException,
                                         ConnectionException
Retrieve metadata about all members of a PDS

Parameters:
aDataSet - PDS to retrieve the children for
Returns:
a List of Members of the supplied PDS, which may be empty.
Throws:
PermissionDeniedException - if the user did not have permission to list the directory contents
ConnectionException - if there was a problem performing the request

getDataSetMember

Member getDataSetMember(PartitionedDataSet dataSet,
                        java.lang.String memberName)
                        throws java.io.FileNotFoundException,
                               PermissionDeniedException,
                               ConnectionException
Retrieve metadata about a specific member of a PDS

Parameters:
dataSet - PDS to retrieve member metadata for.
memberName - name of a member to retrieve metadata for.
Returns:
Member describing metadata for the requested memberName
Throws:
java.io.FileNotFoundException - if a member with the supplied name can not be found
PermissionDeniedException - if the current user did not have permission to retrieve metadata for the requested member.
ConnectionException - if there was a problem performing the request.

save

void save(DataEntry aMember,
          java.io.InputStream aStream)
          throws UpdateFailedException
Save the contents of an InputStream to a DataEntry.

Parameters:
aMember - DataEntry to write the stream contents to
aStream - InputStream of the data to write
Throws:
UpdateFailedException - if there is any problem writing to the data entry

getContents

java.io.ByteArrayOutputStream getContents(DataEntry dataEntry,
                                          FileType aFileType)
                                          throws java.io.FileNotFoundException,
                                                 PermissionDeniedException,
                                                 ConnectionException
Get the contents of a DataEntry as a ByteArrayOutputStream

Parameters:
dataEntry - DataEntry to retrieve the contents of
aFileType - transfer type
Returns:
ByteArrayOutputStream of the contents of a DataEntry
Throws:
java.io.FileNotFoundException - if the supplied DataEntry can not be found
PermissionDeniedException - if the current user does not have permission to access the contents of the supplied DataEntry
ConnectionException - if there is a problem retrieving the contents of the DataEntry


Copyright © 2013 IBM Corp. All Rights Reserved.