XPRSglobalenv

java.lang.Object
- com.dashoptimization.XPRSobject
- - com.dashoptimization.XPRSglobalenv

public class XPRSglobalenv
extends XPRSobject

Method Summary

Modifier and Type	Method and Description
`void`	`addMsgHandlerListener(XPRSmsgHandlerListener listener)` Add a listener for the MsgHandlercallback.
`void`	`addMsgHandlerListener(XPRSmsgHandlerListener listener, int priority)` Add the listener for the MsgHandlercallback.
`void`	`addMsgHandlerListener(XPRSmsgHandlerListener listener, java.lang.Object data)` Add the listener for the MsgHandlercallback.
`void`	`addMsgHandlerListener(XPRSmsgHandlerListener listener, java.lang.Object data, int priority)` Add the listener for the MsgHandlercallback.
`static boolean`	`beginLicensing()`
`void`	`destroy()` The Global Environment is destroyed by XPRS.free() so this destroy function does nothing
`static void`	`endLicensing()`
`void`	`featureQuery(java.lang.String FeatureName, IntHolder FeatureStatus)`
`java.lang.String`	`getBanner()`
`void`	`getBanner(StringHolder banner)`
`boolean`	`getCheckedMode()`
`void`	`getCheckedMode(BoolHolder r_checked_mode)`
`int`	`getDaysLeft()`
`void`	`getDaysLeft(IntHolder daysleft)`
`void`	`getDebugMode(IntHolder ifDebugMode)`
`java.lang.String`	`getLastError()` Returns last error message that occurred on this XPRSobject
`java.lang.String`	`getLastError(IntHolder iMsgCode)`
`void`	`getSafeMode(IntHolder ifSafeMode)`
`static java.lang.String`	`getVersion()`
`static void`	`getVersion(StringHolder version)`
`static int`	`license(IntHolder _i1)`
`static int`	`license(IntHolder _i1, StringHolder _c1)`
`void`	`removeMsgHandlerListener()` Removes all MsgHandler listeners from the object.
`void`	`removeMsgHandlerListener(XPRSmsgHandlerListener listener)` Removes the given MsgHandler listener from the object.
`void`	`removeMsgHandlerListener(XPRSmsgHandlerListener listener, java.lang.Object data)` Removes the given MsgHandler listener with the given data value from the object.
`void`	`removeMsgHandlerListeners()` Remove all listeners for the MsgHandler callback
`void`	`setArchConsistency(int ifArchConsistent)`
`void`	`setCheckedMode(boolean checked_mode)`
`void`	`setDebugMode(int ifDebugMode)`
`void`	`setSafeMode(int ifSafeMode)`

Methods inherited from class com.dashoptimization.XPRSobject
addMsgHandlerListener, addMsgHandlerListener, isDestroyed

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

destroy
```
public void destroy()
             throws XPRSexception
```
The Global Environment is destroyed by XPRS.free() so this destroy function does nothing

Specified by:

destroy in class XPRSobject

Throws:

XPRSexception

license

public static int license(IntHolder _i1,
                          StringHolder _c1)
                   throws XPRSexception

Throws:: XPRSexception

license

public static int license(IntHolder _i1)
                   throws XPRSexception

Throws:: XPRSexception

beginLicensing

public static boolean beginLicensing()
                              throws XPRSexception

Throws:: XPRSexception

endLicensing

public static void endLicensing()
                         throws XPRSexception

Throws:: XPRSexception

setCheckedMode

public void setCheckedMode(boolean checked_mode)
                    throws XPRSexception

Throws:: XPRSexception

getCheckedMode

public void getCheckedMode(BoolHolder r_checked_mode)
                    throws XPRSexception

Throws:: XPRSexception

getCheckedMode

public boolean getCheckedMode()
                       throws XPRSexception

Throws:: XPRSexception

getBanner

public void getBanner(StringHolder banner)
               throws XPRSexception

Throws:: XPRSexception

getBanner

public java.lang.String getBanner()
                           throws XPRSexception

Throws:: XPRSexception

getVersion

public static void getVersion(StringHolder version)
                       throws XPRSexception

Throws:: XPRSexception

getVersion

public static java.lang.String getVersion()
                                   throws XPRSexception

Throws:: XPRSexception

getDaysLeft

public void getDaysLeft(IntHolder daysleft)
                 throws XPRSexception

Throws:: XPRSexception

getDaysLeft

public int getDaysLeft()
                throws XPRSexception

Throws:: XPRSexception

featureQuery

public void featureQuery(java.lang.String FeatureName,
                         IntHolder FeatureStatus)
                  throws XPRSexception

Throws:: XPRSexception

setArchConsistency

public void setArchConsistency(int ifArchConsistent)
                        throws XPRSexception

Throws:: XPRSexception

setSafeMode

public void setSafeMode(int ifSafeMode)
                 throws XPRSexception

Throws:: XPRSexception

getSafeMode

public void getSafeMode(IntHolder ifSafeMode)
                 throws XPRSexception

Throws:: XPRSexception

setDebugMode

public void setDebugMode(int ifDebugMode)
                  throws XPRSexception

Throws:: XPRSexception

getDebugMode

public void getDebugMode(IntHolder ifDebugMode)
                  throws XPRSexception

Throws:: XPRSexception

getLastError
```
public java.lang.String getLastError()
                              throws XPRSexception
```
Description copied from class: XPRSobject

Returns last error message that occurred on this XPRSobject

Specified by:

getLastError in class XPRSobject

Throws:

XPRSexception

getLastError

public java.lang.String getLastError(IntHolder iMsgCode)
                              throws XPRSexception

Throws:: XPRSexception

addMsgHandlerListener
```
public void addMsgHandlerListener(XPRSmsgHandlerListener listener)
                           throws XPRSexception
```
Add a listener for the MsgHandlercallback. Note that an object can have multiple MsgHandler listeners.

Specified by:

addMsgHandlerListener in class XPRSobject

Parameters:

listener - The listener to which the event will be dispatched. (If null, all MsgHandler listeners will be removed.)

Throws:

XPRSexception

addMsgHandlerListener
```
public void addMsgHandlerListener(XPRSmsgHandlerListener listener,
                                  java.lang.Object data)
                           throws XPRSexception
```
Add the listener for the MsgHandlercallback. Note that an object can have multiple MsgHandler listeners.

Specified by:

addMsgHandlerListener in class XPRSobject

Parameters:

listener - The listener to which the event will be dispatched. (If null, all MsgHandler listeners will be removed.)

data - An additional object which will be passed down to the callback function

Throws:

XPRSexception

addMsgHandlerListener
```
public void addMsgHandlerListener(XPRSmsgHandlerListener listener,
                                  int priority)
                           throws XPRSexception
```
Add the listener for the MsgHandlercallback. Note that an object can have multiple MsgHandler listeners.

Parameters:

listener - The listener to which the event will be dispatched. (If null, all MsgHandler listeners will be removed.)

priority - Listeners with higher priorities are called first

Throws:

XPRSexception

addMsgHandlerListener
```
public void addMsgHandlerListener(XPRSmsgHandlerListener listener,
                                  java.lang.Object data,
                                  int priority)
                           throws XPRSexception
```
Add the listener for the MsgHandlercallback. Note that an object can have multiple MsgHandler listeners.

Parameters:

listener - The listener to which the event will be dispatched. (If null, all MsgHandler listeners will be removed.)

data - An additional object which will be passed down to the callback function

priority - Listeners with higher priorities are called first

Throws:

XPRSexception

removeMsgHandlerListener

public void removeMsgHandlerListener(XPRSmsgHandlerListener listener)
                              throws XPRSexception

Removes the given MsgHandler listener from the object.

Throws:: XPRSexception

removeMsgHandlerListener

public void removeMsgHandlerListener(XPRSmsgHandlerListener listener,
                                     java.lang.Object data)
                              throws XPRSexception

Removes the given MsgHandler listener with the given data value from the object.

Throws:: XPRSexception

removeMsgHandlerListener
```
public void removeMsgHandlerListener()
                              throws XPRSexception
```
Removes all MsgHandler listeners from the object. @deprecated as of Xpress 7.1, please use removeMsgHandlerListener(XPRSmsgHandlerListener) or removeMsgHandlerListeners()

Specified by:

removeMsgHandlerListener in class XPRSobject

Throws:

XPRSexception

removeMsgHandlerListeners

public void removeMsgHandlerListeners()
                               throws XPRSexception

Remove all listeners for the MsgHandler callback

Throws:: XPRSexception

© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.

Contents

Index

Glossary

Search Results

XPRSglobalenv

Method Summary

Methods inherited from class com.dashoptimization.XPRSobject

Methods inherited from class java.lang.Object

Method Detail

destroy

license

license

beginLicensing

endLicensing

setCheckedMode

getCheckedMode

getCheckedMode

getBanner

getBanner

getVersion

getVersion

getDaysLeft

getDaysLeft

featureQuery

setArchConsistency

setSafeMode

getSafeMode

setDebugMode

getDebugMode

getLastError

getLastError

addMsgHandlerListener

addMsgHandlerListener

addMsgHandlerListener

addMsgHandlerListener

removeMsgHandlerListener

removeMsgHandlerListener

removeMsgHandlerListener

removeMsgHandlerListeners