Index (Kofax RPA Java API)

A B C D E F G H I J L M N O P Q R S T U V W X _

A

AbstractRepositoryClient - Class in com.kapowtech.robosuite.api.java.repository.engine: The abstract client doesn't specify how the data is transported to the repository, which allow us to mock this part for tests.
AbstractRepositoryClient() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient: Creates a new instance
addFile(RepositoryFile) - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder: Adds a file This is a local operation.
AdditionalInfo - Class in com.kapowtech.robosuite.api.java.repository.construct: Additional information for changes sent to the repository
AdditionalInfo(String) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.AdditionalInfo
addReferences(RepositoryFile) - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder: Adds a reference file to the folder.
addSubFolder(RepositoryFolder) - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder: Adds a folder This is a local operation.
API_TOKEN - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
ApiException - Exception in com.kapowtech.robosuite.api.java.rest: Base class for all checked exceptions in the Java API.
ApiException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rest.ApiException: Constructs a new ApiException with the specified detail message and cause.
ApiException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rest.ApiException: Constructs a new ApiException with the specified detail message.
ApiKeyAuthenticationProvider - Class in com.kapowtech.robosuite.api.java.repository.engine: An Authentication provider that uses user generated API keys to authenticate.
ApiKeyAuthenticationProvider(String, String) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.ApiKeyAuthenticationProvider
Attribute - Class in com.kapowtech.robosuite.api.java.repository.construct: An attribute of a type.
Attribute(String, AttributeType, boolean) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Attribute: Creates a new Attribute.
Attribute - Class in com.kapowtech.robosuite.api.java.rest: Represents an attribute as an entry in an RpaObject.
Attribute(String, Object) - Constructor for class com.kapowtech.robosuite.api.java.rest.Attribute: Creates a new Attribute representing an attribute in an object.
Attribute(String, String, AttributeType) - Constructor for class com.kapowtech.robosuite.api.java.rest.Attribute: Creates a new Attribute representing an attribute in an object.
Attribute(String, AttributeType) - Constructor for class com.kapowtech.robosuite.api.java.rest.Attribute: Creates a new Attribute representing an attribute with the value null in an object.
Attribute(String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rest.Attribute: Creates a new Attribute representing an attribute in an object.
AttributesMap - Class in com.kapowtech.robosuite.api.java.rest.internal: Represents the attributes in an RpaObject.
AttributesMap(List<Attribute>) - Constructor for class com.kapowtech.robosuite.api.java.rest.internal.AttributesMap: Creates a new AttributesMap from a list of Attribute objects.
AttributeType - Class in com.kapowtech.robosuite.api.java.repository.construct: A class modeling the data types used by Robots.
AttributeType - Class in com.kapowtech.robosuite.api.java.rest.internal: Represents type-information about the attributes in Input or Output Objects.
AuthenticationProvider - Class in com.kapowtech.robosuite.api.java.repository.engine: This represents the authentication method and carries the potential credentials to use by the RepositoryClientImpl when authenticating to the repository.
AuthenticationProvider(String) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.AuthenticationProvider

B

BINARY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Binary used in Design Studio types

Binary - Class in com.kapowtech.robosuite.api.java.rest

Represents a Binary Robot value.

Binary(byte[]) - Constructor for class com.kapowtech.robosuite.api.java.rest.Binary

Creates a new binary object from a byte array.

Binary(byte[], int, int) - Constructor for class com.kapowtech.robosuite.api.java.rest.Binary

Creates a new binary object from a byte array.

Binary(InputStream) - Constructor for class com.kapowtech.robosuite.api.java.rest.Binary

Creates a new binary object from a byte input stream.

Binary(String) - Constructor for class com.kapowtech.robosuite.api.java.rest.Binary

Creates a new byte array from a base 64 encoded string.

BINARY - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Represents the Binary data type.

BOOLEAN - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Boolean used in Design Studio types

BOOLEAN - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Represents the Boolean data type.

C

cancel() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Signals the execution to stop.

CHARACTER - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Character used in Design Studio types

CHARACTER - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Represents the Character data type.

check(Document, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.messages.Response

clearAttributes() - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

clearAttributes() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Clears all attributes from the object being constructed.

clone() - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Creates and returns a deep copy of this object.

coerceToAcceptedValue(Object) - Static method in class com.kapowtech.robosuite.api.java.rest.Attribute

Coerces a value into a value accepted by the API.

com.kapowtech.robosuite.api.java.repository.construct - package com.kapowtech.robosuite.api.java.repository.construct

Provides classes which may be returned by the API when querying the Repository

com.kapowtech.robosuite.api.java.repository.engine - package com.kapowtech.robosuite.api.java.repository.engine

Contains the RepositoryClient class which provides communication with the repository.

com.kapowtech.robosuite.api.java.repository.engine.messages - package com.kapowtech.robosuite.api.java.repository.engine.messages

com.kapowtech.robosuite.api.java.rest - package com.kapowtech.robosuite.api.java.rest

com.kapowtech.robosuite.api.java.rest.internal - package com.kapowtech.robosuite.api.java.rest.internal

COMMONS_CODEC_FOUND - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.StartupCheck

COMMONS_LOGGING_FOUND - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.StartupCheck

configureHttpClient() - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

COUNTRY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Country used in Design Studio types

create(GetRobotsByTag.Data) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag

create(T) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.messages.Message

creates xml document of the required type stuffed with the specified data

create(Collection<OAuthUserEntry>) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.OAuthUserEntryListResponse

create(Collection<Robot>) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.RobotListResponse

createDocument(Message<T>, T) - Static method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Compose xml document from the data using messages implementing the Message interface

createInputVariable(String) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Creates a new input Object with the specified name, and returns an RpaObjectBuilder that can be used to build the object.

createInputVariable(String, RpaObject) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Creates a new Input Object with the specified name, from an RpaObject.

createOAuthInputVariable(String, String, String) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Creates an input variable for an OAUTH input type, that will look up the OAuth details in Management Console based on the given username and application name.

createRepositoryClient(String, String) - Static method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientFactory

Creates a new Repository Client using an API key

CURRENCY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Currency used in Design Studio types

D

Data() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data

DATE - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Date used in Design Studio types

DATE - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Represents the Date data type.

DEFAULT_POLLING_INTERVAL - Static variable in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

deleteConnector(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a connector from the repository

deleteConnector(String, String, boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a connector from the repository

deleteConnector(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deletes a connector from the repository

deleteConnector(String, String, boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deleteFile(RepositoryFile) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Delete a RepositoryFile

deleteFile(RepositoryFile, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

deleteFile(RepositoryFile) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Delete a RepositoryFile

deleteFile(RepositoryFile, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deleteFolder(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Delete a folder

deleteFolder(String, String, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Delete a folder

deleteFolder(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Delete a folder

deleteFolder(String, String, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deleteResource(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a resource from the repository

deleteResource(String, String, boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a resource from the repository

deleteResource(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deletes a resource from the repository

deleteResource(String, String, boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deleteRobot(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a robot from the repository.

deleteRobot(String, String, boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a robot from the repository.

deleteRobot(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deletes a robot from the repository.

deleteRobot(String, String, boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deleteSnippet(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a Snippet from the repository

deleteSnippet(String, String, boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a Snippet from the repository

deleteSnippet(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deletes a Snippet from the repository

deleteSnippet(String, String, boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deleteType(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a type from the repository

deleteType(String, String, boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deletes a type from the repository

deleteType(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deletes a type from the repository

deleteType(String, String, boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deployConnector(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a connector in a repository.

deployConnector(String, String, byte[], boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a connector in a repository.

deployConnector(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deploys a connector in a repository.

deployConnector(String, String, byte[], boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deployResource(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a resource in a repository.

deployResource(String, String, byte[], boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a resource in a repository.

deployResource(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deploys a resource in a repository.

deployResource(String, String, byte[], boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deployRobot(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a robot in a repository.

deployRobot(String, String, byte[], boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a robot in a repository.

deployRobot(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deploys a robot in a repository.

deployRobot(String, String, byte[], boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deploySnippet(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a snippet to a repository.

deploySnippet(String, String, byte[], boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a snippet to a repository.

deploySnippet(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deploys a snippet to a repository.

deploySnippet(String, String, byte[], boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

deployType(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a type to a repository.

deployType(String, String, byte[], boolean, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a type to a repository.

deployType(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Deploys a type to a repository.

deployType(String, String, byte[], boolean, AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

doDeploy(String, String, byte[], boolean, String, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Deploys a resource/robot or type in a repository.

doSend(HttpPost, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

Posts a request to a server, and gets the response stream.

E

entrySet() - Method in class com.kapowtech.robosuite.api.java.rest.internal.AttributesMap

Returns a set view of the attribute mappings contained in this map.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.Attribute

Compares the specified object with this entry for equality.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns true if this object and the specified object have the same property values, and false otherwise.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.internal.Response

Returns true if this object and the specified object have the same property values, and false otherwise.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.internal.RobotResponse

Returns true if this object and the specified object have the same property values, and false otherwise.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.internal.ServerResponse

Returns true if this object and the specified object have the same property values, and false otherwise.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.RobotErrorResponse

Returns true if this object and the specified object have the same property values, and false otherwise.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.RobotOutputObjectResponse

Returns true if this object and the specified object have the same property values, and false otherwise.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObject

Tests whether this object is equal to another.

equals(Object) - Method in class com.kapowtech.robosuite.api.java.rest.ServerErrorResponse

Returns true if this object and the specified object have the same property values, and false otherwise.

ErrorResponse - Interface in com.kapowtech.robosuite.api.java.rest

The error response interface provides a common view of the two types of error responses - RobotErrorResponse and ServerErrorResponse.

EXCEL - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Excel used in Design Studio types.

execute() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Executes the robot request.

execute(RobotResponseHandler) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Executes the robot request, using a custom response handler.

ExecutionResult - Class in com.kapowtech.robosuite.api.java.rest

Encapsulates the result of a robot execution.

ExecutionResult(List<Response>, String) - Constructor for class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Creates a new ExecutionResult object based on the result of processing a request, including the resulting state.

F

FileAlreadyExistsException - Exception in com.kapowtech.robosuite.api.java.repository.engine

Signals that a file already exists

FileAlreadyExistsException(String) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.FileAlreadyExistsException

Constructs a new instance

FileMismatchWarningException - Exception in com.kapowtech.robosuite.api.java.repository.engine

Warning used, when downloading file from server, when the file latest modified date, modified by and checksum are not the same, as the requested file.

FileMismatchWarningException(byte[], String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.FileMismatchWarningException

constructs a new instance

FileMismatchWarningException(byte[], String) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.FileMismatchWarningException

Constructs a new FileMismatchWarningException with the specified detail message.

fromString(String) - Method in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Parses a value to an object of the correct Java class.

G

get(int) - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns the byte at the specified index.

get(String) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObject

Returns the value of the attribute with the specified name, or null if not found.

get(int) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjects

Returns the input object at the specified position in this list.

GET_ROBOT_OUTPUT_URL - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

getAliases() - Method in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Returns any additional string descriptions of the type name that may be accepted.

getApiKey() - Method in class com.kapowtech.robosuite.api.java.repository.engine.ApiKeyAuthenticationProvider

getApplicationName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.OAuthUserEntry

gets the name of the application the OAuth User Entry belongs to

getAttribute(String) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObject

Returns the Attribute object that represents the attribute with the specified name, or null if not found.

getAttributeByName(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject

finds an attribute with a given name

getAttributeByName(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.Type

finds an attribute with a given name

getAttributes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject

get the attributes of this input object

getAttributes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Type

get the attributes of this returned object

getAttributes() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObject

Returns a map view of the attributes in the object.

getAuthenticationProvider() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

getAuthenticationProvider() - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

getByName(String) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjects

Returns a sublist of the RpaObjects in this list that have the specified name.

getBySignature(List<String>) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjects

Returns a sublist of the RpaObjects in this list that have all the specified attributes.

getBytes(RepositoryFile) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Get bytes for a given RepositoryFile.

getBytes() - Method in exception com.kapowtech.robosuite.api.java.repository.engine.FileMismatchWarningException

getBytes(RepositoryFile) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Get bytes for a given RepositoryFile.

getByType(String) - Static method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type

getChecksum() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getChecksum() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot

Gets the checksum of the body of the robot.

getComment() - Method in class com.kapowtech.robosuite.api.java.repository.construct.AdditionalInfo

getCurrentDate() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Gets the current date of Management Console with format: yyyy-MM-dd HH:mm:ss.SSS Example: 2014-10-09 12:33:14.608

getCurrentDate() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Gets the current date of Management Console with format: yyyy-MM-dd HH:mm:ss.SSS Example: 2014-10-09 12:33:14.608

getDate() - Method in class com.kapowtech.robosuite.api.java.rest.internal.Response

Returns the date at which the response was created at the server.

getDependencies() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getErrorLocation() - Method in class com.kapowtech.robosuite.api.java.rest.RobotErrorResponse

Returns the error location.

getErrorLocationCode() - Method in class com.kapowtech.robosuite.api.java.rest.RobotErrorResponse

Returns the error location code.

getErrorMessage() - Method in interface com.kapowtech.robosuite.api.java.rest.ErrorResponse

Returns the error message.

getErrorMessage() - Method in class com.kapowtech.robosuite.api.java.rest.RobotErrorResponse

Returns the error message.

getErrorMessage() - Method in class com.kapowtech.robosuite.api.java.rest.ServerErrorResponse

Returns the error message.

getErrors() - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns a list of ErrorResponse objects.

getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns the executionId of the robot.

getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rest.internal.RobotResponse

Returns the execution id.

getExtension() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getExtension() - Method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type

getFileInventory(String, String, String, RepositoryFile.Type) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Gets the file and the referenced files from the management console.

getFileInventory(String, String, String, RepositoryFile.Type) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Gets the file and the referenced files from the management console.

getFiles() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder

getFileType(String) - Static method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type

getFolder() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getFolderInventory(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Retrieves the folders and files of the sub folder in the specified project from the repository.

getFolderInventory(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Retrieves the folders and files of the sub folder in the specified project from the repository.

getHeader(HttpMessage, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

getHttpClient() - Method in class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

Gets the current http client.

getId() - Method in class com.kapowtech.robosuite.api.java.repository.construct.OAuthUserEntry

get the id of the OAuth User Entry

getInfo() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Get information about the Management Console and the Repository API.

getInfo() - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

getInputObjects() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

Get the input objects used by this robot

getInputStream() - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns an input stream that can be used to read from the internal byte array.

getInterimResults() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Retrieves intermediary results from an ongoing execution.

getInvalidType() - Method in exception com.kapowtech.robosuite.api.java.rest.InvalidAttributeTypeException

Returns the type (or class) of the invalid attribute.

getInvalidTypeName() - Method in exception com.kapowtech.robosuite.api.java.rest.InvalidAttributeTypeException

Returns the type name of the invalid type parameter.

getKey() - Method in class com.kapowtech.robosuite.api.java.rest.Attribute

Returns the name of the attribute that is used as a key for this entry.

getLastModified() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getLastModified() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot

gets date when the robot was last modified

getLastModified() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

Get the last modified date of the robot

getLastModifiedBy() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getModifiedBy() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot

Gets the ID of the user who modified the robot most recently.

getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Attribute

get the name of this attribute

getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

Get the name of the Attribute type

getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute

get the name of this attribute

getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.OAuthUserEntry

Gets the name of the OAuth User Entry

getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Project

Get the name of this project

getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder

Get the repository folder name.

getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot

Gets the name of the robot

getName() - Method in class com.kapowtech.robosuite.api.java.rest.Attribute

Returns the name of the attribute that is used as a key for this entry.

getName() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObject

Returns the name of the object.

getName() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Returns the name of the object under construction.

getOAuthUserEntriesInProject(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Retrieves the OAuth User Entries in a given project.

getOAuthUserEntriesInProject(String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Retrieves all the OAuth User Entries for the given project id.

getObjectByName(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

finds an input object with a give name

getOutputObject() - Method in class com.kapowtech.robosuite.api.java.rest.RobotOutputObjectResponse

Returns the output object.

getOutputObjects() - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns the output objects as an RpaObjects list.

getOutputObjectsByName(String) - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns the output objects as an RpaObjects list.

getOutputObjectsBySignature(List<String>) - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns the output objects as an RpaObjects list.

getParent() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder

getPath() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder

getPollingIntervalMillis() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

The current polling interval.

getPriority() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

The current priority.

getProject() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Get the project for this request

getProjectInventory(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Retrieves the folders and files of the entire project from the repository.

getProjectInventory(String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Retrieves the folders and files of the entire project from the repository.

getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder

getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data

getProjects() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Retrieves the projects available in the repository.

getProjects() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Retrieves the projects available in the repository.

getProjectsByUser(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Retrieves the projects available for the current user in the repository.

getProjectsByUser(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Retrieves the projects available for the current user in the repository.

getReferences() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder

getResponses() - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns all the Responses that make up the result.

getResponsesByClass(Class<?>) - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns a list of Responses that satisfies the condition: responseType.isInstance(response).

getReturnedTypes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

Returns the types returned by the robot.

getRobotId() - Method in class com.kapowtech.robosuite.api.java.rest.internal.RobotResponse

Returns the robot id.

getRobotName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

Get the name of the robot

getRobotRunId() - Method in class com.kapowtech.robosuite.api.java.rest.internal.RobotResponse

Returns the robot run id.

getRobotsByTag(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

GetRobotsByTag - Class in com.kapowtech.robosuite.api.java.repository.engine.messages

< get-robots-by-tag > request

GetRobotsByTag() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag

getRobotsByTag(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

A request for robots with a specified tag.

GetRobotsByTag.Data - Class in com.kapowtech.robosuite.api.java.repository.engine.messages

getRobotSignature(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Returns the robot signature for a given robot

getRobotSignature(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Returns the robot signature for a given robot

getRobotsInProject(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Retrieves the robots in a given project.

getRobotsInProject(String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Retrieves the robots in a given project.

getRobotURL() - Method in class com.kapowtech.robosuite.api.java.rest.internal.RobotResponse

Returns the robot file URL.

getRobotURL() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Returns the currently configured robotURL property.

getSlimProjectInventory(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Retrieves the folders and files of the entire project from the repository, but does not resolve dependencies between objects.

getState() - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns a string representation of the status of the execution.

getState() - Method in class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

Acquire the state of this runner.

getStoredTypes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

Returns the types stored by the robot.

getSubFolders() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder

getTag() - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data

getTimeout() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Gets the current timeout.

getTimoutPropertyOrDefault() - Static method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

getType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Attribute

Get the type of this attribute

getType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute

Get the type of this attribute

getType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

getType() - Method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type

getType() - Method in class com.kapowtech.robosuite.api.java.rest.Attribute

Returns the type of the attribute.

getType() - Method in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Returns the Java class of the type.

getType() - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

getType() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

The type of RPA object (currently BASIC or OAUTH)

getTypeName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject

The name of the Type

getTypeName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Type

The name of the Type

getTypeName() - Method in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Returns a string description of the type name.

getUrl() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AuthenticationProvider

getValue() - Method in class com.kapowtech.robosuite.api.java.rest.Attribute

Returns the attribute value corresponding to this entry.

getVariableName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject

Get the name of the input variable.

getVersion() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot

get the version

getVersion() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

Get the version of Design Studio the robot was last saved with.

H

handleError(ApiException, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Called if an exception has occurred inside the API.

handleExecutionError(RobotErrorResponse, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Receive notification when a robot has generated an API exception.

handleReturnedValue(RobotOutputObjectResponse, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Receive notification when the robot executes the Return Value action.

handleServerError(ServerErrorResponse, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Receive notification when the server generates an error response.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.Attribute

Returns the hash code value for this map entry.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns the hash code of this object based on property values.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.internal.Response

Returns the hash code of this object based on property values.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.internal.RobotResponse

Returns the hash code of this object based on property values.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.internal.ServerResponse

Returns the hash code of this object based on property values.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.RobotErrorResponse

Returns the hash code of this object based on property values.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.RobotOutputObjectResponse

Returns the hash code of this object based on property values.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObject

Returns a hash code value for the object.

hashCode() - Method in class com.kapowtech.robosuite.api.java.rest.ServerErrorResponse

Returns the hash code of this object based on property values.

HTML - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Html used in Design Studio types

HTTP_CLIENT_FOUND - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.StartupCheck

HTTP_CORE_CLIENT_FOUND - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.StartupCheck

I

IMAGE - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Image used in Design Studio types

initMessage(HttpMessage) - Method in class com.kapowtech.robosuite.api.java.repository.engine.ApiKeyAuthenticationProvider

initMessage(HttpMessage) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AuthenticationProvider

InputAttribute - Class in com.kapowtech.robosuite.api.java.repository.construct

An attribute of a variable type used as input to a robot.

InputAttribute(String, AttributeType, boolean) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute

Creates a new InputAttribute.

InputObject - Class in com.kapowtech.robosuite.api.java.repository.construct

A description of the name, and type, of a variable used as input to a robot.

InputObject(String, String, InputAttribute[]) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.InputObject

Constructs a new InputObject

INTEGER - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Integer used in Design Studio types

INTEGER - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Represents the Integer data type.

InvalidAttributeTypeException - Exception in com.kapowtech.robosuite.api.java.rest

Signals that an invalid attribute type was inserted into an Attribute.

InvalidAttributeTypeException(Class<?>) - Constructor for exception com.kapowtech.robosuite.api.java.rest.InvalidAttributeTypeException

Constructs an InvalidAttributeTypeException.

InvalidAttributeTypeException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rest.InvalidAttributeTypeException

Constructs an InvalidAttributeTypeException.

isEmpty() - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns true if this object contains no bytes.

isRequired() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Attribute

checks if the attribute is required

isRequired() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute

checks if the attribute is required

J

JSON - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Json used in Design Studio types.

L

LANGUAGE - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Language used in Design Studio types

LONG_TEXT - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Long Text used in Design Studio types

M

Message<T> - Interface in com.kapowtech.robosuite.api.java.repository.engine.messages

Message interface declares methods for work with a message - creating xml document from the specified data and reading xml document back to a java object.

moveFile(RepositoryFile, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Move repository file to a new folder.

moveFile(RepositoryFile, String, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Move repository file to a new folder.

moveFile(RepositoryFile, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Move repository file to a new folder.

N

newRequest() - Static method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Private helper method that creates a new DOM Document.

NUMBER - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Number used in Design Studio types

NUMBER - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Represents the Number data type.

O

OAuthRpaObjectBuilder - Class in com.kapowtech.robosuite.api.java.rest.internal

A custom RpaObjectBuilder that adds the oauth user-name and application name to the attribute.

OAuthRpaObjectBuilder(String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

OAuthUserEntry - Class in com.kapowtech.robosuite.api.java.repository.construct

An OAuth user entry.

OAuthUserEntry(String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.OAuthUserEntry

Constructs a new OAuth User Entry object.

OAuthUserEntryListResponse - Class in com.kapowtech.robosuite.api.java.repository.engine.messages

OAuthUserEntryListResponse() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.messages.OAuthUserEntryListResponse

P

parseAttributeType(String) - Static method in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

Parses an attribute type from a name.

parseAttributeType(String) - Static method in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Returns the AttributeType associated with the given type name, or any of its aliases.

parseAttributeType(Class<?>) - Static method in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Returns the AttributeType associated with the given Java class.

parseDocument(Message<T>, Document) - Static method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Parse the xml document with help of a Message implementation

PASSWORD - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Password used in Design Studio types

PDF - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type PDF used in Design Studio types

pingRepository() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Ping the repository server

pingRepository() - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

prepareContext() - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

Project - Class in com.kapowtech.robosuite.api.java.repository.construct

A project Object, describes a project located in the repository

Project(String) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Project

Constructs a new Project object

PROPERTIES - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Properties used in Design Studio types

Q

QUEUE_ROBOT_URL - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

QueuedRequest - Class in com.kapowtech.robosuite.api.java.rest

This request will use the Management Console queue mechanism to run the request.

QueuedRequest(String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Creates a new QueuedRequest with the specified robot URL.

QueuedRequest(String, String, String, String, QueuedRequest.Priority, long) - Constructor for class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Creates a new QueuedRequest with the specified Management Console, robot path and project, priority and timeout time.

QueuedRequest.Priority - Enum in com.kapowtech.robosuite.api.java.rest

Queue priority for the robot.

QueuedRequestRunner - Class in com.kapowtech.robosuite.api.java.rest.internal

A runnable and stoppable, that runs (and potentially stops) a QueuedRequest using an executor.

QueuedRequestRunner(AuthenticationProvider, QueuedRequest.Priority, String, String, List<RpaObjectBuilder>, int, RobotResponseHandler, long, boolean) - Constructor for class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

queueTimedOut() - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Called when the API has detected that the robot has timed out in the queue.

R

read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag

read(Document) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.messages.Message

reads xml document and returns java object with its data

read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.OAuthUserEntryListResponse

read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.RobotListResponse

REFIND_KEY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Refind Key used in Design Studio types

renameRobot(RepositoryFile, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Rename a robot file.

renameRobot(RepositoryFile, String, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

renameRobot(RepositoryFile, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Rename a robot file.

RepositoryClient - Interface in com.kapowtech.robosuite.api.java.repository.engine

The interface which defines the RepositoryClient API.

RepositoryClientException - Exception in com.kapowtech.robosuite.api.java.repository.engine

General Client error when communicating with the Repository

RepositoryClientException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientException

constructs a new instance

RepositoryClientException(String) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientException

Constructs a new RepositoryClientException with the specified detail message.

RepositoryClientException(Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientException

constructs a new instance from another exception

RepositoryClientFactory - Class in com.kapowtech.robosuite.api.java.repository.engine

A factory form creating Repository Clients,

RepositoryClientImpl - Class in com.kapowtech.robosuite.api.java.repository.engine

The actual client implementation.

RepositoryClientImpl(String, String) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

RepositoryClientImpl(AuthenticationProvider) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

RepositoryConnectionException - Exception in com.kapowtech.robosuite.api.java.repository.engine

RepositoryConnectionException(String) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryConnectionException

RepositoryConnectionException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryConnectionException

RepositoryFile - Class in com.kapowtech.robosuite.api.java.repository.construct

A repository file object, contains information about the folder items received from the repository.

RepositoryFile(String, RepositoryFolder, String, RepositoryFile.Type, Date, String, String, Collection<RepositoryFile>) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile

RepositoryFile.Type - Enum in com.kapowtech.robosuite.api.java.repository.construct

RepositoryFolder - Class in com.kapowtech.robosuite.api.java.repository.construct

A repository folder object, contains information about the folders from the repository

RepositoryFolder(String, RepositoryFolder, String) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder

Request<T> - Interface in com.kapowtech.robosuite.api.java.repository.engine.messages

Request message.

requestAccepted(String) - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Called when the request has been accepted, and has been placed in the queue.

Response<T> - Interface in com.kapowtech.robosuite.api.java.repository.engine.messages

Response message

Response - Class in com.kapowtech.robosuite.api.java.rest.internal

An Response is sent as a response to a Request.

Response(Date) - Constructor for class com.kapowtech.robosuite.api.java.rest.internal.Response

Constructor.

Robot - Class in com.kapowtech.robosuite.api.java.repository.construct

A robot object, describes a robot in the Robot repository.

Robot(String, String, Date, String, String) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Robot

Constructs a new Robot object.

robotCanceled() - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Called when the API has detected that the robot has been canceled.

robotCompleted() - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Called when the API has detected that the robot has completed successfully.

RobotErrorResponse - Class in com.kapowtech.robosuite.api.java.rest

A RobotErrorResponse is a RobotResponse that contains a robot generated error status message.

RobotErrorResponse(Date, String, String, int, int, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rest.RobotErrorResponse

Creates a RobotMessageResponse with the specified property values.

robotFailed() - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Called when the API has detected that the robot has failed.

RobotListResponse - Class in com.kapowtech.robosuite.api.java.repository.engine.messages

RobotListResponse() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.messages.RobotListResponse

RobotOutputObjectResponse - Class in com.kapowtech.robosuite.api.java.rest

A RobotOutputObjectResponse is a RobotResponse that contains an output object.

RobotOutputObjectResponse(Date, String, String, int, int, RpaObject) - Constructor for class com.kapowtech.robosuite.api.java.rest.RobotOutputObjectResponse

Creates a RobotOutputObjectResponse with the specified property values.

RobotResponse - Class in com.kapowtech.robosuite.api.java.rest.internal

A RobotResponse is an Response that contains information related to the execution of a robot.

RobotResponse(Date, String, String, int, int) - Constructor for class com.kapowtech.robosuite.api.java.rest.internal.RobotResponse

Creates a RobotResponse with the specified property values.

RobotResponseHandler - Interface in com.kapowtech.robosuite.api.java.rest

An interface that will receive events when responses are returned by a robot.

RobotSignature - Class in com.kapowtech.robosuite.api.java.repository.construct

Models a robot signature, detailing the input needed to execute the robot

RobotSignature(String, String, Date, InputObject[]) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

Deprecated.
use the constructor that also specifies the returned and stored types.

RobotSignature(String, String, Date, InputObject[], Type[], Type[]) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

Creates a new RobotSignature

robotStarted(Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rest.RobotResponseHandler

Called when the robot starts to execute.

RpaObject - Class in com.kapowtech.robosuite.api.java.rest

Represents an object that can be passed as input to a robot, or returned as output when the robot is executed.

RpaObject(String) - Constructor for class com.kapowtech.robosuite.api.java.rest.RpaObject

Creates a new RpaObject with no attributes.

RpaObject(String, List<Attribute>) - Constructor for class com.kapowtech.robosuite.api.java.rest.RpaObject

Creates a new RpaObject with the given list of attribute entries.

RpaObjectBuilder - Class in com.kapowtech.robosuite.api.java.rest

Used to build RPA Objects, typically for use as input objects to a robot.

RpaObjectBuilder(String) - Constructor for class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Creates a new RpaObjectBuilder that creates an RpaObject with the given name.

RpaObjectBuilder(RpaObject) - Constructor for class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Creates a new RpaObjectBuilder that creates an RpaObject from a specified prototype.

RpaObjects - Class in com.kapowtech.robosuite.api.java.rest

Represents a collection of Input or Output Objects sent to or received from a robot.

RpaObjects(List<RpaObject>) - Constructor for class com.kapowtech.robosuite.api.java.rest.RpaObjects

Creates an RpaObjects that contains the following list of objects.

run() - Method in class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

Performs a 'run', which consists of updating the state.

S

sendXML(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Sends the XML document to the repository.

sendXML(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

Sends the XML document to the repository.

ServerErrorResponse - Class in com.kapowtech.robosuite.api.java.rest

A ServerErrorResponse is a ServerResponse that contains error information related to the operation of the server sending the response.

ServerErrorResponse(Date, String) - Constructor for class com.kapowtech.robosuite.api.java.rest.ServerErrorResponse

Creates a ServerErrorResponse with the specified property values.

ServerResponse - Class in com.kapowtech.robosuite.api.java.rest.internal

A ServerResponse is an Response that contains information related to the operation of the server sending the response.

ServerResponse(Date) - Constructor for class com.kapowtech.robosuite.api.java.rest.internal.ServerResponse

Constructor.

SESSION - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Session used in Design Studio types

setAttribute(String, Object) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, String) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, long) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, boolean) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, char) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, double) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, Date) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, Binary) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, byte[]) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(Attribute) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttribute(String, Object) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new attribute with the given name and value to the RPA Object under construction.

setAttribute(String, String) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new attribute with the given name and value to the RPA Object that is under construction.

setAttribute(String, long) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new integer type attribute with the given name and value to the RPA Object that is under construction.

setAttribute(String, boolean) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new boolean type attribute with the given name and value to the RPA Object that is under construction.

setAttribute(String, char) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new character type attribute with the given name and value to the RPA Object that is under construction.

setAttribute(String, double) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new number type attribute with the given name and value to the RPA Object that is under construction.

setAttribute(String, Date) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new date type attribute with the given name and value to the RPA Object that is under construction.

setAttribute(String, Binary) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new binary type attribute with the given name and value to the RPA Object that is under construction.

setAttribute(String, byte[]) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new binary type attribute with the given name and value to the RPA Object that is under construction.

setAttribute(Attribute) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Adds a new attribute to the RPA Object that is under construction.

setAttributes(Map<String, Attribute>) - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

setAttributes(Map<String, Attribute>) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Sets several attributes, initialized from the names and values of a java.util.Map.

setComment(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.AdditionalInfo

setName(String) - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Sets the name of the object under construction.

setPollingIntervalMillis(int) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Updates to the robot execution status as well as obtaining return values and API exception errors are updated by polling.

setPriority(QueuedRequest.Priority) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Sets the priority of the queued task as long as it is in the Management Console queue.

setProject(String) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Set the project name for this request.

setProjectName(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data

setRobotURL(String) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Sets the robotURL property.

setStopRobotOnApiException(boolean) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Specifies whether robot execution should stop if an error occurs in the robot, corresponding to the 'API Exception' checkmark as specified on a robot step.

setTag(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data

setTimeout(long) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest

Sets the timeout for how long the robot will stay in the queue while it waits for execution.

setValue(Object) - Method in class com.kapowtech.robosuite.api.java.rest.Attribute

This operation is not supported by this class, always throwing an UnsupportedOperationException.

SHORT_TEXT - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type Short Text used in Design Studio types

size() - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns the number of bytes in the array.

size() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjects

Returns the number of input objects in this list.

start() - Method in class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

Starts this runner by initializing the http client and adding the runner to the executor.

StartupCheck - Class in com.kapowtech.robosuite.api.java.repository.engine

Utility for checking java version and required jar files

StartupCheck() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.StartupCheck

stop() - Method in class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

Implementation of the stoppable for this runner.

stop() - Method in interface com.kapowtech.robosuite.api.java.rest.Stoppable

Sends the stop request.

STOP_ROBOT_URL - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.QueuedRequestRunner

Stoppable - Interface in com.kapowtech.robosuite.api.java.rest

An object that allows you to stop a robot that is executing.

T

TEXT - Static variable in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Corresponds to the ShortText and LongText data types.

toBase64String() - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns a Base64 encoded representation of the bytes in the array.

toByteArray() - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns the bytes in the object as a byte[] instance.

toJSON() - Method in class com.kapowtech.robosuite.api.java.rest.internal.OAuthRpaObjectBuilder

toJSON() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Translates this RPA object builder into JSON that can be used for calls to the tasks API on the Management Console.

toRpaObject() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObjectBuilder

Creates a new RpaObject initialized with the values placed in this object.

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Attribute

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

returns a string with all property values (subject to change, do not parse this string)

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute

returns a string with all property values (subject to change, do not parse this string)

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject

returns a string with all property values (subject to change, do not parse this string)

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.OAuthUserEntry

returns a string with all property values (subject to change, do not parse this string)

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Project

returns a string with all property values (subject to change, do not parse this string)

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot

returns a string with all property values (subject to change, do not parse this string)

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature

returns a string with all property values (subject to change, do not parse this string)

toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Type

returns a string with all property values (subject to change, do not parse this string)

toString() - Method in class com.kapowtech.robosuite.api.java.rest.Attribute

Returns a string representation of the object.

toString() - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns a human-readable string representation of this object.

toString() - Method in class com.kapowtech.robosuite.api.java.rest.ExecutionResult

Returns a string representation of the object.

toString(Object) - Method in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Returns a string representation of the given value, formatted with the settings given in this attribute type.

toString() - Method in class com.kapowtech.robosuite.api.java.rest.internal.AttributeType

Returns a string representation of this object.

toString() - Method in class com.kapowtech.robosuite.api.java.rest.RobotErrorResponse

Returns a human-readable string representation of this object.

toString() - Method in class com.kapowtech.robosuite.api.java.rest.RobotOutputObjectResponse

Returns a human-readable string representation of this object.

toString() - Method in class com.kapowtech.robosuite.api.java.rest.RpaObject

Returns a string representation of the object.

toString() - Method in class com.kapowtech.robosuite.api.java.rest.ServerErrorResponse

Returns a human-readable string representation of this object.

Type - Class in com.kapowtech.robosuite.api.java.repository.construct

A description of a type returned or stored by the robot.

Type(String, Attribute[]) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Type

Constructs a new type.

U

UNKNOWN - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

An unknown attribute type

updateFile(RepositoryFile, byte[]) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

Update existing repository file with new bytes.

updateFile(RepositoryFile, byte[], AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

updateFile(RepositoryFile, byte[]) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

Update existing repository file with new bytes.

updateFile(RepositoryFile, byte[], AdditionalInfo) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

USER_AGENT - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

V

validateResponse(HttpResponse, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

valueOf(String) - Static method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.kapowtech.robosuite.api.java.rest.QueuedRequest.Priority

Returns the enum constant of this type with the specified name.

valueOfBase64(String) - Static method in class com.kapowtech.robosuite.api.java.rest.Binary

Returns a new Binary object with a value represented by the specified Base64 encoded string.

values() - Static method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.kapowtech.robosuite.api.java.rest.QueuedRequest.Priority

Returns an array containing the constants of this enum type, in the order they are declared.

verifyRepositoryRequirements() - Static method in class com.kapowtech.robosuite.api.java.repository.engine.StartupCheck

W

writeTo(OutputStream) - Method in class com.kapowtech.robosuite.api.java.rest.Binary

Writes the contents of this object to a stream.

X

XML - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType

The attribute type XML used in Design Studio types

_

_authenticationProvider - Variable in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

_designStudioId - Variable in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

_httpClient - Variable in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

_httpParams - Variable in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

_TIMEOUT_MILLIS - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

_url - Variable in class com.kapowtech.robosuite.api.java.repository.engine.AuthenticationProvider

_url - Variable in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl

A B C D E F G H I J L M N O P Q R S T U V W X _