com.ibm.etools.iseries.comm.interfaces
Interface IISeriesMember

public interface IISeriesMember

Interface for iSeries member instances.

Field Summary

static String

copyright

Method Summary

boolean	canRead() Queries whether we have read access authority to the member
boolean	exists() Queries whether the member exists
String	getAbsoluteName() Return the absolute object name: "library/object(member)"
Object	getAdapter(Class adapterType)
ISequentialFileReader	getContentsLineByLine() Return a reader to access the contents of the member line by line.
ISequentialFileReader	getContentsLineByLine(boolean transientDownload, boolean bidiVisual) Return a reader to access the contents of the member line by line.
String	getFullName() Return the fully qualified member name: library/object(member)
String	getLibraryName() From base class.
int	getNumberOfRecords() Returns the number of records deleted
int	getSourceFileCCSID() This is a specialized method for retrieving the member's CCSID for editing.
String	getSourceType() Return the source type for this memeber
boolean	isLocked() Check if the member has any locks on it.
void	setRemoveTrailingBlanks(boolean value) Sets whether or not trailing blanks should be removed upon download.

Field Detail

copyright

static final String copyright

See Also:

Constant Field Values

Method Detail

getLibraryName

String getLibraryName()

From base class.

Return the library containing this remote QSYS file system object

getAdapter

Object getAdapter(Class adapterType)

See Also:

IAdaptable#getAdapter(Class)

exists

boolean exists()
               throws Exception

Queries whether the member exists

Returns:

true if member exists on the server, false otherwise

Throws:

Exception

getSourceFileCCSID

int getSourceFileCCSID()
                       throws Exception

This is a specialized method for retrieving the member's CCSID for editing. It has two primary purposes: 1. Be fast. 2. Use a specific algorithm for determining the CCSID. First the source file's CCSID is checked. If this is 65535 then the job's CCSID is used. If this is 65535 then the job's default CCSID is used (this we are told will never be 65535.)

Throws:

Exception

canRead

boolean canRead()
                throws Exception

Queries whether we have read access authority to the member

Returns:

true if user has read access to the member, false otherwise

Throws:

Exception

isLocked

boolean isLocked()
                 throws Exception

Check if the member has any locks on it. For more specific information about the locks call getLocks();

Throws:

Exception

getFullName

String getFullName()

Return the fully qualified member name: library/object(member)

getAbsoluteName

String getAbsoluteName()

Return the absolute object name: "library/object(member)"

getSourceType

String getSourceType()

Return the source type for this memeber

Returns:

The string representation of the source type for this file.

getNumberOfRecords

int getNumberOfRecords()
                       throws Exception

Returns the number of records deleted

Returns:

int

Throws:

Exception

getContentsLineByLine

ISequentialFileReader getContentsLineByLine()
                                            throws Exception

Return a reader to access the contents of the member line by line.

Throws:

Exception

getContentsLineByLine

ISequentialFileReader getContentsLineByLine(boolean transientDownload,
                                            boolean bidiVisual)
                                            throws Exception

Return a reader to access the contents of the member line by line.

Parameters:

transientDownload - Specifies if the temporary copy of the member downloaded for the reader is deleted after the reader completes.

bidiVisual - If the file is contains BIDI text then the text is returned in visual format. If bidiVisual is true then transientDownload is ignored and assumed to be true. This is because the local copy cannot be added to the workspace if it is BIDI and in visual ordering.

Throws:

Exception

setRemoveTrailingBlanks

void setRemoveTrailingBlanks(boolean value)

Sets whether or not trailing blanks should be removed upon download.

Parameters:

value - True if the trailing blanks should be stripped, false otherwise

Since:

6.0.1