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
All Classes All Packages
All Classes All Packages
S
- SANDBOX_INFO - Static variable in interface com.mks.api.si.SIModelTypeName
-
Integrations SandboxInfo.
- SCOPED_ITEM - Static variable in interface com.mks.api.ic.ICModelTypeName
- SD - Static variable in class com.mks.api.Command
-
Application name constant.
- SD_ACTION - Static variable in interface com.mks.api.si.SIModelTypeName
-
Staging & Deploy - Action
- SD_ADMIN - Static variable in interface com.mks.api.si.SIModelTypeName
-
Staging & Deploy - Admin
- SD_COMMAND_PREFERENCES - Static variable in interface com.mks.api.si.SIModelTypeName
-
Staging and Deploy Command Preferences
- SD_COMMAND_PREFERENCES_SETTING - Static variable in interface com.mks.api.si.SIModelTypeName
-
Staging and Deploy Command Preferences Setting
- SD_PROPERTY - Static variable in interface com.mks.api.si.SIModelTypeName
-
Staging & Deploy - A property
- SEGMENT - Static variable in interface com.mks.api.im.IMModelTypeName
-
Solutions data model segment root
- SELECTED_GROUP_BY - Static variable in interface com.mks.api.im.IMModelTypeName
-
A field and sorting direction used to group report results.
- SELECTED_LOGO - Static variable in interface com.mks.api.im.IMModelTypeName
-
A logo to be displayed in a report.
- SELECTED_REPORT_FIELD - Static variable in interface com.mks.api.im.IMModelTypeName
-
A field to be displayed in a report.
- selectionList - Variable in class com.mks.api.Command
-
The container for the selection.
- SelectionList - Class in com.mks.api
-
Class used to contain a list of
String
objects representing the selection to pass to theCommand
to be executed. - SelectionList() - Constructor for class com.mks.api.SelectionList
-
Default constructor.
- separator - Variable in class com.mks.api.MultiValue
-
Standard value separator.
- SERVER - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management Server
- SERVER_CONNECTION - Static variable in interface com.mks.api.im.IMModelTypeName
-
Windchill RV&S Server Connection
- SERVER_CONNECTION - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management ServerConnection
- Session - Interface in com.mks.api
-
Interface used to model a user application session.
- setApp(String) - Method in class com.mks.api.Command
-
Sets the application name for this command.
- setAutoReconnect(boolean) - Method in interface com.mks.api.Session
-
Sets the auto-reconnection flag on the connection.
- setAutoStartIntegrityClient(boolean) - Method in interface com.mks.api.IntegrationPoint
-
Sets the flag indicating if the
IntegrationPoint
should attempt to automatically start the Windchill RV&S Client. - setClientLocale(String) - Method in interface com.mks.api.CmdRunner
- setClientLocale(String) - Method in interface com.mks.api.CmdRunnerCreator
- setClientLocale(String) - Method in interface com.mks.api.fedsso.SSOCmdRunner
- setCommandName(String) - Method in class com.mks.api.Command
-
Sets the name of the command to execute.
- setDefaultHostname(String) - Method in interface com.mks.api.CmdRunner
-
Sets the default value for the --hostname option that will be passed on each command.
- setDefaultHostname(String) - Method in interface com.mks.api.CmdRunnerCreator
-
Sets the default value for the --hostname option that will be passed on each command.
- setDefaultHostname(String) - Method in class com.mks.api.ext.SimpleIntegrationCommand
-
Sets the default hostname that will be used for all local commands that do not explicitly specify a hostname.
- setDefaultImpersonationUser(String) - Method in interface com.mks.api.CmdRunner
-
Sets the default impersonation user used for the
CmdRunner
instance. - setDefaultImpersonationUser(String) - Method in interface com.mks.api.CmdRunnerCreator
-
Sets the default impersonation user used for the
CmdRunner
instance. - setDefaultImpersonationUser(String) - Method in class com.mks.api.ext.SimpleIntegrationCommand
-
Sets the default impersonation user that will be used for all local commands that do not explicitly specify an impersonation user.
- setDefaultPassword(String) - Method in interface com.mks.api.CmdRunner
-
Sets the default value for the --password option that will be passed on each command.
- setDefaultPassword(String) - Method in interface com.mks.api.CmdRunnerCreator
-
Sets the default value for the --password option that will be passed on each command.
- setDefaultPassword(String) - Method in class com.mks.api.ext.SimpleIntegrationCommand
-
Sets the default credential that will be used for all local commands that do not explicitly specify a password.
- setDefaultPort(int) - Method in interface com.mks.api.CmdRunner
-
Sets the default value for the --port option that will be passed on each command.
- setDefaultPort(int) - Method in interface com.mks.api.CmdRunnerCreator
-
Sets the default value for the --port option that will be passed on each command.
- setDefaultPort(int) - Method in class com.mks.api.ext.SimpleIntegrationCommand
-
Sets the default port that will be used for all local commands that do not explicitly specify a port.
- setDefaultUsername(String) - Method in interface com.mks.api.CmdRunner
-
Sets the default value for the --user option that will be passed on each command.
- setDefaultUsername(String) - Method in interface com.mks.api.CmdRunnerCreator
-
Sets the default value for the --user option that will be passed on each command.
- setDefaultUsername(String) - Method in class com.mks.api.ext.SimpleIntegrationCommand
-
Sets the default user that will be used for all local commands that do not explicitly specify a user.
- setGenerateSubRoutines(boolean) - Method in class com.mks.api.Command
-
Sets the flag indicating if
SubRoutine
s should be generated for thisCommand
or not. - setInvocationID(String) - Method in interface com.mks.api.CmdRunner
-
Set the identifier that will be used in the invocation of commands from this CmdRunner.
- setMessage(String) - Method in error com.mks.api.response.APIError
-
Sets the message of the exception.
- setMessage(String) - Method in exception com.mks.api.response.APIException
-
Sets the message of the exception.
- setOptionList(OptionList) - Method in class com.mks.api.Command
-
Sets the
OptionList
associated with this command. - setResponse(Response) - Method in exception com.mks.api.response.APIException
-
Links the last known
Response
with theAPIException
. - setSelectionList(SelectionList) - Method in class com.mks.api.Command
-
Sets the
SelectionList
associated with this command. - setSeparator(String) - Method in class com.mks.api.MultiValue
-
Sets the separator for the values.
- setSeparator(String) - Method in class com.mks.api.Option
-
Sets the current value separator.
- setShowStackTrace(boolean) - Method in error com.mks.api.response.APIError
-
Indicates if stack traces should be displayable or not.
- setShowStackTrace(boolean) - Method in exception com.mks.api.response.APIException
-
Indicates if stack traces should be displayable or not.
- setTimeout(int) - Method in interface com.mks.api.Session
-
Sets the session connection time-out.
- setValues(String[]) - Method in class com.mks.api.MultiValue
-
Sets the collection of values from an array.
- setValues(List) - Method in class com.mks.api.MultiValue
-
Sets the collection of values from a
List
. - setVendorName(String) - Method in class com.mks.api.Command
-
Set the name of the vendor to use to locate the command to be executed.
- showStackTrace - Variable in error com.mks.api.response.APIError
- showStackTrace - Variable in exception com.mks.api.response.APIException
- SI - Static variable in class com.mks.api.Command
-
Application name constant.
- SI_DEFERRED_OP_INFO - Static variable in interface com.mks.api.si.SIModelTypeName
-
Additional information for Deferred Operations
- SI_FORMER_SANDBOX - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management Former (top-level) sandbox.
- SI_FORMER_SUBSANDBOX - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management Former subsandbox
- SI_ISSUE - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management Issue
- SI_POLICY_SECTION - Static variable in interface com.mks.api.si.SIModelTypeName
- SI_PROJECT - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management Project
- SI_SANDBOX - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management Sandbox
- SI_SUBPROJECT - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management subproject
- SI_SUBSANDBOX - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management subsandbox
- SI_USER - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management User
- SIModelTypeName - Interface in com.mks.api.si
-
Enumerated definition of the constants that are to be used to represent the supported Work Item types.
- SimpleIntegrationCommand - Class in com.mks.api.ext
-
Base class for building an Integration Command Extension.
- SimpleIntegrationCommand() - Constructor for class com.mks.api.ext.SimpleIntegrationCommand
-
Deprecated.Use versioned constructor
SimpleIntegrationCommand(apiMajorNumber, apiMinorNumber)
instead - SimpleIntegrationCommand(int, int) - Constructor for class com.mks.api.ext.SimpleIntegrationCommand
-
Versioned constructor.
- SimpleIntegrationCommand(VersionNumber) - Constructor for class com.mks.api.ext.SimpleIntegrationCommand
-
Versioned constructor.
- SIPROJECT - Static variable in interface com.mks.api.im.IMModelTypeName
-
Windchill RV&S Project
- size() - Method in class com.mks.api.OptionList
-
Determines the size of the
OptionList
. - size() - Method in class com.mks.api.SelectionList
-
Retrieves the size of the list.
- size() - Method in class com.mks.api.util.Queue
-
Returns the number of elements in the queue.
- SORT_FIELD - Static variable in interface com.mks.api.im.IMModelTypeName
-
A sort field to be used in a report.
- SOURCE_TRACE - Static variable in interface com.mks.api.im.IMModelTypeName
-
Windchill RV&S Source Trace
- SSOCmdRunner - Interface in com.mks.api.fedsso
-
Interface for the
SSOCmdRunner
object. - SSOCmdRunnerCreator - Interface in com.mks.api.fedsso
-
Interface used to model an environment in which a collection of
SSOCmdRunner
instances can be created.
- SSOSession - Interface in com.mks.api.fedsso
-
Interface used to model a user application SSOSession.
- STAGE - Static variable in interface com.mks.api.si.SIModelTypeName
-
Staging & Deploy - Stage
- STAGE_AND_DEPLOY - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management Staging & Deploy Object
- STAGING_CHANGEPACKAGE - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management Staging ChangePackage
- STAGING_SYSTEM - Static variable in interface com.mks.api.si.SIModelTypeName
-
Staging & Deploy - Staging System
- startItemField(String, Object) - Method in class com.mks.api.ext.ResponseWriter
-
Start a new item field in the API response.
- startItemField(String, String, Object) - Method in class com.mks.api.ext.ResponseWriter
-
Start a new item field in the API response with a given display name.
- startItemField(String, String, String, String) - Method in class com.mks.api.ext.ResponseWriter
-
Start a new item field in the API response.
- startItemField(String, String, String, String, String) - Method in class com.mks.api.ext.ResponseWriter
-
Start a new item field in the API response.
- startSelection() - Method in class com.mks.api.ext.CommandSelection
-
Initialize the selection for use by the API command.
- startSubRoutine(String) - Method in class com.mks.api.ext.ResponseWriter
-
Start a new sub-routine.
- startWorkItem(Object) - Method in class com.mks.api.ext.ResponseWriter
-
Start a new work-item in the API response.
- startWorkItem(String, String, String) - Method in class com.mks.api.ext.ResponseWriter
-
Start a new work-item in the API response.
- STATE - Static variable in interface com.mks.api.im.IMModelTypeName
-
Windchill RV&S State
- STATE - Static variable in interface com.mks.api.si.SIModelTypeName
-
Source Code Management State
- STATE_TRANSITION - Static variable in interface com.mks.api.im.IMModelTypeName
-
State Transition
- stop() - Method in class com.mks.api.util.MKSLogger
-
Method to stop and close logging
- STRING_TYPE - Static variable in interface com.mks.api.response.Field
-
Field datatype constant.
- SubRoutine - Interface in com.mks.api.response
-
Interface to a
SubRoutine
object in theResponse
hierarchy. - SubRoutineContainer - Interface in com.mks.api.response
-
Interface used to identify the various methods used for accessing a
SubRoutine
object. - SubRoutineIterator - Interface in com.mks.api.response
-
Interface used to iterate over a list of
SubRoutine
objects. - SUBSEGMENT_REFERENCED_BY - Static variable in interface com.mks.api.im.IMModelTypeName
-
Solutions data model subsegment referenced by
All Classes All Packages