A B C D E F G H I L M N O P Q R S T U V W
All Classes All Packages

G

GENERAL - Static variable in class com.mks.api.util.MKSLogger

Logging category - GENERAL messages.

GenerateAPIStats - Class in com.mks.api.util

generateSubRtns - Variable in class com.mks.api.Command

Flag used to determine if SubRoutines should be generated or not.

GenericCommandHandler - Class in com.mks.api.util

Class used for testing API commands.

GenericCommandHandler() - Constructor for class com.mks.api.util.GenericCommandHandler

getAPIException() - Method in interface com.mks.api.response.APIExceptionContainer

Retrieves any exceptions that may have resulted during the call to the API.

getAPIException() - Method in interface com.mks.api.response.Response

Retrieves any exception that might have resulted during the call to the API.

getAPIExecutionVersion() - Method in class com.mks.api.ext.SimpleIntegrationCommand

Fetches the desired API version to use for executing commands through the local integration point

getAPIExecutionVersion() - Method in interface com.mks.api.ext.VersionedIntegrationCommand

Indicates the preferred API version this command would like to use for execution of its code.

getAPIReleaseVersion() - Static method in class com.mks.api.util.APIVersion

The version under which this API jar was built and released.

getAPIRequestVersion() - Method in class com.mks.api.ext.SimpleIntegrationCommand

Returns the API version of the caller making the request to this Integration Command Extension.

getAPIRequestVersion() - Method in interface com.mks.api.IntegrationVersionRequest

Returns the API version under which commands will be run.

getAPIVersion() - Method in interface com.mks.api.response.Response

The API version associated with this response.

getApp() - Method in class com.mks.api.Command

Retrieves the application name for this command.

getApplicationName() - Method in interface com.mks.api.response.Response

Retrieves the application name for this Response.

getApplicationName() - Method in exception com.mks.api.response.UnsupportedApplicationException

Retrieves the application name that caused the exception.

getAutoReconnect() - Method in interface com.mks.api.Session

Gets the state of the auto-reconnection flag.

getAutoStartIntegrityClient() - Method in interface com.mks.api.IntegrationPoint

Retrieves the flag indicating if the IntegrationPoint should attempt to automatically start the Windchill RV&S Client.

getBoolean() - Method in interface com.mks.api.response.Field

Retrieves the java.lang.Boolean value of the Field.

getBytes() - Method in interface com.mks.api.response.Field

Retrieves the byte[] value of the Field.

getCacheContents() - Method in interface com.mks.api.response.Response

Retrieves the flag indicating that the contents of the Response should be cached.

getCmdRunners() - Method in interface com.mks.api.CmdRunnerCreator

Retrieves the list of CmdRunners created by this CmdRunnerCreator.

getCmdRunners() - Method in interface com.mks.api.fedsso.SSOCmdRunnerCreator

Retrieves the list of SSOCmdRunners created by this SSOCmdRunnerCreator.

getCommand() - Method in exception com.mks.api.response.UnknownCommandException

Retrieves the command name that caused the exception.

getCommandName() - Method in class com.mks.api.Command

Retrieves the name of the command to execute.

getCommandName() - Method in interface com.mks.api.response.Response

Retrieves the name of the command that was executed.

getCommandString() - Method in interface com.mks.api.response.Response

Retrieves the command string that was passed in to the API that generated the Response hierarchy.

getCommonSession() - Method in interface com.mks.api.IntegrationPoint

Retrieves the common Session.

getCommonSession(String, String) - Method in interface com.mks.api.IntegrationPoint

Retrieves the common Session.

getConnectionHostname() - Method in interface com.mks.api.response.Response

Retrieves the hostname for the application connection to the Windchill RV&S Server used by the command that was executed.

getConnectionPort() - Method in interface com.mks.api.response.Response

Retrieves the port for the application connection to the Windchill RV&S Server used by the command that was executed.

getConnectionUsername() - Method in interface com.mks.api.response.Response

Retrieves the username for the application connection to the Windchill RV&S Server used by the command that was executed.

getContentType() - Method in interface com.mks.api.response.Field

Returns the name of the content type for a binary field Additionally, null may be returned if there is no content type specified in the return structure.

getContext() - Method in interface com.mks.api.response.Item

Retrieves the context of the work item.

getContext(String) - Method in interface com.mks.api.response.Item

Get the context value for the specified key.

getContextKeys() - Method in interface com.mks.api.response.Item

Get the keys to which contexts may be associated with.

getDataType() - Method in interface com.mks.api.response.Field

Returns the name of the data type of the field.

getDataType() - Method in interface com.mks.api.response.ValueList

Retrieves the data types of the elements in the list.

getDateTime() - Method in interface com.mks.api.response.Field

Retrieves the java.util.Date value of the Field.

getDefaultHostname() - Method in interface com.mks.api.CmdRunner

Retrieves the default value for the --hostname option that will be passed on each command.

getDefaultHostname() - Method in interface com.mks.api.CmdRunnerCreator

Retrieves the default value for the --hostname option that will be passed on each command.

getDefaultImpersonationUser() - Method in interface com.mks.api.CmdRunner

Retrieves the default impersonation user for the CmdRunner.

getDefaultImpersonationUser() - Method in interface com.mks.api.CmdRunnerCreator

Retrieves the default impersonation user for the CmdRunner.

getDefaultPassword() - Method in interface com.mks.api.CmdRunner

Retrieves the default value for the --password option that will be passed on each command.

getDefaultPassword() - Method in interface com.mks.api.CmdRunnerCreator

Retrieves the default value for the --password option that will be passed on each command.

getDefaultPort() - Method in interface com.mks.api.CmdRunner

Retrieves the default value for the --port option that will be passed on each command.

getDefaultPort() - Method in interface com.mks.api.CmdRunnerCreator

Retrieves the default value for the --port option that will be passed on each command.

getDefaultUsername() - Method in interface com.mks.api.CmdRunner

Retrieves the default value for the --user option that will be passed on each command.

getDefaultUsername() - Method in interface com.mks.api.CmdRunnerCreator

Retrieves the default value for the --user option that will be passed on each command.

getDisplayId() - Method in interface com.mks.api.response.Item

Retrieves the display id of the work item.

getDisplayName() - Method in interface com.mks.api.response.Field

Retrieves the display name of this Field.

getDisplayValueOf(Object) - Method in interface com.mks.api.response.ValueList

Retrieves display value of the given value object.

getDouble() - Method in interface com.mks.api.response.Field

Retrieves the java.lang.Double value of the Field.

getExceptionId() - Method in error com.mks.api.response.APIError

Retrieves the identifier of the exception that came from the API call.

getExceptionId() - Method in exception com.mks.api.response.APIException

Retrieves the identifier of the exception that came from the API call.

getExitCode() - Method in class com.mks.api.ext.SimpleIntegrationCommand

The exit code upon successful command execution is generally expected to be zero (0).

getExitCode() - Method in interface com.mks.api.response.Response

Retrieves the exit code of the API command call.

getField(int) - Method in error com.mks.api.response.APIError

getField(int) - Method in exception com.mks.api.response.APIException

getField(String) - Method in error com.mks.api.response.APIError

getField(String) - Method in exception com.mks.api.response.APIException

getField(String) - Method in interface com.mks.api.response.FieldContainer

Retrieves a Field object by name from this WorkItem.

getFieldListSize() - Method in error com.mks.api.response.APIError

getFieldListSize() - Method in exception com.mks.api.response.APIException

getFieldListSize() - Method in interface com.mks.api.response.FieldContainer

Returns the size of all Field objects in the Item.

getFields() - Method in error com.mks.api.response.APIError

getFields() - Method in exception com.mks.api.response.APIException

getFields() - Method in interface com.mks.api.response.FieldContainer

Retrieves an Iterator over the list of Field objects stored in this WorkItem.

getFloat() - Method in interface com.mks.api.response.Field

Retrieves the java.lang.Float value of the Field.

getGenerateSubRoutines() - Method in class com.mks.api.Command

Retrieves the flag indicating if SubRoutines should be generated for this Command or not.

getHostname() - Method in interface com.mks.api.IntegrationPoint

Retrieves the host name property for the IntegrationPoint.

getId() - Method in interface com.mks.api.response.Item

Retrieves the unique ID of the Item.

getId() - Method in exception com.mks.api.response.ItemException

Retrieves the ID of the item causing the exception.

getImage() - Method in interface com.mks.api.response.Field

Retrieves the ImageIcon value of the Field.

getImageFileExtension(byte[]) - Static method in class com.mks.api.util.BinaryContents

Reads the byte array and *guesses* extension using Java's URLConnection class.

getInstance() - Static method in class com.mks.api.IntegrationPointFactory

Singleton creation method.

getInteger() - Method in interface com.mks.api.response.Field

Retrieves the java.lang.Integer value of the Field.

getIntegrationID() - Method in interface com.mks.api.Session

getIntegrationPoint() - Method in interface com.mks.api.fedsso.SSOSession

getIntegrationPoint() - Method in interface com.mks.api.Session

getIntegrationPoints() - Method in class com.mks.api.IntegrationPointFactory

Retrieves an Iterator over the IntegrationPoints that have been created by the IntegrationPointFactory.

getInvocationID() - Method in interface com.mks.api.CmdRunner

Retrieves the identifier that will be using in the invocation of commands from this CmdRuner.

getInvocationID() - Method in interface com.mks.api.response.Response

Retrieves the invocation identifier for the command execution that resulted in this Response.

getItem() - Method in interface com.mks.api.response.Field

Retrieves the com.mks.api.response.Item value of the field.

getItem(String) - Method in interface com.mks.api.response.ItemList

Retrieves an Item with a given ID.

getItemListSize() - Method in interface com.mks.api.response.ItemList

Retrieves the size of the list of Items.

getItems() - Method in interface com.mks.api.response.ItemList

Retrieves an Iterator over the list of Item objects.

getLast() - Method in interface com.mks.api.response.SubRoutineIterator

Retrieves the last processed SubRoutine.

getLast() - Method in interface com.mks.api.response.WorkItemIterator

Retrieves the last processed WorkItem.

getList() - Method in interface com.mks.api.response.Field

Retrieves the java.util.List value of the field.

getLocalCmdRunnerCreator() - Method in class com.mks.api.ext.SimpleIntegrationCommand

Returns the CmdRunnerCreator factory used for this API session.

getLocalIntegrationPoint() - Method in class com.mks.api.ext.SimpleIntegrationCommand

Returns the IntegrationPoint being used by this API session.

getLogger() - Static method in class com.mks.api.IntegrationPointFactory

Method used to retrieve the default logger used by the API.

getLong() - Method in interface com.mks.api.response.Field

Retrieves the java.lang.Long value of the Field.

getMajor() - Method in class com.mks.api.util.APIVersion

getMajor() - Method in interface com.mks.api.VersionNumber

getMessage() - Method in error com.mks.api.response.APIError

Retrieves the message component of the exception.

getMessage() - Method in exception com.mks.api.response.APIException

Retrieves the message component of the exception.

getMessage() - Method in interface com.mks.api.response.Result

Retrieves the message found in the Result.

getMinor() - Method in class com.mks.api.util.APIVersion

getMinor() - Method in interface com.mks.api.VersionNumber

getModelType() - Method in interface com.mks.api.response.Field

Retrieve the modelType of the value contained by this Field.

getModelType() - Method in interface com.mks.api.response.Item

Retrieves the modelType information of the Item.

getModelType() - Method in exception com.mks.api.response.ItemException

Retrieves the modelType attribute of the item that caused the exception.

getName() - Method in class com.mks.api.Option

Retrieves the name associated with this Option.

getName() - Method in interface com.mks.api.response.Field

Retrieves the name of the field.

getOption() - Method in exception com.mks.api.response.InvalidCommandOptionException

Retrieves the invalid option that caused the exception.

getOption(String) - Method in class com.mks.api.OptionList

Retrieves the named Option from the list.

getOptionList() - Method in class com.mks.api.Command

Retrieves the OptionList associated with this command.

getOptions() - Method in class com.mks.api.OptionList

Retrieves an Iterator over the list of Options.

getOptionValue(String) - Method in interface com.mks.api.ext.CommandOptions

Get the value of a set option

getPort() - Method in interface com.mks.api.IntegrationPoint

Retrieves the port property for the IntegrationPoint.

getPrimaryValue() - Method in interface com.mks.api.response.Result

Retrieves the primary value of the Result.

getReason() - Method in exception com.mks.api.response.InvalidItemException

Retrieves the reason the exception was thrown.

getReason() - Method in exception com.mks.api.response.ItemModificationException

Retrieves the reason the exception was thrown.

getResponse() - Method in exception com.mks.api.response.APIException

Retrieves the linked Response available to the APIException.

getResult() - Method in interface com.mks.api.response.Response

Retrieves the Result generated by the command call.

getResult() - Method in interface com.mks.api.response.SubRoutine

Retrieves the Result generated by the API command call.

getResult() - Method in interface com.mks.api.response.WorkItem

Retrieves the Result object associated with the WorkItem.

getRoutine() - Method in interface com.mks.api.response.SubRoutine

Retrieves the sub-routine name for this Response.

getSelection() - Method in exception com.mks.api.response.InvalidCommandSelectionException

Retrieves the selection element that caused the exception.

getSelection(int) - Method in class com.mks.api.SelectionList

Retrieves a Selection at the specified index, or null if the given index position is out of range.

getSelectionList() - Method in class com.mks.api.Command

Retrieves the SelectionList associated with this command.

getSelections() - Method in class com.mks.api.SelectionList

Retrieves an Iterator over the list.

getSeparator() - Method in class com.mks.api.MultiValue

Retrieves the separator for the values.

getSeparator() - Method in class com.mks.api.Option

Retrieves the current value separator.

getSession() - Method in interface com.mks.api.CmdRunner

Retrieves the Session that created the CmdRunner.

getSession() - Method in interface com.mks.api.fedsso.SSOCmdRunner

Retrieves the SSOSession that created the SSOCmdRunner.

getSessions() - Method in interface com.mks.api.IntegrationPoint

Retrieves an Iterator over the Sessions that have been created for the IntegrationPoint.

getSize() - Method in class com.mks.api.ext.CommandSelection

The count of selections

getString() - Method in interface com.mks.api.response.Field

Retrieves the String value of the Field.

getSubRoutine(String) - Method in interface com.mks.api.response.SubRoutineContainer

Retrieves a specific SubRoutine with a given name.

getSubRoutineListSize() - Method in interface com.mks.api.response.SubRoutineContainer

Determines the size of the list of SubRoutine objects.

getSubRoutines() - Method in interface com.mks.api.response.SubRoutineContainer

Retrieves a SubRoutineIterator over the SubRoutine objects found.

getTimeout() - Method in interface com.mks.api.Session

Retrieves the session connection time-out.

getValue() - Method in class com.mks.api.Option

Retrieves the value associated with this Option.

getValue() - Method in interface com.mks.api.response.Field

Retrieves the java.lang.Object value of the field.

getValueAsString() - Method in interface com.mks.api.response.Field

Retrieves a valid String representation of the value stored in the Field.

getValues() - Method in class com.mks.api.MultiValue

Returns the collection of values as a List.

getVendor() - Method in class com.mks.api.Command

Retrieves the name of the third-party vendor who is providing this command.

getWorkItem(String) - Method in interface com.mks.api.response.WorkItemContainer

Retrieves a specific WorkItem with a given ID.

getWorkItem(String, String) - Method in interface com.mks.api.response.WorkItemContainer

Retrieves a specific WorkItem with a given ID.

getWorkItemListSize() - Method in interface com.mks.api.response.WorkItemContainer

Determines the size of the list of WorkItem objects.

getWorkItems() - Method in interface com.mks.api.response.WorkItemContainer

Retrieves a WorkItemIterator over the WorkItem objects found.

GROUP - Static variable in interface com.mks.api.im.IMModelTypeName

Windchill RV&S Group

A B C D E F G H I L M N O P Q R S T U V W
All Classes All Packages