|
iSeries Remote Systems v6.0.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
com.ibm.etools.iseries.core.api.ISeriesHostObjectBriefWrapper
com.ibm.etools.iseries.core.api.ISeriesHostObjectBasicWrapper
com.ibm.etools.iseries.core.api.ISeriesMember
This is a usable representation of an object on a remote iSeries object. It contains most of the attributes as retrieved from the system api for listing objects.
This object is instantiated from the DataElement object that is normally returned from a remote list request.
Note that the setXXX methods do not change the record on the host. Rather, their purpose is simply to capture the attribute internally, after reading it from an external source, say.
See the iSeries CL API QUSLOBJ for a full description of each attribute
Field Summary | |
---|---|
protected boolean |
bBasicPropertiesAvailable
|
protected boolean |
bExhaustivePropertiesAvailable
|
protected boolean |
bValue
|
protected Calendar |
calendar
|
static String |
copyright
|
protected char |
cValue
|
protected Date |
date
|
protected int |
day
|
protected com.ibm.etools.systems.dstore.core.model.DataElement |
deProperties
|
protected com.ibm.etools.systems.dstore.core.model.DataElement |
deProperty
|
protected int |
hour
|
protected int |
iValue
|
protected long |
lValue
|
protected int |
minute
|
protected int |
month
|
protected StringBuffer |
sbValue
|
protected int |
second
|
protected String |
sValue
|
protected int |
year
|
Fields inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper |
---|
cacheFilter, cacheTimeStamp, dataelement, EXPIRE_TIME, lastException, lastRunMsg, lastRunMsgId, localCache |
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic |
---|
Copyright |
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief |
---|
STATUS_DAMAGED, STATUS_LOCKED, STATUS_NOTAUTHORIZED, STATUS_OK, STATUS_PARTIALLYDAMAGED, STATUS_STRING_DAMAGED, STATUS_STRING_LOCKED, STATUS_STRING_NOTAUTHORIZED, STATUS_STRING_PARTIALLYDAMAGED |
Constructor Summary | |
---|---|
ISeriesMember(com.ibm.etools.systems.dstore.core.model.DataElement dataelement)
Constructor |
Method Summary | |
---|---|
ISeriesEditableSrcPhysicalFileMember |
browse()
Opens this member in the integrated LPEX editor, in browse mode, using the currently active shell. |
ISeriesEditableSrcPhysicalFileMember |
browse(Shell shell)
Opens this member in the integrated LPEX editor, in browse mode, using a given shell. |
static ISeriesEditableSrcPhysicalFileMember |
browse(Shell shell,
ISeriesConnection connection,
String libName,
String fileName,
String mbrName)
Opens a given member member in the integrated LPEX editor, in browse mode. |
boolean |
canRead()
Queries whether we have read access authority to the member |
boolean |
canWrite()
Queries whether we have write access authority to the member |
void |
clearCachedProperties()
Clear the properties (last modified, size, ...) cached in this instance. |
void |
compile(boolean prompt)
Compile the member with the last used compile command for this member type |
static ISeriesMember |
createTempMember(Shell shell,
ISeriesConnection connection,
String libName,
String fileName,
String mbrName,
String[] contents)
Create a temporary source member and populate it with the given contents. |
boolean |
equals(Object obj)
Test if two remote object instances refer to the exact same object |
boolean |
exists()
Queries whether the member exists |
void |
get(String localPath)
Downloads the member from the iSeries server. |
void |
get(String localPath,
String encoding)
Downloads the member from the iSeries server. |
String |
getAbsoluteName()
Return the absolute object name: "library/object(member)" |
ISeriesEditableSrcPhysicalFileMember |
getAccess()
Return an instance of ISeriesEditableSrcPhysicalFileMember for this member, which has a number of useful methods, beyond just opening the member for edit. |
Object |
getAdapter(Class adapterType)
This is the method required by the IAdaptable interface. |
String |
getAttribute()
Return the object's attribute. |
void |
getBasicProperties()
Retrieve the basic properties for this object from the remote system |
IFile |
getCachedCopy()
Return the cached copy of this ISeries member. |
Date |
getChangeDate()
Returns the creation date for this member. |
com.ibm.etools.iseries.comm.interfaces.ISequentialFileReader |
getContentsLineByLine()
Return the contents of the files once it is downloaded, one line at a time. |
com.ibm.etools.iseries.comm.interfaces.ISequentialFileReader |
getContentsLineByLine(boolean transientDownload,
boolean bidiVisual)
Return a reader to access the contents of the member line by line. |
Date |
getCreationDate()
Returns the creation date for this member. |
Date |
getDateCreated()
|
Date |
getDateModified()
|
String |
getDescription()
|
String |
getFile()
|
String |
getFullName()
Return the fully qualified member name: library/object(member) |
char |
getInformationStatus()
|
ISeriesFile |
getISeriesFile(Shell shell)
Return the parent file. |
String |
getLibrary()
|
String |
getLibraryName()
From base class. |
com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock[] |
getLocks()
Retrieve any locks for this member. |
void |
getMemberProperties()
Retrieve properties for this member. |
String |
getName()
|
int |
getNumberOfDeleted()
Returns the number of records for this member. |
int |
getNumberOfRecords()
Returns the number of records deleted |
Date |
getRestoreDate()
Returns the creation date for this member. |
Date |
getSaveDate()
Returns the creation date for this member. |
long |
getSize()
|
int |
getSourceFileCCSID()
This is a specialized method for retrieving the member's CCSID for editing. |
String |
getSourceType()
Return the source type for this memeber |
String |
getSubType()
Return the object's attribute. |
String |
getType()
Return the object's type |
boolean |
isLocked()
Check if the member has any locks on it. |
ISeriesEditableSrcPhysicalFileMember |
open()
Opens this member in the integrated LPEX editor, using the currently active shell |
ISeriesEditableSrcPhysicalFileMember |
open(Shell shell)
Opens this member in the integrated LPEX editor, using a given shell. |
static ISeriesEditableSrcPhysicalFileMember |
open(Shell shell,
ISeriesConnection connection,
String libName,
String fileName,
String mbrName)
Opens a given member member in the integrated LPEX editor. |
void |
put(String localPath)
Uploads the member back to the iSeries server. |
void |
put(String localPath,
String encoding)
Uploads the member back to the iSeries server. |
void |
setDateCreated(Date date)
|
void |
setDateModified(Date date)
|
void |
setDescription(String text)
|
void |
setFile(String file)
|
void |
setInformationStatus(char status)
|
void |
setISeriesFile(ISeriesFile parentFile)
Set the parent ISeriesFile of this object, if we know it. |
void |
setLibrary(String name)
|
void |
setName(String name)
|
void |
setSize(long size)
|
void |
setSubType(String subtype)
|
void |
setType(String type)
|
String |
toString()
Convert to a string. |
void |
writeObjectInfo(PrintWriter writer)
For debugging purposes |
Methods inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper |
---|
checkIsConnected, extractProperty, extractPropertyAsBoolean, extractPropertyAsByte, extractPropertyAsChar, extractPropertyAsInt, getCommandSubSystem, getDataElement, getDataStore, getFileSubSystem, getISeriesConnection, getLastException, getLastRunMessage, getLocalCache, getPropertiesNode, runCommand, setLastException, setLocalCache |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief |
---|
getDescription, getFile, getInformationStatus, getSubType, getType, setDescription, setFile, setInformationStatus, setSubType, setType |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly |
---|
getLibrary, getName, setLibrary, setName, toString |
Field Detail |
public static final String copyright
protected boolean bValue
protected String sValue
protected int iValue
protected long lValue
protected char cValue
protected StringBuffer sbValue
protected Date date
protected com.ibm.etools.systems.dstore.core.model.DataElement deProperties
protected com.ibm.etools.systems.dstore.core.model.DataElement deProperty
protected int year
protected int month
protected int day
protected int hour
protected int minute
protected int second
protected Calendar calendar
protected boolean bBasicPropertiesAvailable
protected boolean bExhaustivePropertiesAvailable
Constructor Detail |
public ISeriesMember(com.ibm.etools.systems.dstore.core.model.DataElement dataelement)
Method Detail |
public String getLibraryName()
Return the library containing this remote QSYS file system object
getLibraryName
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
getLibraryName
in class ISeriesDataElementWrapper
public Object getAdapter(Class adapterType)
ISeriesDataElementWrapper
By default this defers to the getAdapter method of the contained DataElement
getAdapter
in interface IAdaptable
getAdapter
in class ISeriesDataElementWrapper
IAdaptable.getAdapter(Class)
public boolean exists() throws com.ibm.etools.systems.core.messages.SystemMessageException
exists
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
com.ibm.etools.systems.core.messages.SystemMessageException
public int getSourceFileCCSID() throws com.ibm.etools.systems.core.messages.SystemMessageException
getSourceFileCCSID
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean canWrite() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean canRead() throws com.ibm.etools.systems.core.messages.SystemMessageException
canRead
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isLocked() throws com.ibm.etools.systems.core.messages.SystemMessageException
isLocked
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock[] getLocks() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String getFullName()
getFullName
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
public String getAbsoluteName()
getAbsoluteName
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
getAbsoluteName
in class ISeriesDataElementWrapper
public String getSourceType()
getSourceType
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
public ISeriesFile getISeriesFile(Shell shell)
public void setISeriesFile(ISeriesFile parentFile)
public void getMemberProperties() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public Date getCreationDate() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public Date getChangeDate() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public Date getSaveDate() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public Date getRestoreDate() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public int getNumberOfDeleted() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public int getNumberOfRecords() throws com.ibm.etools.systems.core.messages.SystemMessageException
getNumberOfRecords
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
com.ibm.etools.systems.core.messages.SystemMessageException
public void get(String localPath) throws ISeriesEncapsulatedReturnCodeException, ISeriesEncapsulatedException, com.ibm.etools.systems.core.messages.SystemMessageException
localPath
- the local path where the member will be stored. This must be an absolute path.
ISeriesEncapsulatedReturnCodeException
ISeriesEncapsulatedException
com.ibm.etools.systems.core.messages.SystemMessageException
public void get(String localPath, String encoding) throws ISeriesEncapsulatedReturnCodeException, ISeriesEncapsulatedException, com.ibm.etools.systems.core.messages.SystemMessageException
localPath
- the local path where the member will be stored. This must be an absolute path.encoding
- the encoding.
ISeriesEncapsulatedReturnCodeException
ISeriesEncapsulatedException
com.ibm.etools.systems.core.messages.SystemMessageException
public IFile getCachedCopy() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public void put(String localPath) throws ISeriesEncapsulatedReturnCodeException, ISeriesEncapsulatedException, com.ibm.etools.systems.core.messages.SystemMessageException
localPath
- the local path where the member is stored. This must be an absolute path.
ISeriesEncapsulatedReturnCodeException
ISeriesEncapsulatedException
com.ibm.etools.systems.core.messages.SystemMessageException
public void put(String localPath, String encoding) throws ISeriesEncapsulatedReturnCodeException, ISeriesEncapsulatedException, com.ibm.etools.systems.core.messages.SystemMessageException
localPath
- the local path where the member is stored. This must be an absolute path.encoding
- the encoding.
ISeriesEncapsulatedReturnCodeException
ISeriesEncapsulatedException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesEditableSrcPhysicalFileMember getAccess() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesEditableSrcPhysicalFileMember open() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesEditableSrcPhysicalFileMember browse() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesEditableSrcPhysicalFileMember open(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesEditableSrcPhysicalFileMember browse(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public static ISeriesEditableSrcPhysicalFileMember open(Shell shell, ISeriesConnection connection, String libName, String fileName, String mbrName) throws com.ibm.etools.systems.core.messages.SystemMessageException
shell
- The shell needed to host the logon prompt dialog, if needed.
Can be null, in which case the currently active workbench shell is used.connection
- An ISeriesConnection object. If you only have a SystemConnection object,
then use the static getConnection(SystemConnection) method in ISeriesConnectionlibName
- Library containing the file containing the memberfileName
- File containing the membermbrName
- Name of the member to open
com.ibm.etools.systems.core.messages.SystemMessageException
public static ISeriesEditableSrcPhysicalFileMember browse(Shell shell, ISeriesConnection connection, String libName, String fileName, String mbrName) throws com.ibm.etools.systems.core.messages.SystemMessageException
shell
- The shell needed to host the logon prompt dialog, if needed.
Can be null, in which case the currently active workbench shell is used.connection
- An ISeriesConnection object. If you only have a SystemConnection object,
then use the static getConnection(SystemConnection) method in ISeriesConnectionlibName
- Library containing the file containing the memberfileName
- File containing the membermbrName
- Name of the member to open
com.ibm.etools.systems.core.messages.SystemMessageException
public static ISeriesMember createTempMember(Shell shell, ISeriesConnection connection, String libName, String fileName, String mbrName, String[] contents) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- if an error occurs while performing any operation. Wraps the remote system messagepublic void compile(boolean prompt)
public com.ibm.etools.iseries.comm.interfaces.ISequentialFileReader getContentsLineByLine() throws Exception
getContentsLineByLine
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Exception
IISeriesMember.getContentsLineByLine()
public com.ibm.etools.iseries.comm.interfaces.ISequentialFileReader getContentsLineByLine(boolean transientDownload, boolean bidiVisual) throws Exception
getContentsLineByLine
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
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.
Exception
public void getBasicProperties()
public void clearCachedProperties()
public void setDateModified(Date date)
setDateModified
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
public void setDateCreated(Date date)
setDateCreated
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
public void setSize(long size)
setSize
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
public Date getDateCreated()
getDateCreated
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
public Date getDateModified()
getDateModified
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
public long getSize()
getSize
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
public void writeObjectInfo(PrintWriter writer)
writeObjectInfo
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
IISeriesHostObjectNameOnly#writeObjectInfo(PrintWriter)
public void setFile(String file)
setFile
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.setFile(String)
public void setType(String type)
setType
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.setType(String)
public void setSubType(String subtype)
setSubType
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.setSubType(String)
public void setInformationStatus(char status)
setInformationStatus
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.setInformationStatus(char)
public void setDescription(String text)
setDescription
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.setDescription(String)
public void setName(String name)
setName
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
IISeriesHostObjectNameOnly#setName(String)
public void setLibrary(String name)
setLibrary
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
IISeriesHostObjectNameOnly#setLibrary(String)
public String getName()
getName
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
IISeriesHostObjectNameOnly#getName()
public String getLibrary()
getLibrary
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
IISeriesHostObjectNameOnly#getLibrary()
public String getFile()
getFile
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.getFile()
public String getType()
getType
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.getType()
public String getSubType()
getSubType
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.getSubType()
public String getAttribute()
ISeriesHostObjectBriefWrapper.getType()
public String getDescription()
getDescription
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.getDescription()
public char getInformationStatus()
getInformationStatus
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
IISeriesHostObjectBrief.getInformationStatus()
public String toString()
toString
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
public boolean equals(Object obj)
Object.equals(Object)
|
iSeries Remote Systems v6.0.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |