Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.uda
Class JobUDActionSubsystem

java.lang.Object
  extended by SystemUDActionSubsystem
      extended by com.ibm.etools.iseries.rse.ui.uda.QSYSUDActionSubsystem
          extended by com.ibm.etools.iseries.rse.ui.uda.JobUDActionSubsystem

public class JobUDActionSubsystem
extends QSYSUDActionSubsystem

User Action subclass for managing user actions for Job Subsystem.


Field Summary
static String copyright
           
 
Fields inherited from class com.ibm.etools.iseries.rse.ui.uda.QSYSUDActionSubsystem
ATTR_RUNENV, Copyright, msgs, RUNENV_BATCH, RUNENV_INTERACTIVE, RUNENV_NORMAL, TEMPMBR_FILE, TEMPMBR_LIB
 
Constructor Summary
JobUDActionSubsystem()
          Constructor
 
Method Summary
protected  boolean doActionsMigration(ISystemProfile profile, String oldRelease)
          Overridable method for child classes to do migration of their actions.
protected  boolean doTypesMigration(ISystemProfile profile, String oldRelease)
          Overridable method for child classes to do migration of their types.
 SystemCmdSubstVarList getActionSubstVarList(int actionDomainType)
          Return the list of substitution variables for the given domain type.
protected  int getDomainFromSelection(IStructuredSelection selection)
           
 IHost getHost(Object element)
           
protected  String getNewNodeActionLabel()
          Overridden method from parent, returning the xlated label for the "New" node in the WW actions dialog.
 String getOSType()
           
 String internalGetSubstitutionValue(SystemUDActionElement currentAction, String subvar, Object subvarDE)
          Required override of parent for doing substitutions for our unique variables.
protected  boolean isMatch(Object actionType, Object selectedObject, int domainType)
          Compares a particular file type (not named, but actual scalar/generic type) to a specific user-selected remote object.
 SystemUDActionElement[] primeDefaultActions(SystemUDActionManager udad, ISystemProfile profile)
          Prime the user data with the default actions.
 SystemUDTypeElement[] primeDefaultTypes(SystemUDTypeManager udtd)
          Prime the user data with the default types.
 boolean restoreDefaultAction(SystemUDActionElement element, int domain, String actionName)
          Given this IBM-supplied user action, restore it to its IBM-supplied state.
 boolean restoreDefaultType(SystemUDTypeElement element, int domain, String typeName)
          Given this IBM-supplied named type, restore it to its IBM-supplied state
 boolean supportsDomains()
          Return true if the action/type manager supports domains.
 boolean supportsTypes()
          Return true if actions can be scoped by file types The iSeries job subsystem does not support types
 
Methods inherited from class com.ibm.etools.iseries.rse.ui.uda.QSYSUDActionSubsystem
collectNames, collectNamesQSYS, getAllNamesSubstitutionVariable, getCommandSubsystem, getCustomUDActionEditPane, getNameDelimiter, getRunnableContext, getSubstitutionValue, getWorkingOfflineMode, printTestActionInvokeOnceInformation, promptCommand, run, runCommand
 
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

JobUDActionSubsystem

public JobUDActionSubsystem()
Constructor

Method Detail

getActionSubstVarList

public SystemCmdSubstVarList getActionSubstVarList(int actionDomainType)
Return the list of substitution variables for the given domain type. Called from edit pane in work with dialog. This must be overridden!


doActionsMigration

protected boolean doActionsMigration(ISystemProfile profile,
                                     String oldRelease)
Overridable method for child classes to do migration of their actions. This is called on first load of a document, which has a release stamp other than the current release

Returns:
true if any migration was done. We return false.

doTypesMigration

protected boolean doTypesMigration(ISystemProfile profile,
                                   String oldRelease)
Overridable method for child classes to do migration of their types. This is called on first load of a document, which has a release stamp other than the current release

Returns:
true if any migration was done. We return false.

getNewNodeActionLabel

protected String getNewNodeActionLabel()
Overridden method from parent, returning the xlated label for the "New" node in the WW actions dialog. We return "New Job Action".


supportsTypes

public boolean supportsTypes()
Return true if actions can be scoped by file types The iSeries job subsystem does not support types


supportsDomains

public boolean supportsDomains()
Return true if the action/type manager supports domains. The iSeries job subsystem does not support domains


getDomainFromSelection

protected int getDomainFromSelection(IStructuredSelection selection)

isMatch

protected boolean isMatch(Object actionType,
                          Object selectedObject,
                          int domainType)
Compares a particular file type (not named, but actual scalar/generic type) to a specific user-selected remote object. Returns true if the object's information matches that of the given type

Must be overridden, but only called if supportsTypes() returns true. Else, just return true!

Parameters:
actionType - - an unnamed file type, as in "*.cpp"
selectedObject - - one of the currently selected remote objects
domainType - - integer representation of current domain

internalGetSubstitutionValue

public String internalGetSubstitutionValue(SystemUDActionElement currentAction,
                                           String subvar,
                                           Object subvarDE)
Required override of parent for doing substitutions for our unique variables.


primeDefaultTypes

public SystemUDTypeElement[] primeDefaultTypes(SystemUDTypeManager udtd)
Prime the user data with the default types. Subsystem and profile specific.


primeDefaultActions

public SystemUDActionElement[] primeDefaultActions(SystemUDActionManager udad,
                                                   ISystemProfile profile)
Prime the user data with the default actions. Subsystem and profile specific


restoreDefaultAction

public boolean restoreDefaultAction(SystemUDActionElement element,
                                    int domain,
                                    String actionName)
Given this IBM-supplied user action, restore it to its IBM-supplied state.

Returns:
true if all went well, false if it wasn't restore for some reason

restoreDefaultType

public boolean restoreDefaultType(SystemUDTypeElement element,
                                  int domain,
                                  String typeName)
Given this IBM-supplied named type, restore it to its IBM-supplied state

Returns:
true if all went well, false if it wasn't restore for some reason

getOSType

public String getOSType()
Overrides:
getOSType in class QSYSUDActionSubsystem

getHost

public IHost getHost(Object element)
Specified by:
getHost in class QSYSUDActionSubsystem

Rational Developer for Power Systems Software
V7.6

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