All Classes

Class	Description
APIConnectionException	Exception used to indicate that a connection failure has occurred when trying to connect with the IntegrationPoint.
APIError	Error indicating that a general API failure has occurred.
APIException	General exception indicating something failed in the API.
APIExceptionContainer	Container which can throw an APIException.
APIExceptionFactory	Factory used to construct APIException instances.
APIInternalError	Error indicating that a fatal error occured somewhere in the API classes, generally during the Response hierarchy creation.
APIOutOfMemoryError	Error indicating that an java.lang.OutOfMemoryError occurred on the IntegrationPoint.
APIVersion	Utility class to maintain a fixed format for API version representation.
APIViewer	Class used for testing API commands.
APIWarningException
ApplicationConnectionException	Exception used to indicate that an error occurred while initiating a connection with the Integrity Server through the IntegrationPoint.
ApplicationException	Generic top-level exception indicating an error occurred while processing a command for a given application.
ApplicationInternalException	Exception indicating an internal error occurred while executing a command.
ApplicationOutOfMemoryException	Exception indicating that the IntegrationPoint ran into an java.lang.OutOfMemoryError while executing a command.
ApplicationRuntimeException	Top-level exception indicating an error occurred on the IntegrationPoint while running a command.
Base64	Routines for encoding and decoding objects using the base64 encoding.
BinaryContents	Routines for encoding and decoding objects into known API exportable formats.
CmdRunner	Interface for the CmdRunner object.
CmdRunnerCreator	Interface used to model an environment in which a collection of CmdRunner instances can be created.
Command	Class used to represent a command.
CommandAlreadyRunningException	Exception indicating that a CmdRunner object is already in use and cannot be used to run another command without first interrupting it.
CommandCancelledException	Exception indicating that a command has been cancelled due to a failed pre-condition, or because the user has cancelled the command.
CommandException	Generic exception indicating that the command failed to execute successfully.
CommandOptions	The Options available to the Integration Command Extension.
CommandSelection	The Selection(s) available to the Integration Command Extension.
ConnectionNotSecureException	Exception used to indicate that a SSOSession is being created on a IntegrationPoint that does not use a secure communication protocol.
EscapedStringTokenizer	A class that works like StringTokenizer with additional responsibilities: Ignores escaped delimiter characters while tokenizing.
Field	Interface used to represent a field, which is a name/value pair in a given Item or WorkItem.
FieldContainer	Interface used to access Field objects found in the Response hierarchy.
FileOption	Class representing the concept of a CLI option but for a remote file, which takes the form of: --<option name>=<value>
GenerateAPIStats
GenericCommandHandler	Class used for testing API commands.
HttpClientLogAdapter	An adapter for the Common Logging API that directs log output from HttpClient to the API log.
ICLaunchException	Exception thrown in native code when the Windchill RV&S Client is prevented from being started by the user settings.
ICModelTypeName	Enumerated definition of the constants that are to be used to represent the supported Work Item types.
IMModelTypeName	Enumerated definition of the constants that are to be used to represent the supported Work Item types.
IncompatibleVersionException	Exception indicating that the IntegrationPoint does not support the version of the API that is attempting to communicate with it.
IntegrationCommand	Interface for an Integration Command Extension.
IntegrationPoint	Interface used to model the point of entry for an integration.
IntegrationPointFactory	Factory for IntegrationPoint objects.
IntegrationVersionRequest	Interface representing all objects that have an expectations that API command calls (requests) will be made under a specific API version.
InternalException	Exception thrown due to an internal error while executing the command.
InterruptedException	Exception thrown when trying to use a Response object after it has been interrupted.
InvalidCommandOptionException	Exception indicating that an invalid option was used with a command being executed.
InvalidCommandRunnerStateException	Exception indicating that the CmdRunner cannot be used to execute commands.
InvalidCommandSelectionException	Exception used to indicate that an invalid selection was used with a command being executed.
InvalidHostException	Exception indicating that an invalid value for the --hostname option was used with a command being executed.
InvalidIntegrationPointException	Exception used to indicate that the IntegrationPoint details are invalid.
InvalidItemException	Exception indicating that there is a semantic (or application syntactic) failure to validate or convert a setting or selection element into the required and corresponding application item.
InvalidTokenConnectFailedException	Exception used to indicate that a connection failure has occurred due to an invalid or expired token when trying to connect with the IntegrationPoint using delegated authorization.
InvalidTokenExecutionIncompleteException	Exception used to indicate that a SSOCmdRunner could not complete execution due to premature token expiry.
Item	Interface used to access an Item instance found in the Response hierarchy.
ItemAlreadyExistsException	Exception indicating that a duplicate item has been found while executing a command.
ItemException	Top level exception indicating that the IntegrationPoint ran into an error processing an Item while executing a command.
ItemList	Interface used to access the container class used to hold a group of Item objects.
ItemModificationException	Exception indicating that a modification to an item failed while the IntegrationPoint was executing a command.
ItemNotFoundException	Exception indicating that an item was not found while executing a command.
MKSLogger	Class used for logging.
MultiValue	Class representing the concept of a CLI multi-valued value, similar to the --fields= option on some CLI options.
NoCredentialsException	Exception indicating that credentials were missing or invalid while attemping to establish a connection to the Integrity Server.
Option	Class representing the concept of a CLI option, which takes the form of: --<option name>=<value>
OptionList	Class used as a container for a group of Option objects.
PermissionException	Exception used to indicate that a command could not be executed due to lack of permissions for the user.
Queue	A simple first-in, first-out queue, avoiding the overhead of a Vector or the double-linked java.util.LinkedList (also supports JDK 1.1).
Response	Interface to the root object in the Response hierarchy that is created by executing a command through the API.
ResponseUtil	Class used for outputting a constructed Response object to a java.io.PrintStream or a java.io.PrintWriter.
ResponseWriter	ResponseWriter provides the Integration Command Extension a controlled means of producing a well-formed API response.
Result	Interface used to model access to a Result object constructed as part of the Response hierarchy.
SelectionList	Class used to contain a list of String objects representing the selection to pass to the Command to be executed.
Session	Interface used to model a user application session.
SIModelTypeName	Enumerated definition of the constants that are to be used to represent the supported Work Item types.
SimpleIntegrationCommand	Base class for building an Integration Command Extension.
SSOCmdRunner	Interface for the SSOCmdRunner object.
SSOCmdRunnerCreator	Interface used to model an environment in which a collection of SSOCmdRunner instances can be created.
SSOSession	Interface used to model a user application SSOSession.
SubRoutine	Interface to a SubRoutine object in the Response hierarchy.
SubRoutineContainer	Interface used to identify the various methods used for accessing a SubRoutine object.
SubRoutineIterator	Interface used to iterate over a list of SubRoutine objects.
UnknownCommandException	Exception indicating that the command to be executed is invalid/unknown to the application.
UnknownException	Top level exception indicating that an unknown error occured while executing a command.
UnsupportedApplicationException	Exception indicating the application is unknown/invalid.
UnsupportedFunctionException	Exception indicating that an attempt to execute a command feature that is unsupported in the API (such as command interaction; --nobatch) occurred.
UnsupportedVersionException	Exception indicating that the API versiion is not compatible with the IntegrationPoint.
UtilModelType
ValueList	Interface used to hold a set of values that will be stored in a Field object.
VersionedIntegrationCommand	Interface for a versioned Integration Command Extension that indicates to the hosting IntegrationPoint (Windchill RV&S Client or Server) the preferred API version under which to run API commands.
VersionNumber	Interface used to represent a caller/request version number.
WorkItem	Interface used to give you access to a WorkItem that is part of the response from a call to the API.
WorkItemContainer	Interface used to identify the various methods used for accessing WorkItem objects.
WorkItemIterator	Interface used to iterate over a list of WorkItem objects.