iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.core.api
Class ISeriesDataElementToHostObjectConverters

java.lang.Object
  extended bycom.ibm.etools.iseries.core.api.ISeriesDataElementToHostObjectConverters
All Implemented Interfaces:
IISeriesDataElementDescriptorTypes

public class ISeriesDataElementToHostObjectConverters
extends Object
implements IISeriesDataElementDescriptorTypes

Static converter methods that convert a data element to a host object by simply instantiating an appropriate host object and copying properties to it.


Field Summary
static String copyright
           
 
Fields inherited from interface com.ibm.etools.iseries.core.descriptors.IISeriesDataElementDescriptorTypes
Copyright, DSPF_FILE_TYPE, DTA_FILE_TYPE, FILE_TYPE, LF_FILE_TYPE, LIB_TYPE, MBR_TYPE, MESSAGE_DESCRIPTION_TYPE, MODULE_TYPE, MSG_FILE_TYPE, OBJ_TYPE, PGM_MODULE_TYPE, PGM_TYPE, PROCEDURE_TYPE, QRYDFN_TYPE, SAVF_FILE_TYPE, SRC_FILE_TYPE, SRC_MBR_TYPE, SRVPGM_TYPE, UNKNOWN_TYPE
 
Constructor Summary
ISeriesDataElementToHostObjectConverters()
           
 
Method Summary
static ISeriesRecord geISeriesRecord(Object remoteObject)
          Converts a DataElement object into an ISeriesRecord object.
static com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic getBasicHostObject(Object remoteObject)
          Convert to more advanced object which contains basic amount of information
static com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive getExhaustiveHostObject(Object remoteObject)
          Convert to exhaustive object which contains all information
static com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldBasic getHostFieldObject(Object remoteObject)
          Convert to basic field object which contains all information
static com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldNameOnly getHostFieldObjectName(Object remoteObject)
          Convert to name-only field object which contains all information
static com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief getHostObject(Object remoteObject)
          Convert to typical object which contains brief amount of information
static com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordDevice getHostRecordDeviceObject(Object remoteObject)
          Convert to basic device record object which contains all information
static com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic getHostRecordObject(Object remoteObject)
          Convert to basic record object which contains all information
static com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordNameOnly getHostRecordObjectName(Object remoteObject)
          Convert to name-only record object which contains all information
static ISeriesField getISeriesField(Object remoteObject)
          Converts a DataElement object into an ISeriesField object.
static ISeriesJob getISeriesJob(Object remoteObject)
          Converts a DataElement object into an ISeriesJob object.
static ISeriesLibrary getISeriesLibrary(Object remoteObject)
          Converts a DataElement object into an ISeriesLibrary object.
static ISeriesMember getISeriesMember(Object remoteObject)
          Converts a DataElement object into an ISeriesMember object.
static ISeriesMessageDescription getISeriesMessageDescription(Object remoteObject)
          Convert to a message description object
static ISeriesObject getISeriesObject(Object remoteObject)
          Converts a DataElement object into an ISeriesObject object.
static ISeriesProcedure getISeriesProcedure(Object remoteObject)
          Converts a DataElement object into an ISeriesProcedure object.
static ISeriesProgramModule getISeriesProgramModule(Object remoteObject)
          Converts a DataElement object into an ISeriesProgramModule object.
static ISeriesRecordDevice getISeriesRecordDevice(Object remoteObject)
          Converts a DataElement object into an ISeriesRecordDevice object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

ISeriesDataElementToHostObjectConverters

public ISeriesDataElementToHostObjectConverters()
Method Detail

getHostObject

public static com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief getHostObject(Object remoteObject)
Convert to typical object which contains brief amount of information

Parameters:
remoteObject - An instance of DataElement or IISeriesHostObjectBrief which represents a remote iSeries object.
Returns:
An instance of IISeriesHostObjectBrief or null if the remote object is not a supported type

getISeriesLibrary

public static ISeriesLibrary getISeriesLibrary(Object remoteObject)
Converts a DataElement object into an ISeriesLibrary object. The DataElement must represent an iSeries library (i.e. have a type attribute equal to *LIB).

Parameters:
remoteObject - An instance of DataElement which represents an iSeries library
Returns:
An ISeriesLibrary instance representing the same iSeries library as the DataElement. null is returned if remoteObject is not an instance of DataElement or does not represent a remote library.

getISeriesObject

public static ISeriesObject getISeriesObject(Object remoteObject)
Converts a DataElement object into an ISeriesObject object. The DataElement must represent an iSeries object.

Parameters:
remoteObject - An instance of DataElement which represents an iSeries object
Returns:
An ISeriesObject instance representing the same iSeries object as the DataElement. null is returned if remoteObject is not an instance of DataElement or does not represent a remote object

getISeriesMember

public static ISeriesMember getISeriesMember(Object remoteObject)
Converts a DataElement object into an ISeriesMember object. The DataElement must represent an iSeries member.

Parameters:
remoteObject - An instance of DataElement which represents an iSeries member
Returns:
An ISeriesMember instance representing the same iSeries member as the DataElement. null is returned if remoteObject is not an instance of DataElement or does not represent a remote member

geISeriesRecord

public static ISeriesRecord geISeriesRecord(Object remoteObject)
Converts a DataElement object into an ISeriesRecord object. The DataElement must represent an iSeries record (i.e. have a type attribute equal to *???).

Note that ISeriesRecord represents information pertaining to records of all file types. There is additional information available uniquely for device files, but that is an explicit separate comm layer request, resulting in ISeriesRecordDevice objects.

Parameters:
remoteObject - An instance of DataElement which represents an iSeries record, or an iSeries record itself
Returns:
An ISeriesRecord instance representing the same iSeries record as the DataElement or input. null is returned if remoteObject is not an instance of DataElement or does not represent a remote record.

getISeriesRecordDevice

public static ISeriesRecordDevice getISeriesRecordDevice(Object remoteObject)
Converts a DataElement object into an ISeriesRecordDevice object. The DataElement must represent an iSeries device-file record (i.e. have a type attribute equal to *???).

Note that ISeriesRecordDevice represents information pertaining uniquely to device files, and is not the default info returned on a record list query. This requires an explicit type of communication layer request. TODO: how to do this request?

Parameters:
remoteObject - An instance of DataElement which represents an iSeries device file record, or an iSeries device-file record itself
Returns:
An ISeriesRecordDevice instance representing the same iSeries record as the DataElement or input. null is returned if remoteObject is not an instance of DataElement or does not represent a remote record.

getISeriesField

public static ISeriesField getISeriesField(Object remoteObject)
Converts a DataElement object into an ISeriesField object. The DataElement must represent an iSeries field (i.e. have a type attribute equal to *???).

Parameters:
remoteObject - An instance of DataElement which represents an iSeries field, or an iSeries field itself
Returns:
An ISeriesField instance representing the same iSeries field as the DataElement or input. null is returned if remoteObject is not an instance of DataElement or does not represent a remote record.

getISeriesProgramModule

public static ISeriesProgramModule getISeriesProgramModule(Object remoteObject)
Converts a DataElement object into an ISeriesProgramModule object. The DataElement must represent a module inside of an iSeries program or service program

Parameters:
remoteObject - An instance of DataElement which represents an module. or an iSeries field itself
Returns:
An ISeriesProgramModule instance representing the same module as the DataElement or input. null is returned if remoteObject is not an instance of DataElement or does not represent a remote record.

getISeriesProcedure

public static ISeriesProcedure getISeriesProcedure(Object remoteObject)
Converts a DataElement object into an ISeriesProcedure object. The DataElement must represent a procedure inside of a module.

Parameters:
remoteObject - An instance of DataElement which represents a procedure.
Returns:
An ISeriesProcedure instance representing the same procedure as the DataElement or input. null is returned if remoteObject is not an instance of DataElement or does not represent a remote record.

getISeriesJob

public static ISeriesJob getISeriesJob(Object remoteObject)
Converts a DataElement object into an ISeriesJob object. The DataElement must represent an iSeries job(i.e. have a type attribute equal to *JOB).

Parameters:
remoteObject - An instance of DataElement which represents an iSeries job
Returns:
An ISeriesJob instance representing the same iSeries job as the DataElement. null is returned if remoteObject is not an instance of DataElement or does not represent an iSeries job.

getBasicHostObject

public static com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic getBasicHostObject(Object remoteObject)
Convert to more advanced object which contains basic amount of information


getExhaustiveHostObject

public static com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive getExhaustiveHostObject(Object remoteObject)
Convert to exhaustive object which contains all information


getHostRecordObjectName

public static com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordNameOnly getHostRecordObjectName(Object remoteObject)
Convert to name-only record object which contains all information


getHostRecordObject

public static com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic getHostRecordObject(Object remoteObject)
Convert to basic record object which contains all information


getHostRecordDeviceObject

public static com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordDevice getHostRecordDeviceObject(Object remoteObject)
Convert to basic device record object which contains all information


getHostFieldObjectName

public static com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldNameOnly getHostFieldObjectName(Object remoteObject)
Convert to name-only field object which contains all information


getHostFieldObject

public static com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldBasic getHostFieldObject(Object remoteObject)
Convert to basic field object which contains all information


getISeriesMessageDescription

public static ISeriesMessageDescription getISeriesMessageDescription(Object remoteObject)
Convert to a message description object


iSeries Remote Systems
v6.0.1

Copyright © 2005 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.