com.ibm.tivoli.maximo.interaction.generate

Class OptionGenerator

java.lang.Object

com.ibm.tivoli.maximo.interaction.generate.OptionGenerator

Direct Known Subclasses:

RecLockOptionGenerator

public class OptionGenerator
extends java.lang.Object

Option Generator.

Constructor Summary

Constructors

Constructor and Description
OptionGenerator()

Method Summary

Modifier and Type	Method and Description
void	addAllAppAuth(java.lang.String appName, java.lang.String sigName, java.lang.String prerequisite, java.lang.String conditionNum, UserInfo userInfo, MXTransaction trans) Grant authorization to groups which have all prerequisite options with the application.
void	addAllAppAuth(java.lang.String appName, java.lang.String sigName, java.lang.String prerequisite, UserInfo userInfo, MXTransaction trans) Grant authorization to groups which have all prerequisite options with the application.
int	addAppToolOption(java.lang.String appName, java.lang.String sigName, java.lang.String imageSource, int preferredSpot, UserInfo userInfo, MXTransaction trans) Make sure the menu option with the given name exists in the application.
void	addMenuOption(java.lang.String appName, java.lang.String sigName, java.lang.String menuType, int preferredSpot, int preferredSubSpot, java.lang.String tabDisplay, java.lang.String imageSource, java.lang.String accessKey, UserInfo userInfo, MXTransaction trans) Make sure the menu option with the given name exists in the application.
void	addMenuOption(java.lang.String appName, java.lang.String sigName, java.lang.String menuType, int preferredSpot, int preferredSubSpot, java.lang.String tabDisplay, java.lang.String imageSource, UserInfo userInfo, MXTransaction trans) Make sure the menu option with the given name exists in the application.
java.lang.String	addOption(java.lang.String appName, java.lang.String interaction, java.lang.String mapOption, MXTransaction trans, UserInfo userInfo, java.util.Vector selected) generates Signature Option and give authorization.
java.lang.String	addOption(java.lang.String appName, java.lang.String interaction, java.lang.String description, UserInfo userInfo, boolean createMenu, MXTransaction trans, java.util.Vector selected, boolean isSilent) Add support for workflow to the application named by this Mbo.
java.lang.String	addSigOption(java.lang.String appName, java.lang.String sigName, java.lang.String sigDesc, java.lang.String alsoGrants, java.lang.String alsoRevokes, java.lang.String prerequisite, UserInfo userInfo, MXTransaction trans) Make sure the SigOption with the given name exists for the application.
java.lang.String	addSigOption(java.lang.String appName, java.lang.String sigName, java.lang.String sigDesc, UserInfo userInfo, MXTransaction trans) Make sure the SigOption with the given name exists for the application.
MboSetRemote	checkMenuOption(java.lang.String appName, java.lang.String sigName, UserInfo userInfo) Make sure the menu option with the given name exists in the application.
MboSetRemote	checkSigOption(java.lang.String appName, java.lang.String sigName, UserInfo userInfo) Make sure the SigOption with the given name exists for the application.
void	deleteOption(java.lang.String appName, java.lang.String optionName, UserInfo userInfo, MXTransaction trans) Delete signature option.
void	includeAppAuth(java.lang.String appName, java.lang.String sigName, java.lang.String conditionNum, UserInfo userInfo, MXTransaction trans, java.util.Set groupNames) Grant authorization for the application option to the list of groups.
void	includeAppAuth(java.lang.String appName, java.lang.String sigName, java.lang.String conditionNum, UserInfo userInfo, MXTransaction trans, java.util.Vector selected) Make sure the users which have read access with the application are given authorization for the sig option.
void	includeAppAuth(java.lang.String appName, java.lang.String sigName, UserInfo userInfo, MXTransaction trans, java.util.Vector selected) Make sure the users which have read access with the application are given authorization for the sig option.
java.lang.String	includeSigOption(java.lang.String interaction, java.lang.String appName, java.lang.String sigName, java.lang.String sigDesc, boolean isSilent, org.jdom2.Document appDocument, UserInfo userInfo, MXTransaction trans, int start) Make sure the SigOption with the given name exists for the application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OptionGenerator

public OptionGenerator()

Method Detail

addOption

public java.lang.String addOption(java.lang.String appName,
                                  java.lang.String interaction,
                                  java.lang.String description,
                                  UserInfo userInfo,
                                  boolean createMenu,
                                  MXTransaction trans,
                                  java.util.Vector selected,
                                  boolean isSilent)
                           throws java.rmi.RemoteException,
                                  MXException

Add support for workflow to the application named by this Mbo. Does nothing if the AddSupport attribute is cleared.

Throws:

java.rmi.RemoteException

MXException

addOption

public java.lang.String addOption(java.lang.String appName,
                                  java.lang.String interaction,
                                  java.lang.String mapOption,
                                  MXTransaction trans,
                                  UserInfo userInfo,
                                  java.util.Vector selected)
                           throws java.rmi.RemoteException,
                                  MXException

generates Signature Option and give authorization.

Parameters:

trans - MX Transaction

mapOption - name of the signature option

Returns:

signature option name

Throws:

MXException

java.rmi.RemoteException

deleteOption

public void deleteOption(java.lang.String appName,
                         java.lang.String optionName,
                         UserInfo userInfo,
                         MXTransaction trans)
                  throws java.rmi.RemoteException,
                         MXException

Delete signature option.

Throws:

java.rmi.RemoteException

MXException

includeSigOption

public java.lang.String includeSigOption(java.lang.String interaction,
                                         java.lang.String appName,
                                         java.lang.String sigName,
                                         java.lang.String sigDesc,
                                         boolean isSilent,
                                         org.jdom2.Document appDocument,
                                         UserInfo userInfo,
                                         MXTransaction trans,
                                         int start)
                                  throws java.rmi.RemoteException,
                                         MXException

Make sure the SigOption with the given name exists for the application.

Parameters:

sigName - name of the option

Throws:

java.rmi.RemoteException

MXException

addSigOption

public java.lang.String addSigOption(java.lang.String appName,
                                     java.lang.String sigName,
                                     java.lang.String sigDesc,
                                     UserInfo userInfo,
                                     MXTransaction trans)
                              throws java.rmi.RemoteException,
                                     MXException

Make sure the SigOption with the given name exists for the application.

Parameters:

sigName - name of the option

Throws:

java.rmi.RemoteException

MXException

addSigOption

public java.lang.String addSigOption(java.lang.String appName,
                                     java.lang.String sigName,
                                     java.lang.String sigDesc,
                                     java.lang.String alsoGrants,
                                     java.lang.String alsoRevokes,
                                     java.lang.String prerequisite,
                                     UserInfo userInfo,
                                     MXTransaction trans)
                              throws java.rmi.RemoteException,
                                     MXException

Make sure the SigOption with the given name exists for the application. If the SigOption does not exist then add it to the transaction. If SigOption does exist then do nothing.

Parameters:

appName - Name of the application

sigName - Name of the option

sigDesc - Description of the option for this application

alsoGrants - List of options to be granted when this option is granted

alsoRevokes - List of options to be revoked when this option is revoked

prerequisite - List of options that must be granted before this option may be granted

userInfo - Current user information

trans - Current transaction to add SigOption too.

Returns:

name of the option added or null if option already exists.

Throws:

java.rmi.RemoteException

MXException

includeAppAuth

public void includeAppAuth(java.lang.String appName,
                           java.lang.String sigName,
                           UserInfo userInfo,
                           MXTransaction trans,
                           java.util.Vector selected)
                    throws java.rmi.RemoteException,
                           MXException

Make sure the users which have read access with the application are given authorization for the sig option. This is done by wiping out any existing authorizations, for the users with read access and building new ones.

Parameters:

sigName -

Throws:

java.rmi.RemoteException

MXException

includeAppAuth

public void includeAppAuth(java.lang.String appName,
                           java.lang.String sigName,
                           java.lang.String conditionNum,
                           UserInfo userInfo,
                           MXTransaction trans,
                           java.util.Vector selected)
                    throws java.rmi.RemoteException,
                           MXException

Make sure the users which have read access with the application are given authorization for the sig option. This is done by wiping out any existing authorizations, for the users with read access and building new ones.

Parameters:

sigName -

Throws:

java.rmi.RemoteException

MXException

includeAppAuth

public void includeAppAuth(java.lang.String appName,
                           java.lang.String sigName,
                           java.lang.String conditionNum,
                           UserInfo userInfo,
                           MXTransaction trans,
                           java.util.Set groupNames)
                    throws java.rmi.RemoteException,
                           MXException

Grant authorization for the application option to the list of groups.

Parameters:

appName - Application Name

sigName - New option

userInfo - User Info

trans - transaction

groupNames - Set of group names

Throws:

java.rmi.RemoteException

MXException

addAllAppAuth

public void addAllAppAuth(java.lang.String appName,
                          java.lang.String sigName,
                          java.lang.String prerequisite,
                          UserInfo userInfo,
                          MXTransaction trans)
                   throws java.rmi.RemoteException,
                          MXException

Grant authorization to groups which have all prerequisite options with the application. If prerequisite is not passed in then default to READ option.

Parameters:

appName - Application Name

sigName - New option name

prerequisite - List of prerequisite options

userInfo - User Info

trans - Transaction to add application authorization too

Throws:

java.rmi.RemoteException

MXException

addAllAppAuth

public void addAllAppAuth(java.lang.String appName,
                          java.lang.String sigName,
                          java.lang.String prerequisite,
                          java.lang.String conditionNum,
                          UserInfo userInfo,
                          MXTransaction trans)
                   throws java.rmi.RemoteException,
                          MXException

Grant authorization to groups which have all prerequisite options with the application. If prerequisite is not passed in then default to READ option.

Parameters:

appName - Application Name

sigName - New option name

prerequisite - List of prerequisite options

userInfo - User Info

trans - Transaction to add application authorization too

Throws:

java.rmi.RemoteException

MXException

addAppToolOption

public int addAppToolOption(java.lang.String appName,
                            java.lang.String sigName,
                            java.lang.String imageSource,
                            int preferredSpot,
                            UserInfo userInfo,
                            MXTransaction trans)
                     throws java.rmi.RemoteException,
                            MXException

Make sure the menu option with the given name exists in the application.

Parameters:

sigName - name of the option

preferredSpot - Where the option wants to be on the sub-menu.

imageSource - Image to use for the menu option

Throws:

java.rmi.RemoteException

MXException

addMenuOption

public void addMenuOption(java.lang.String appName,
                          java.lang.String sigName,
                          java.lang.String menuType,
                          int preferredSpot,
                          int preferredSubSpot,
                          java.lang.String tabDisplay,
                          java.lang.String imageSource,
                          UserInfo userInfo,
                          MXTransaction trans)
                   throws java.rmi.RemoteException,
                          MXException

Make sure the menu option with the given name exists in the application.

Parameters:

sigName - name of the option

preferredSpot - Where the option wants to be on the sub-menu.

imageSource - Image to use for the menu option

Throws:

java.rmi.RemoteException

MXException

addMenuOption

public void addMenuOption(java.lang.String appName,
                          java.lang.String sigName,
                          java.lang.String menuType,
                          int preferredSpot,
                          int preferredSubSpot,
                          java.lang.String tabDisplay,
                          java.lang.String imageSource,
                          java.lang.String accessKey,
                          UserInfo userInfo,
                          MXTransaction trans)
                   throws java.rmi.RemoteException,
                          MXException

Make sure the menu option with the given name exists in the application.

Parameters:

sigName - name of the option

preferredSpot - Where the option wants to be on the sub-menu.

imageSource - Image to use for the menu option

accessKey - Access Key to use for the menu option

Throws:

java.rmi.RemoteException

MXException

checkSigOption

public MboSetRemote checkSigOption(java.lang.String appName,
                                   java.lang.String sigName,
                                   UserInfo userInfo)
                            throws java.rmi.RemoteException,
                                   MXException

Make sure the SigOption with the given name exists for the application.

Parameters:

sigName - name of the option

Throws:

java.rmi.RemoteException

MXException

checkMenuOption

public MboSetRemote checkMenuOption(java.lang.String appName,
                                    java.lang.String sigName,
                                    UserInfo userInfo)
                             throws java.rmi.RemoteException,
                                    MXException

Make sure the menu option with the given name exists in the application.

Parameters:

appName - name of the application

sigName - name of the option

userInfo - user info object.

Throws:

java.rmi.RemoteException

MXException