iSeries Remote Systems
v6.0.0

com.ibm.etools.iseries.core.ui.view
Class ISeriesMessageAdapter

java.lang.Object
  extended bycom.ibm.etools.systems.core.ui.view.AbstractSystemViewAdapter
      extended bycom.ibm.etools.iseries.core.ui.view.ISeriesBaseAdapter
          extended bycom.ibm.etools.iseries.core.ui.view.ISeriesDataElementAdapter
              extended bycom.ibm.etools.iseries.core.ui.view.ISeriesMessageAdapter
All Implemented Interfaces:
IActionFilter, IBasicPropertyConstants, IDeferredWorkbenchAdapter, IPropertySource, com.ibm.etools.systems.subsystems.IRemoteObjectIdentifier, ISeriesDataStoreConstants, com.ibm.etools.systems.core.ui.view.ISystemDragDropAdapter, com.ibm.etools.systems.core.ui.view.ISystemPropertyConstants, com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter, com.ibm.etools.systems.core.ui.view.ISystemViewActionFilter, com.ibm.etools.systems.core.ui.view.ISystemViewElementAdapter, IWorkbenchAdapter

public class ISeriesMessageAdapter
extends ISeriesDataElementAdapter

Adapter for messages in a message queue, as opposed to message descriptions in a message file.


Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.iseries.core.ui.view.ISeriesDataElementAdapter
copyright
 
Fields inherited from class com.ibm.etools.systems.core.ui.view.AbstractSystemViewAdapter
_lastResults, _lastSelected, canceledObject, EMPTY_STRING_LIST, emptyList, errorObject, filterString, MEMENTO_DELIM, MSG_SUB_PREFIX, MSG_SUB1, MSG_SUB2, msgList, nullObject, propertySourceInput, shell, viewer
 
Fields inherited from interface com.ibm.etools.iseries.core.dstore.common.ISeriesDataStoreConstants
ABSTRACT_FILTER_DESCRIPTOR, ABSTRACT_NATIVE_FSO_DESCRIPTOR, API_ERROR, API_ERROR_DESCRIPTOR, API_OK, API_PTF_MISSING, API_RESULT_DESCRIPTOR, API_RETURN_CODE, AUTHORITY_LIST_NODE, AUTHORITY_NODE, BATCHCOMMAND_DESCRIPTOR, C_GET_EDIT_CCSID, C_LDA_READ, C_LDA_WRITE, C_USER_PREFERENCES_DIRECTORY, CCSID_DESCRIPTOR, CDRA_INFO, CHECK_AUTHORITY_COMMAND, CLEAR_LOCAL_CACHE, CMD_DEBUG_RELEASE_APPLICATION, CMD_DEBUG_SPAWN_AND_HOLD, CMD_GET_DEBUG_ROUTER_PORT, CMD_IJOB_ASSOCIATE, CMD_IJOB_RELEASE, CMD_IJOB_RUNPGM, CMD_MULTI_SPAWNFAIL, CMD_MULTI_SPAWNSUCC, CMD_RUNBATCHCOMMAND, CMD_RUNBATCHCOMMAND_NOHELP, CMD_RUNCOMMAND, CMD_RUNCOMMAND_MULTITHREADED, CMD_RUNCOMMAND_MULTITHREADED_NOHELP, CMD_RUNCOMMAND_NOHELP, COMM_SERVER_INFORMATION, COMMAND_DESCRIPTOR, COMMAND_FILTER_DESCRIPTOR, COMMAND_MINER, COMMAND_MINER_ROOT_ELEMENT, COMMAND_QUERY_DB_FIELDS, COMMAND_QUERY_DB_KEYS, COMMAND_QUERY_DSPF_ALL, COMMAND_QUERY_MODULE_LIST, COMMAND_QUERY_PROCEDURE_LIST, CREATE_EDIT_MASK, CURRENT_WORKING_DIR, CURRENT_WORKING_DIR_DESCRIPTOR, DBFIELD_ALIAS, DBFIELD_ALLOC_LENGTH, DBFIELD_ALWNUL, DBFIELD_CCSID_SPECIFIED, DBFIELD_COLHEAD1, DBFIELD_COLHEAD2, DBFIELD_COLHEAD3, DBFIELD_DATA_CCSID, DBFIELD_DATTIMFMT, DBFIELD_DATTIMSEP, DBFIELD_DBCS_ALTTYPE, DBFIELD_DBCS_COLHEAD, DBFIELD_DBCS_TEXTDESC, DBFIELD_DBCS_VALCHECK, DBFIELD_DECPOS, DBFIELD_DESCRIPTION, DBFIELD_DIGITS, DBFIELD_DISPLAY_LEN_FLAG, DBFIELD_DISPLAY_LENGTH, DBFIELD_DTFLAGS, DBFIELD_EDITCODE, DBFIELD_EDITCODE_SYMBOL, DBFIELD_EDITWORD, DBFIELD_ENCODING_SCHEME, DBFIELD_GENERIC_KEY_COUNT, DBFIELD_INBUF, DBFIELD_INTNAME, DBFIELD_KEYFIELD_ATTRS, DBFIELD_LENGTH, DBFIELD_MAXKEYLEN, DBFIELD_MIN_DISPLAY_LEN_FLAG, DBFIELD_NUMDBCS, DBFIELD_OPERATOR, DBFIELD_OUTBUF, DBFIELD_REF_FIELD, DBFIELD_REFSHIFT, DBFIELD_SST_END, DBFIELD_SST_START, DBFIELD_TYPE, DBFIELD_UCS2_CONVERT_FLAG, DBFIELD_USAGE, DBFIELD_VARLENGTH, DEBUG_HELD_JOB_DESCRIPTOR, DOWNLOAD_RESULT_AS400_SECURITY_EXCEPTION, DSPFFD_INBUF, DSPFFD_OUTBUF, EDCODE_CURSYM, EDCODE_DATESEP, EDCODE_DECSEP, EDCODE_JOBDESC, EDCODE_JOBDESCLIB, EDCODE_SYSDATE, EDCODE_TIMESEP, EDCODE_USERID, EDIT_CODE_DESCRIPTOR, EDIT_CODE_INFORMATION, EDIT_CODE_QUERY, EDIT_DESCRIPTION, EDIT_MASK_DESCRIPTOR, EDIT_MASK_INFO, EDTD_DECCHAR, EDTD_FILLCHAR, EDTD_FLOATSTR, EDTD_FRACTION_MASK, EDTD_INTMASK, EDTD_LEFTCHAR, EDTD_NEGCHAR, EDTD_POSCHAR, EDTD_RIGHTCHAR, EDTD_ZEROVAL, EDTM_RECLEN, ENVVAR_DESCRIPTOR, ENVVAR_INFO, ERROR_DESCRIPTOR, EVENTSFILE_DESCRIPTOR, FIELD_DESCRIPTOR, FIELD_LIST_NODE, FIELD_PROPERTIES_NODE, FILE_ACCPATHTYPE, FILE_ALTSEQ, FILE_BASEDONCOUNT, FILE_BASEDONFILES, FILE_DESCRIPTOR, FILE_DYNSEL, FILE_IGCFIELD, FILE_IGCLITERAL, FILE_JFILE, FILE_KEYACCESS, FILE_LANGID, FILE_OVERRIDE_INFO, FILE_OVERRIDE_SOURCE_DESCRIPTOR, FILE_OVERRIDE_TARGET_DESCRIPTOR, FILE_PROPERTIES_NODE, FILE_SELECTOMITLF, FILE_SRCFILE, IFS_FILE_FILTER_OBJECT, IFS_FILESYSTEM_MINER, IFS_FILTER_DESCRIPTOR, IFS_FOLDER_FILTER_OBJECT, IJOB_DATAQ_DESCRIPTOR, ISERIES_PROGRAM_DESCRIPTOR, JOB_DESCRIPTOR, JOB_FILTER_DESCRIPTOR, JOB_MINER, JOB_MINER_LOG_ELEMENT, JOB_MINER_ROOT_ELEMENT, JOB_PROPERTY_DESCRIPTOR, JOB_PROPERTY1_ELEMENT, JOB_PROPERTY2_ELEMENT, JOB_PROPERTY3_ELEMENT, JOB_PROPERTYINT_ELEMENT, JOBCMD_CHGJOB, JOBCMD_DSPJOBLOG, JOBCMD_ENDJOB, JOBCMD_ENDJOB_IMMED, JOBCMD_HOLDJOB, JOBCMD_QRYJOB_ALL_PROPERTIES, JOBCMD_QRYJOB_PROPERTY, JOBCMD_QRYJOB_PROPERTYP2, JOBCMD_QRYJOB_PROPERTYP3, JOBCMD_QRYJOB_PROPERTYPINT, JOBCMD_RELEASEJOB, JOBFILTERCMD_QUERY, JOBNAME_DESCRIPTOR, JOBPROP_ACCTCODE, JOBPROP_ACTIVESTATUS, JOBPROP_AUXIO, JOBPROP_BREAKMSGHDL, JOBPROP_CCSID, JOBPROP_CNTRYID, JOBPROP_CTLDENDREQ, JOBPROP_CURRSYSPOOL, JOBPROP_CURRUSER, JOBPROP_DATE_ENTERED, JOBPROP_DATE_STARTED, JOBPROP_DATEFMT, JOBPROP_DATESEP, JOBPROP_DBCSCAP, JOBPROP_DECFMT, JOBPROP_DESCRIPTION, JOBPROP_DEVRCYACT, JOBPROP_DFTCCSID, JOBPROP_ENDSEV, JOBPROP_INQMSGRPLY, JOBPROP_ITRANS, JOBPROP_KEEPDDMACT, JOBPROP_LANGID, JOBPROP_LOGCLP, JOBPROP_LOGLVL, JOBPROP_LOGSEV, JOBPROP_LOGTXT, JOBPROP_MAXCPU, JOBPROP_MAXTMPSTOR, JOBPROP_MSGQACT, JOBPROP_MSGQMAX, JOBPROP_OUTQ, JOBPROP_OUTQ_PTY, JOBPROP_PGMRC, JOBPROP_PRODRC, JOBPROP_PRTDEV, JOBPROP_PRTKEYFMT, JOBPROP_PRTTXT, JOBPROP_PURGE, JOBPROP_ROUTING, JOBPROP_RUNPTY, JOBPROP_SORTTAB, JOBPROP_SPECENV, JOBPROP_STATUSMSGHDL, JOBPROP_SUBMITNAME, JOBPROP_SUBMITNUMBER, JOBPROP_SUBMITUSER, JOBPROP_SUBSYSTEM, JOBPROP_SUBTYPE, JOBPROP_SWITCHES, JOBPROP_SYSPOOL, JOBPROP_THREADS, JOBPROP_TIMESEP, JOBPROP_TIMESLICE, JOBPROP_TIMESLICEPOOL, JOBPROP_TOTRESPTIME, JOBPROP_TYPE, JOBPROP_USEDCPU, JOBPROP_USEDTMPSTOR, JOBPROP_USERRC, JOBPROP_WAITTIME, KEYFIELD_LIST_NODE, KEYWORD_DESCRIPTOR, LDA_READ_EXCEPTION_DESCRIPTOR, LDA_READ_LIBRARY_NAME_DESCRIPTOR, LDA_READ_MEMBER_NAME_DESCRIPTOR, LDA_READ_NO_OUTPUT_DESCRIPTOR, LDA_WRITE_CCSID_DESCRIPTOR, LDA_WRITE_EXCEPTION_DESCRIPTOR, LDA_WRITE_LENGTH_DESCRIPTOR, LIB_FILTER_DESCRIPTOR, LIB_FILTER_STR_DESCRIPTOR, LIBRARY_DESCRIPTOR, LIBRARY_PROPERTIES_NODE, LIST_OBJ_LOCKS_COMMAND, MBR_FILTER_DESCRIPTOR, MBR_FILTER_STR_DESCRIPTOR, MEMBER_CHANGE_TIMESTAMP, MEMBER_CREATION_TIMESTAMP, MEMBER_DESCRIPTOR, MEMBER_NUMBER_OF_DELETED, MEMBER_NUMBER_OF_RECORDS, MEMBER_PROPERTIES_NODE, MEMBER_RESTOTE_TIMESTAMP, MEMBER_SAVE_TIMESTAMP, MESSAGE_DESCRIPTOR, MESSAGE_FILE_DESCRIPTOR, MESSAGED_DESCRIPTOR, MODULE_DESCRIPTOR, MODULE_INTERNAL_DESCRIPTOR, MODULE_LANGID, MODULE_LIST_NODE, MODULE_PROPERTIES_NODE, MSGD_STRUCTURE_NODE, NATIVE_FILESYSTEM_MINER, NETINT_DESCRIPTOR, NETINT_LIST_NODE, NETINT_QUERY, NETWORK_ERROR_DESCRIPTOR, OBJ_FILTER_DESCRIPTOR, OBJ_FILTER_STR_DESCRIPTOR, OBJECT_DESCRIPTOR, OBJECT_PROPERTIES_NODE, PGM_DEBUGGABLE, PGM_OPM, PROCEDURE_DESCRIPTOR, PROCEDURE_LIST_NODE, PROGRAM_DESCRIPTOR, PROPERTY_DESCRIPTOR, QSYS_DESCRIPTOR, QUERY_CURRENT_WORKING_DIR, QUERY_DEVICE_RECORDS, QUERY_ENCODING_SCHEME, QUERY_ENV_VAR, QUERY_FIELD_LIST, QUERY_FILE_PROPERTIES, QUERY_MEMBER_PROPERTIES, QUERY_MESSAGE_DESCRIPTORS_COMMAND, QUERY_RECORD_LIST, QUERY_RECORD_PROPERTIES, RECORD_BUFFER_SIZE, RECORD_CCSID, RECORD_DESC, RECORD_DESCRIPTOR, RECORD_DEVICE_PROPERTIES, RECORD_FLDCNT, RECORD_HAS_SEP_IND_AREA, RECORD_HAS_START_LINE_NUM, RECORD_ISDBCS, RECORD_LEVELID, RECORD_LIST_NODE, RECORD_LOWEST_RESP_IND, RECORD_PROPERTIES_NODE, RECORD_RECLEN, RECORD_STANDARD_PROPERTIES, RECORD_TYPE, RELATIVE_FILTER_DESCRIPTOR, RESULT_MESSAGES_ELEMENT, RETRIEVE_FILE_OVERRIDE_COMMAND, SERVICE_PROGRAM_DESCRIPTOR, SORT_SEQ_TABLE, SORT_SEQ_TABLE_INFO, SPECIAL_FILTER_DESCRIPTOR, SQL_COLERROR, SQL_COLFIRSTBYTE, SQL_COLLASTBYTE, SQL_DESCRIPTOR, SQL_MSGFILE, SQL_MSGID, SQL_MSGLIB, SQL_MSGREPLACELEN, SQL_MSGREPLACETEXT, SQL_NUMSTMT, SQL_RECERORR, SQL_RECFIRSTBYTE, SQL_RECLASTBYTE, SQL_RETINFOLEN, SQL_STATE, SQL_SYNTAX_CHECK, SQL_SYNTAX_CHECK_INFO, SST_BYTESAVAIL, SST_BYTESRETURN, SST_COUNTRYID, SST_JOBCCSID, SST_LANGID, SST_QUERY, SST_SSTLIB, SST_SSTNAME, SST_SUBSITUTION, SST_TABLE, SST_TABLECCSID, SST_TABLELIB, SST_TABLENAME, SST_WEIGHT, STRUCTURE_NODE_DESCRIPTOR, SYSTEM_INFORMATION, SYSTEM_PROPERTY_DESCRIPTOR, SYSTEM_QIGC, SYSTEM_VRM, TABLE_DESCRIPTOR
 
Fields inherited from interface com.ibm.etools.systems.core.ui.view.ISystemViewElementAdapter
noActions
 
Fields inherited from interface com.ibm.etools.systems.core.ui.view.ISystemPropertyConstants
P_ARCHIVE_COMMENT, P_ARCHIVE_EXPANDEDSIZE, P_CCSID, P_COMMAND, P_COMMENT, P_COMPILETYPE_TYPES, P_DEFAULTUSERID, P_DESCRIPTION, P_ENVLIST, P_ERROR, P_ERROR_FILENAME, P_ERROR_LINENO, P_FILE_CANONICAL_PATH, P_FILE_CLASSIFICATION, P_FILE_HIDDEN, P_FILE_LASTMODIFIED, P_FILE_PATH, P_FILE_READABLE, P_FILE_READONLY, P_FILE_SIZE, P_FILE_WRITABLE, P_FILTER, P_FILTERS, P_FILTERSTRING, P_FILTERSTRINGS, P_FILTERSTRINGS_COUNT, P_HAS_CHILDREN, P_HOSTNAME, P_IS_ACTIVE, P_IS_CONNECTED, P_IS_CONNECTION_PRIVATE, P_NBRCHILDREN, P_NEWNAME, P_OK, P_ORIGIN, P_PARENT_FILTER, P_PARENT_FILTERPOOL, P_PASSWORD, P_PORT, P_PREFIX, P_PROFILE, P_RELATED_CONNECTION, P_SEARCH_LINE, P_SHELL_CONTEXT, P_SHELL_STATUS, P_SYSTEMTYPE, P_TYPE, P_USERACTION_DOMAIN, P_USERID, P_VENDOR, P_VIRTUAL_COMMENT, P_VIRTUAL_COMPRESSEDSIZE, P_VIRTUAL_COMPRESSIONMETHOD, P_VIRTUAL_COMPRESSIONRATIO, P_VRM
 
Fields inherited from interface org.eclipse.jface.viewers.IBasicPropertyConstants
P_CHILDREN, P_IMAGE, P_PARENT, P_TEXT
 
Constructor Summary
ISeriesMessageAdapter()
           
 
Method Summary
 void addActions(com.ibm.etools.systems.core.ui.SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup)
          Add additions to popup menu
 boolean canDelete(Object element)
          disable delete
 boolean canRename(Object element)
          disable rename
protected  PropertyDescriptor createPropertyDescriptor(String propertyKey, String rootForLabelAndDescription)
          Create and return a simple string readonly property descriptor
 String getAbsoluteName(Object element)
          Return fully qualified name that uniquely identifies this object within its subsystem
 String getAbsoluteParentName(Object element)
          Return fully qualified name that uniquely identifies this remote object's remote parent within its subsystem
 Object[] getChildren(Object element)
          Return the children of this object.
 String getDescription(Object element)
          Get the description for the selected iSeries object.
static String getID(com.ibm.etools.systems.dstore.core.model.DataElement element)
          Return the ID of this message
 ImageDescriptor getImageDescriptor(Object element)
          Returns an image descriptor for the image.
static int getMessageType(com.ibm.etools.systems.dstore.core.model.DataElement element)
          Return the type of this message, as a int.
static String getMsgHelp(com.ibm.etools.systems.dstore.core.model.DataElement element)
          Return the 2nd level help for this message
static String getMsgText(com.ibm.etools.systems.dstore.core.model.DataElement element)
          Return the first level text of this message
static String getMsgType(com.ibm.etools.systems.dstore.core.model.DataElement element)
          Return translated string describing the type of this message.
 Object getParent(Object element)
           
 IPropertyDescriptor[] getPropertyDescriptors()
          Returns the current collection of property descriptors for connection objects.
 Object getPropertyValue(Object key)
          Returns the current value for the named property.
 Object getRemoteParent(Shell shell, Object element)
          Given a remote object, returns it remote parent object.
 String[] getRemoteParentNamesInUse(Shell shell, Object element)
          Given a remote object, return the unqualified names of the objects contained in that parent.
 String getRemoteSourceType(Object element)
          Return the source type of the selected object.
 String getRemoteSubSubType(Object element)
          Return the untranslated sub-subtype for this object.
 String getRemoteSubType(Object element)
          Return the untranslated subtype of this element.
 String getRemoteType(Object element)
          Return the untranslated type property for this object: "MESSAGE"
 String getRemoteTypeCategory(Object element)
          Return the untranslated type category property for this object: "MESSAGES"
static String getSeverity(com.ibm.etools.systems.dstore.core.model.DataElement element)
          Return the severity of this message.
 String getStatusLineText(Object element)
          Return the string to display in the status line when the given object is selected.
 com.ibm.etools.systems.subsystems.SubSystem getSubSystem(Object element)
           
 String getSubSystemFactoryId(Object element)
          Return the subsystem factory id that owns this remote object
 String getText(Object element)
           
 String getType(Object element)
           
 IPropertyDescriptor[] getUniquePropertyDescriptors()
           
 boolean hasChildren(Object element)
           
protected  IPropertyDescriptor[] internalGetPropertyDescriptors()
          Return our unique property descriptors.
protected  Object internalGetPropertyValue(Object key)
          Return our unique property values Since we override getPropertyDescriptors, we return null from here as its not used.
 boolean refreshRemoteObject(Object oldElement, Object newElement)
          Some view has updated the name or properties of this remote object.
 void setPropertyValue(Object property, Object value)
          Called when user changes property via property sheet.
 boolean showDelete(Object element)
          disable delete
 boolean showOpenViewActions(Object element)
          Return true if we should show the refresh action in the popup for the given element.
 boolean showRefresh(Object element)
          disable refresh
 boolean showRename(Object element)
          disable rename
 
Methods inherited from class com.ibm.etools.iseries.core.ui.view.ISeriesDataElementAdapter
canDrag, canDrop, canEdit, checkForCollision, checkForCollision, checkForCollision, doDrag, doDrop, getCmdSubSystem, getDataElement, getEditableRemoteObject, getFileSubSystem, getFilterStringFor, getIFSFileSubSystem, getISeriesConnection, getJobSubSystem, getSystem, isLibrary, isMember, isObject, isPFObject, isSrcFile, isSrcMember, validateDrop
 
Methods inherited from class com.ibm.etools.iseries.core.ui.view.ISeriesBaseAdapter
supportsUserDefinedActions
 
Methods inherited from class com.ibm.etools.systems.core.ui.view.AbstractSystemViewAdapter
addCommonRemoteActions, addDynamicPopupMenuActions, checkForNull, createSimplePropertyDescriptor, createSimplePropertyDescriptor, doDelete, doDrop, doRename, fetchDeferredChildren, getAdapter, getCancelledMessageObject, getCanonicalNewName, getChildren, getChildrenUsingExpandToFilter, getCurrentTreeView, getDefaultDescriptors, getEditableValue, getEmptyMessageObject, getFailedMessageObject, getFilterString, getFirstSelection, getInput, getInputMementoHandle, getLabel, getMementoHandle, getMementoHandleKey, getName, getNameValidator, getPropertyValue, getRemoteAdapter, getRule, getShell, getSystemFetchOperation, getSystemTree, getTranslatedFalse, getTranslatedNo, getTranslatedNotApplicable, getTranslatedNotAvailable, getTranslatedTrue, getTranslatedYes, getViewer, handleDoubleClick, initMsgObjects, isContainer, isPromptable, isPropertySet, namesAreEqual, resetPropertyValue, saveExpansionState, selectionChanged, setFilterString, setInput, setPropertySourceInput, setShell, setViewer, showGenericShowInTableAction, sub, supportsDeferredQueries, testAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter
getName
 

Field Detail

Copyright

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

ISeriesMessageAdapter

public ISeriesMessageAdapter()
Method Detail

getParent

public Object getParent(Object element)
See Also:
AbstractSystemViewAdapter#getParent(Object)

getType

public String getType(Object element)
See Also:
AbstractSystemViewAdapter#getType(Object)

getText

public String getText(Object element)
Specified by:
getText in interface com.ibm.etools.systems.core.ui.view.ISystemViewElementAdapter
Overrides:
getText in class ISeriesDataElementAdapter
See Also:
AbstractSystemViewAdapter#getText(Object)

getImageDescriptor

public ImageDescriptor getImageDescriptor(Object element)
Returns an image descriptor for the image. More efficient than getting the image.

Parameters:
element - The element for which an image is desired

getStatusLineText

public String getStatusLineText(Object element)
Return the string to display in the status line when the given object is selected. Overrides default. We return ID - SEV - TYPE - 1ST_LEVEL_TEXT

Specified by:
getStatusLineText in interface com.ibm.etools.systems.core.ui.view.ISystemViewElementAdapter
Overrides:
getStatusLineText in class ISeriesBaseAdapter

hasChildren

public boolean hasChildren(Object element)
See Also:
AbstractSystemViewAdapter#hasChildren(Object)

getChildren

public Object[] getChildren(Object element)
Return the children of this object. Return null if children not supported.


addActions

public void addActions(com.ibm.etools.systems.core.ui.SystemMenuManager menu,
                       IStructuredSelection selection,
                       Shell shell,
                       String menuGroup)
Add additions to popup menu


setPropertyValue

public void setPropertyValue(Object property,
                             Object value)
Called when user changes property via property sheet.


getUniquePropertyDescriptors

public IPropertyDescriptor[] getUniquePropertyDescriptors()

getPropertyDescriptors

public IPropertyDescriptor[] getPropertyDescriptors()
Returns the current collection of property descriptors for connection objects. We override this versus using the inherited behavior, as we don't want the usual default properties.

Returns:
an array containing all descriptors.

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor(String propertyKey,
                                                      String rootForLabelAndDescription)
Create and return a simple string readonly property descriptor


internalGetPropertyDescriptors

protected IPropertyDescriptor[] internalGetPropertyDescriptors()
Return our unique property descriptors. Since we override getPropertyDescriptors, we return null from here as its not used.


getPropertyValue

public Object getPropertyValue(Object key)
Returns the current value for the named property. The parent handles P_TEXT and P_TYPE only, and we augment that here. We override this versus using the inherited behavior, as we don't want the usual default properties.

Parameters:
key - the name of the property as named by its property descriptor
Returns:
the current value of the property

internalGetPropertyValue

protected Object internalGetPropertyValue(Object key)
Return our unique property values Since we override getPropertyDescriptors, we return null from here as its not used.


getMsgHelp

public static String getMsgHelp(com.ibm.etools.systems.dstore.core.model.DataElement element)
Return the 2nd level help for this message


getID

public static String getID(com.ibm.etools.systems.dstore.core.model.DataElement element)
Return the ID of this message


getMsgText

public static String getMsgText(com.ibm.etools.systems.dstore.core.model.DataElement element)
Return the first level text of this message


getSeverity

public static String getSeverity(com.ibm.etools.systems.dstore.core.model.DataElement element)
Return the severity of this message. Todo: list the possible severity levels here.


getMessageType

public static int getMessageType(com.ibm.etools.systems.dstore.core.model.DataElement element)
Return the type of this message, as a int. Maps to one of the constants in com.ibm.as400.access.ISeriesMessage in the toolbox.


getMsgType

public static String getMsgType(com.ibm.etools.systems.dstore.core.model.DataElement element)
Return translated string describing the type of this message. Eg, is it completion, diagnostic, informational, inquiry, request, escape or reply.


showDelete

public boolean showDelete(Object element)
disable delete


canDelete

public boolean canDelete(Object element)
disable delete


showRename

public boolean showRename(Object element)
disable rename


canRename

public boolean canRename(Object element)
disable rename


showRefresh

public boolean showRefresh(Object element)
disable refresh


getDescription

public String getDescription(Object element)
Get the description for the selected iSeries object. Used in ISeriesBaseAdapter to show information for selected object, in status line.

Specified by:
getDescription in class ISeriesBaseAdapter

getAbsoluteName

public String getAbsoluteName(Object element)
Return fully qualified name that uniquely identifies this object within its subsystem

Specified by:
getAbsoluteName in interface com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter
Overrides:
getAbsoluteName in class ISeriesDataElementAdapter

getAbsoluteParentName

public String getAbsoluteParentName(Object element)
Return fully qualified name that uniquely identifies this remote object's remote parent within its subsystem


getRemoteTypeCategory

public String getRemoteTypeCategory(Object element)
Return the untranslated type category property for this object: "MESSAGES"

See Also:
com.ibm.etool.iseries.core.IISeriesRemoteTypes

getRemoteType

public String getRemoteType(Object element)
Return the untranslated type property for this object: "MESSAGE"

Specified by:
getRemoteType in interface com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter
Overrides:
getRemoteType in class ISeriesBaseAdapter

getRemoteSubType

public String getRemoteSubType(Object element)
Return the untranslated subtype of this element.

Specified by:
getRemoteSubType in interface com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter
Overrides:
getRemoteSubType in class ISeriesBaseAdapter

getRemoteSubSubType

public String getRemoteSubSubType(Object element)
Return the untranslated sub-subtype for this object.

Specified by:
getRemoteSubSubType in interface com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter
Overrides:
getRemoteSubSubType in class ISeriesBaseAdapter

getRemoteSourceType

public String getRemoteSourceType(Object element)
Return the source type of the selected object. Typically, this only makes sense for compilable source members. For non-compilable remote objects, this typically just returns null.


getSubSystemFactoryId

public String getSubSystemFactoryId(Object element)
Return the subsystem factory id that owns this remote object

Specified by:
getSubSystemFactoryId in interface com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter
Overrides:
getSubSystemFactoryId in class ISeriesBaseAdapter

getSubSystem

public com.ibm.etools.systems.subsystems.SubSystem getSubSystem(Object element)
Specified by:
getSubSystem in interface com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter
Overrides:
getSubSystem in class ISeriesDataElementAdapter
See Also:
ISystemRemoteElementAdapter#getSubSystem(Object)

refreshRemoteObject

public boolean refreshRemoteObject(Object oldElement,
                                   Object newElement)
Some view has updated the name or properties of this remote object. As a result, the remote object's contents need to be refreshed. You are given the old remote object that has old data, and you are given the new remote object that has the new data. For example, on a rename the old object still has the old name attribute while the new object has the new new attribute.

This is called by viewers like SystemView in response to rename and property change events.

Specified by:
refreshRemoteObject in interface com.ibm.etools.systems.core.ui.view.ISystemRemoteElementAdapter
Overrides:
refreshRemoteObject in class ISeriesDataElementAdapter
Parameters:
oldElement - the element that was found in the tree
newElement - the updated element that was passed in the REFRESH_REMOTE event
Returns:
true if you want the viewer that called this to refresh the children of this object, such as is needed on a rename of a folder, say.

getRemoteParent

public Object getRemoteParent(Shell shell,
                              Object element)
                       throws Exception
Given a remote object, returns it remote parent object.

The shell is required in order to set the cursor to a busy state if a remote trip is required.

Returns:
null (not supported)
Throws:
Exception

getRemoteParentNamesInUse

public String[] getRemoteParentNamesInUse(Shell shell,
                                          Object element)
                                   throws Exception
Given a remote object, return the unqualified names of the objects contained in that parent. This is used for testing for uniqueness on a rename operation, for example. Sometimes, it is not enough to just enumerate all the objects in the parent for this purpose, because duplicate names are allowed if the types are different, such as on iSeries. In this case return only the names which should be used to do name-uniqueness validation on a rename operation.

Returns:
empty array (not supported)
Throws:
Exception

showOpenViewActions

public boolean showOpenViewActions(Object element)
Return true if we should show the refresh action in the popup for the given element.


iSeries Remote Systems
v6.0.0

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.