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

A

AbstractTestStep - Class in com.hpe.adm.nga.sdk.manualtests.teststeps
Represents a test step which can be either normal, call or validation
addEntities(String...) - Method in class com.hpe.adm.nga.sdk.metadata.GetEntityMetadata
 
addFields(String...) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntities
Add Fields parameters
addFields(String...) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntity
Set Fields Parameters
addFields(F...) - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntities
Adds fields of type F
addFields(F...) - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntity
Set Fields Parameters
addFieldsParam(String...) - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Set hte value of the "fields" param,
addHeader(APIMode) - Method in class com.hpe.adm.nga.sdk.network.OctaneRequest
 
addOrderBy(String, boolean) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntities
Add OrderBy parameters
addOrderBy(G, boolean) - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntities
Add OrderBy parameters
addPath(String) - Method in class com.hpe.adm.nga.sdk.entities.create.CreateEntities
Append a new path element, for special cases
addPath(String) - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteEntities
Append a new path element, for special cases
addPath(String) - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteEntity
Append a new path element, for special cases
addPath(String) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntities
Append a new path element, for special cases
addPath(String) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntity
Append a new path element, for special cases
addPath(String) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntities
Append a new path element, for special cases
addPath(String) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntity
Append a new path element, for special cases
AllowedReferences - Annotation Type in com.hpe.adm.nga.sdk.model
Annotation that defines the true references that are allowed for the given method When a reference field can return more than one type of reference this defines the actual sub types that are returned
and(String, QueryMethod, Object) - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Generates a builder by applying the logical "and" operator between the current builder and the resulting operation of the input values.
and(Query.QueryBuilder) - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Generates a builder by applying the logical "and" operator between the current builder and the input builder.
andNot(String, QueryMethod, Object) - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Generates a builder by applying the logical "and" operator between the current builder and the resulting operation of the input values after negation.
andNot(Query.QueryBuilder) - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Generates a builder by applying the logical "and" operator between the current builder and the input builder after negation.
APIMode - Interface in com.hpe.adm.nga.sdk
An interface that represents the API mode that should be used.
areEqual(EntityModel, EntityModel) - Method in interface com.hpe.adm.nga.sdk.model.EntityUtil.EntityEquator
 
areEqualByContent(EntityModel, EntityModel) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Check if two entities have exactly the same field models, not taking into account their order
areEqualByIdAndType(EntityModel, EntityModel) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Check if two entities are equal by id + type
areFieldModelsEqualByContent(FieldModel, FieldModel) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Aspect() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.OrderingFeature.Aspect
 
at(String) - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList
getter of specific attachment ( An Attachments object with specific id )
at(String) - Method in class com.hpe.adm.nga.sdk.entities.EntityList
getter of an Entities object ( Entities object handle a unique entity model )
attachment(EntityModel, InputStream, String, String) - Method in class com.hpe.adm.nga.sdk.attachments.CreateAttachment
Setter of new entities to create and file to upload
AttachmentList - Class in com.hpe.adm.nga.sdk.attachments
The object that represents attachments in the REST API.
AttachmentList(Octane.OctaneInternalConfiguration, String) - Constructor for class com.hpe.adm.nga.sdk.attachments.AttachmentList
Creates a new attachmentList object
attachmentList() - Method in class com.hpe.adm.nga.sdk.Octane
Creates a new attachmentList object.
AttachmentList.Attachments - Class in com.hpe.adm.nga.sdk.attachments
This class hold the Attachments objects (handle a unique Attachment model )
AttachmentsFeature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the AttachmentsFeature object and serve all functionality concern to Attachments Feature
AttachmentsFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.AttachmentsFeature
 
AuditingFeature - Class in com.hpe.adm.nga.sdk.metadata.features
Created by ngthien on 8/3/2016.
AuditingFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.AuditingFeature
 
authenticate() - Method in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
authenticate() - Method in interface com.hpe.adm.nga.sdk.network.OctaneHttpClient
Authenticate with the Octane server using an implementation of the JSONAuthentication class.
Authentication - Class in com.hpe.adm.nga.sdk.authentication
Interface of Authentication , hold contract functions.

B

BasicAuthentication - Class in com.hpe.adm.nga.sdk.authentication
Represents basic authentication
Between(Object, Object) - Constructor for class com.hpe.adm.nga.sdk.query.QueryMethod.Between
 
BooleanFieldModel - Class in com.hpe.adm.nga.sdk.model
This class hold the BooleanFieldModel objects and serve as a Boolean type FieldModel data holder
BooleanFieldModel(String, Boolean) - Constructor for class com.hpe.adm.nga.sdk.model.BooleanFieldModel
Creates a new BooleanFieldModel object
build() - Method in class com.hpe.adm.nga.sdk.Octane.Builder
The main build procedure which creates the Octane object and authenticates against the server
build() - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Builds a query from the current builder
build() - Method in class com.hpe.adm.nga.sdk.SiteAdmin.Builder
The main build procedure which creates the SiteAdmin object and authenticates against the server
Builder(Authentication) - Constructor for class com.hpe.adm.nga.sdk.Octane.Builder
Creates a new Builder object using the correct authentication
Builder(Authentication, OctaneHttpClient) - Constructor for class com.hpe.adm.nga.sdk.Octane.Builder
Creates a new Builder object using the correct authentication
Builder(Authentication) - Constructor for class com.hpe.adm.nga.sdk.SiteAdmin.Builder
Creates a new Builder object using the correct authentication
Builder(Authentication, OctaneHttpClient) - Constructor for class com.hpe.adm.nga.sdk.SiteAdmin.Builder
Creates a new Builder object using the correct authentication
BusinessRulesFeature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the BusinessRuleFeature object and serve all functionality concern to Business Rule Feature
BusinessRulesFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.BusinessRulesFeature
 

C

CallTestStep - Class in com.hpe.adm.nga.sdk.manualtests.teststeps
A test step representing calling another test (see Octane documentation) Note: The called ID is not checked by the SDK - the REST API will fail if there is a problem
CallTestStep(String, String) - Constructor for class com.hpe.adm.nga.sdk.manualtests.teststeps.CallTestStep
Callstep has two parts - the ID of the called test and an optional step
canModifyAuditable() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifyAuditable
canModifyEditable() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifyEditable
canModifyFormat() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifyFormat
canModifyLabel() - Method in class com.hpe.adm.nga.sdk.metadata.EntityMetadata
get metadata's canModifyLabel
canModifyLabel() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifyLabel
canModifyMaxLength() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifyMaxLength
canModifyRequired() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifyRequired
canModifySanitization() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifySanitization
canModifyUnique() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifyUnique
canMofidyDescription() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's CanModifyDescription
CLIENT_LOCK_STAMP_FIELD_NAME - Static variable in class com.hpe.adm.nga.sdk.model.EntityModel
Field that keeps track if the entity has changed on the server vs what is being sent from the client If it's contained in the entity model, it should always be sent back to the server (always dirty) This prevents users to overwrite other people's changes from their client side cached entity
com.hpe.adm.nga.sdk - package com.hpe.adm.nga.sdk
 
com.hpe.adm.nga.sdk.attachments - package com.hpe.adm.nga.sdk.attachments
 
com.hpe.adm.nga.sdk.authentication - package com.hpe.adm.nga.sdk.authentication
 
com.hpe.adm.nga.sdk.classfactory - package com.hpe.adm.nga.sdk.classfactory
 
com.hpe.adm.nga.sdk.entities - package com.hpe.adm.nga.sdk.entities
 
com.hpe.adm.nga.sdk.entities.create - package com.hpe.adm.nga.sdk.entities.create
 
com.hpe.adm.nga.sdk.entities.delete - package com.hpe.adm.nga.sdk.entities.delete
 
com.hpe.adm.nga.sdk.entities.get - package com.hpe.adm.nga.sdk.entities.get
 
com.hpe.adm.nga.sdk.entities.update - package com.hpe.adm.nga.sdk.entities.update
 
com.hpe.adm.nga.sdk.exception - package com.hpe.adm.nga.sdk.exception
 
com.hpe.adm.nga.sdk.manualtests - package com.hpe.adm.nga.sdk.manualtests
 
com.hpe.adm.nga.sdk.manualtests.script - package com.hpe.adm.nga.sdk.manualtests.script
 
com.hpe.adm.nga.sdk.manualtests.teststeps - package com.hpe.adm.nga.sdk.manualtests.teststeps
 
com.hpe.adm.nga.sdk.metadata - package com.hpe.adm.nga.sdk.metadata
 
com.hpe.adm.nga.sdk.metadata.features - package com.hpe.adm.nga.sdk.metadata.features
 
com.hpe.adm.nga.sdk.metadata.fieldfeatures - package com.hpe.adm.nga.sdk.metadata.fieldfeatures
 
com.hpe.adm.nga.sdk.model - package com.hpe.adm.nga.sdk.model
 
com.hpe.adm.nga.sdk.network - package com.hpe.adm.nga.sdk.network
 
com.hpe.adm.nga.sdk.network.google - package com.hpe.adm.nga.sdk.network.google
 
com.hpe.adm.nga.sdk.query - package com.hpe.adm.nga.sdk.query
 
com.hpe.adm.nga.sdk.siteadmin - package com.hpe.adm.nga.sdk.siteadmin
 
com.hpe.adm.nga.sdk.siteadmin.version - package com.hpe.adm.nga.sdk.siteadmin.version
 
CommentsFeature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the CommentsFeature object and serve all functionality concern to Comments Feature
CommentsFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.CommentsFeature
 
containsAllEntityModels(Collection<EntityModel>, Collection<EntityModel>, EntityUtil.EntityEquator) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Check if baseCollection contains all elements of sourceCollection
containsEntityModel(Collection<EntityModel>, EntityModel) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Check if a collection contains and entity model, uses EntityUtil.areEqualByIdAndType(EntityModel, EntityModel)
containsEntityModel(Collection<EntityModel>, EntityModel, EntityUtil.EntityEquator) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Check if a collection contains and entity model, can use any EntityUtil.EntityEquator
containsSameEntities(Collection<EntityModel>, Collection<EntityModel>, EntityUtil.EntityEquator) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Check if two entity collections contain the same entities
convertHttpResponseToOctaneHttpResponse(HttpResponse) - Method in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
Convert google implementation of HttpResponse to an implementation abstract OctaneHttpResponse
convertOctaneRequestToGoogleHttpRequest(OctaneHttpRequest) - Method in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
Convert the abstract OctaneHttpRequestRequest object to a specific HttpRequest for the google http client
CP7TechnicalPreviewAPIMode - Static variable in interface com.hpe.adm.nga.sdk.APIMode
Deprecated.
CP7 is nearing the end of its support and should not be used
create() - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList
getter of attachmentList create object
create() - Method in class com.hpe.adm.nga.sdk.entities.EntityList
getter of an CreateEntities object of EntityList ( EntityList object handle a collection of entity models
CreateAttachment - Class in com.hpe.adm.nga.sdk.attachments
This class hold the CreateEntities objects and serve all functions concern to REST GetEntities.
CreateAttachment(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.attachments.CreateAttachment
 
CreateEntities - Class in com.hpe.adm.nga.sdk.entities.create
This class hold the CreateEntities objects and serve all functions concern to REST Post.
CreateEntities(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.create.CreateEntities
 
CreateTypedEntities<T extends TypedEntityModel,E extends CreateTypedEntities> - Class in com.hpe.adm.nga.sdk.entities.create
The generic super class for the context of create for typed entities.
CreateTypedEntities(Class<T>, OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.create.CreateTypedEntities
 

D

DateFieldModel - Class in com.hpe.adm.nga.sdk.model
This class holds the DateFieldModel objects and serves as a ZonedDateTime type FieldModel data holder.
DateFieldModel(String, ZonedDateTime) - Constructor for class com.hpe.adm.nga.sdk.model.DateFieldModel
Creates a new DateFieldModel object
DEFAULT_OCTANE_CLASS_FACTORY_CLASS_NAME - Static variable in interface com.hpe.adm.nga.sdk.classfactory.OctaneClassFactory
Default octane class factory name.
delete() - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList.Attachments
getter of a new DeleteEntities Object
delete() - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList
getter of attachmentList DeleteEntities object ( same functionality as EntityList.DeleteEntities )
delete() - Method in class com.hpe.adm.nga.sdk.entities.EntityList
getter of an DeleteEntities object of EntityList ( EntityList object handle a collection of entity models
delete() - Method in class com.hpe.adm.nga.sdk.entities.EntityList.Entities
getter of a CreateEntities object with specific entity
DeleteEntities - Class in com.hpe.adm.nga.sdk.entities.delete
This class hold the DeleteEntities objects and serve all functions concern to REST delete.
DeleteEntities(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.delete.DeleteEntities
 
DeleteEntity - Class in com.hpe.adm.nga.sdk.entities.delete
This class hold the DeleteEntities object of one entity
DeleteEntity(OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.entities.delete.DeleteEntity
 
DeleteOctaneHttpRequest(String) - Constructor for class com.hpe.adm.nga.sdk.network.OctaneHttpRequest.DeleteOctaneHttpRequest
 
DeleteTypedEntities<T extends TypedEntityModel,E extends DeleteTypedEntities> - Class in com.hpe.adm.nga.sdk.entities.delete
The generic super class for the context of delete for typed entities.
DeleteTypedEntities(Class<T>, OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.delete.DeleteTypedEntities
 
DeleteTypedEntity<T extends TypedEntityModel> - Class in com.hpe.adm.nga.sdk.entities.delete
The generic super class for the context of delete for typed entities.
DeleteTypedEntity(Class<T>, OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.entities.delete.DeleteTypedEntity
 

E

EmptyFieldModel - Class in com.hpe.adm.nga.sdk.model
This class represents an Empty Field
EmptyFieldModel(String) - Constructor for class com.hpe.adm.nga.sdk.model.EmptyFieldModel
 
entities(Collection<EntityModel>) - Method in class com.hpe.adm.nga.sdk.entities.create.CreateEntities
Set new entities collection
entities(Collection<T>) - Method in class com.hpe.adm.nga.sdk.entities.create.CreateTypedEntities
Adds the entities to be sent to the server to be created
Entities(String) - Constructor for class com.hpe.adm.nga.sdk.entities.EntityList.Entities
Set entityId parameter
entities(Collection<EntityModel>) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntities
Set new entities collection
entities(Collection<T>) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntities
Adds the entities to be sent to the server to be updated
entities() - Method in class com.hpe.adm.nga.sdk.metadata.Metadata
GetEntities metadata entity object
entities(String...) - Method in class com.hpe.adm.nga.sdk.metadata.Metadata
GetEntities metadata entity object based on given entities names
entity(EntityModel) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntity
set a new entity for updating
entity(T) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntity
set a new entity for updating
Entity - Interface in com.hpe.adm.nga.sdk.model
An interface representing the basic Octane entity.
entityId - Variable in class com.hpe.adm.nga.sdk.entities.EntityList.Entities
 
EntityList - Class in com.hpe.adm.nga.sdk.entities
This class represents the entity context and carries out the actual server requests.
EntityList(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.EntityList
Creates a new EntityList object.
entityList(String) - Method in class com.hpe.adm.nga.sdk.Octane
Creates a new EntityList context.
entityList(Class<T>) - Method in class com.hpe.adm.nga.sdk.Octane
Creates a new TypedEntityList context.
EntityList.Entities - Class in com.hpe.adm.nga.sdk.entities
This class hold the Entities object(An object that represent one Entity )
EntityList.TestEntities - Class in com.hpe.adm.nga.sdk.entities
This class hold the Entities object but as a test for the manipulation of test scripts (An object that represent one Entity )
EntityMetadata - Class in com.hpe.adm.nga.sdk.metadata
This class hold the entity metadata object and serve all functionality concern to metadata of entities.
EntityMetadata(String, String, boolean, Collection<Feature>) - Constructor for class com.hpe.adm.nga.sdk.metadata.EntityMetadata
Creates a new EntityMetadata object
EntityMetadata - Annotation Type in com.hpe.adm.nga.sdk.model
Some useful metadata for the generated class such as available HTTP methods and the REST collection URL
EntityMetadata.AvailableMethods - Enum in com.hpe.adm.nga.sdk.model
 
EntityModel - Class in com.hpe.adm.nga.sdk.model
This class hold the EntityModel objects and server as an entity data holder entities.
EntityModel() - Constructor for class com.hpe.adm.nga.sdk.model.EntityModel
Creates a new EntityModel object All fields set after using this constructor will be considered "dirty"
EntityModel(Set<FieldModel>) - Constructor for class com.hpe.adm.nga.sdk.model.EntityModel
Creates a new EntityModel object with given field models Use this when create entity model with mass of fields.
EntityModel(Set<FieldModel>, EntityModel.EntityState) - Constructor for class com.hpe.adm.nga.sdk.model.EntityModel
Creates a new EntityModel object with given field models Use this when create entity model with mass of fields.
EntityModel(String, String) - Constructor for class com.hpe.adm.nga.sdk.model.EntityModel
Creates a new EntityModel object with solo string field The entity will be considered dirty and thus these fields will be updated
EntityModel.EntityState - Enum in com.hpe.adm.nga.sdk.model
Represents the state of the entity.
EntityUtil - Class in com.hpe.adm.nga.sdk.model
Util methods for comparing EntityModel objects.
EntityUtil() - Constructor for class com.hpe.adm.nga.sdk.model.EntityUtil
 
EntityUtil.EntityEquator - Interface in com.hpe.adm.nga.sdk.model
Interface for checking equality between two entity models
equals(Object) - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest
 
ErrorModel - Class in com.hpe.adm.nga.sdk.model
This class hold the ErrorModel objects and server as an error data holder entities.
ErrorModel(Set<FieldModel>) - Constructor for class com.hpe.adm.nga.sdk.model.ErrorModel
Creates a new ErrorModel object with given field models
exceedsTotalCount() - Method in interface com.hpe.adm.nga.sdk.entities.OctaneCollection
Whether the requested number of entities exceeds the total available number of entities
execute() - Method in class com.hpe.adm.nga.sdk.attachments.CreateAttachment
Request Post Execution with Multipart content type
execute() - Method in class com.hpe.adm.nga.sdk.attachments.GetBinaryAttachment
GetEntities Request execution of binary data
execute() - Method in class com.hpe.adm.nga.sdk.entities.create.CreateEntities
1.
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.create.CreateEntities
1.
execute() - Method in class com.hpe.adm.nga.sdk.entities.create.CreateTypedEntities
Carries out the execution and returns a collection of created entities
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.create.CreateTypedEntities
Carries out the execution and returns the entities, using a custom api mode
execute() - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteEntities
Execute a DeleteEntities request
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteEntities
1.
execute() - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteEntity
1.
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteEntity
1.
execute() - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteTypedEntities
Carries out the execution and returns a collection of deleted entities
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteTypedEntities
Carries out the execution and returns the entities, using a custom api mode
execute() - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteTypedEntity
Carries out the execution and returns the deleted entity
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteTypedEntity
Carries out the execution and returns the entity, using a custom api mode
execute() - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntities
1.
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntities
1.
execute() - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntity
1.
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntity
1.
execute() - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntities
Carries out the execution and returns the entities
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntities
Carries out the execution and returns the entities, using a custom api mode
execute() - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntity
Carries out the execution and returns the entity
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntity
Carries out the execution and returns the entity, using a custom api mode
execute() - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntities
1.
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntities
1.
execute() - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntity
1.
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntity
1.
execute() - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntities
Carries out the execution and returns the entities
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntities
Carries out the execution and returns the entities, using a custom api mode
execute() - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntity
Carries out the execution and returns the entity
execute(APIMode) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntity
Carries out the execution and returns the entity, using a custom api mode
execute() - Method in class com.hpe.adm.nga.sdk.manualtests.GetTestSteps
Calls the API and gets the returned JSON.
execute() - Method in class com.hpe.adm.nga.sdk.manualtests.UpdateTestSteps
Carries out the execution of the creation or update.
execute() - Method in class com.hpe.adm.nga.sdk.metadata.GetEntityMetadata
GetEntities Request execution of metadata's entity info Collection object
execute() - Method in class com.hpe.adm.nga.sdk.metadata.GetFieldMetadata
GetEntities Request execution of metadata's field info Collection object
execute(OctaneHttpRequest) - Method in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
execute(OctaneHttpRequest) - Method in interface com.hpe.adm.nga.sdk.network.OctaneHttpClient
 
execute() - Method in class com.hpe.adm.nga.sdk.siteadmin.version.GetServerVersion
Gets the version as an object from the server

F

Feature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the base class of all Features
Feature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.Feature
 
features() - Method in class com.hpe.adm.nga.sdk.metadata.EntityMetadata
get metadata's features
FieldMetadata - Class in com.hpe.adm.nga.sdk.metadata
This class hold the field metadata object and serve all functionality concern to metadata of fields.
FieldMetadata() - Constructor for class com.hpe.adm.nga.sdk.metadata.FieldMetadata
 
FieldMetadata - Annotation Type in com.hpe.adm.nga.sdk.model
Adds useful metadata information to the method such as whether the field is required or sortable
FieldMetadata.AccessLevel - Enum in com.hpe.adm.nga.sdk.metadata
 
FieldMetadata.FieldType - Enum in com.hpe.adm.nga.sdk.metadata
 
FieldMetadata.FieldTypeData - Class in com.hpe.adm.nga.sdk.metadata
This class hold the data structure of Field Field Type data
FieldMetadata.Target - Class in com.hpe.adm.nga.sdk.metadata
This class hold the data structure of Field Target
FieldModel<T> - Interface in com.hpe.adm.nga.sdk.model
Interface of FieldModel
fields() - Method in class com.hpe.adm.nga.sdk.metadata.Metadata
GetEntities metadata field object
fields(String...) - Method in class com.hpe.adm.nga.sdk.metadata.Metadata
GetEntities metadata field object based on given field names
FieldTypeData() - Constructor for class com.hpe.adm.nga.sdk.metadata.FieldMetadata.FieldTypeData
 
FloatFieldModel - Class in com.hpe.adm.nga.sdk.model
Created by ngthien on 8/3/2016.
FloatFieldModel(String, Float) - Constructor for class com.hpe.adm.nga.sdk.model.FloatFieldModel
 

G

get() - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList.Attachments
getter of a new GetEntities Object
get() - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList
getter of attachmentList GetEntities object
get() - Method in class com.hpe.adm.nga.sdk.entities.EntityList.Entities
getter of a GetEntities object with specific entity
get() - Method in class com.hpe.adm.nga.sdk.entities.EntityList
getter of an GetEntities object of EntityList ( EntityList object handle a collection of entity models )
get() - Method in class com.hpe.adm.nga.sdk.manualtests.TestStepList
Returns an instance of GetTestSteps in order to see test steps
get() - Method in class com.hpe.adm.nga.sdk.model.OctaneCollectionSupplier
 
get(Octane.OctaneCustomSettings.Setting) - Method in class com.hpe.adm.nga.sdk.Octane.OctaneCustomSettings
 
getAccessLevel() - Method in class com.hpe.adm.nga.sdk.metadata.features.RestFeature
get access level of the methods
getAccessLevel() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Access Level
getAction() - Method in enum com.hpe.adm.nga.sdk.query.QueryMethod
 
getAPIMode() - Method in class com.hpe.adm.nga.sdk.authentication.Authentication
Returns the API Mode header that is added to all calls to the REST API.
getAspectName() - Method in class com.hpe.adm.nga.sdk.metadata.features.OrderingFeature.Aspect
 
getAspects() - Method in class com.hpe.adm.nga.sdk.metadata.features.OrderingFeature
get aspects
getAuditable() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Auditable state
getAuthenticationId() - Method in class com.hpe.adm.nga.sdk.authentication.BasicAuthentication
The id that is used for the authentication
getAuthenticationId() - Method in class com.hpe.adm.nga.sdk.authentication.JSONAuthentication
The id that is used for the authentication
getAuthenticationId() - Method in class com.hpe.adm.nga.sdk.authentication.SimpleBasicAuthentication
 
getAuthenticationId() - Method in class com.hpe.adm.nga.sdk.authentication.SimpleClientAuthentication
 
getAuthenticationId() - Method in class com.hpe.adm.nga.sdk.authentication.SimpleUserAuthentication
 
getAuthenticationIdKey() - Method in class com.hpe.adm.nga.sdk.authentication.JSONAuthentication
The key that is used for the id (client or user)
getAuthenticationSecret() - Method in class com.hpe.adm.nga.sdk.authentication.BasicAuthentication
The secret that is used for the authentication
getAuthenticationSecret() - Method in class com.hpe.adm.nga.sdk.authentication.JSONAuthentication
The secret that is used for the authentication
getAuthenticationSecret() - Method in class com.hpe.adm.nga.sdk.authentication.SimpleBasicAuthentication
 
getAuthenticationSecret() - Method in class com.hpe.adm.nga.sdk.authentication.SimpleClientAuthentication
 
getAuthenticationSecret() - Method in class com.hpe.adm.nga.sdk.authentication.SimpleUserAuthentication
 
getAuthenticationSecretKey() - Method in class com.hpe.adm.nga.sdk.authentication.JSONAuthentication
The key that is used for the secret (client or user)
getAuthenticationString() - Method in class com.hpe.adm.nga.sdk.authentication.JSONAuthentication
Returns the authentication string for most authentication purposes.
getBinary() - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList.Attachments
GetEntities GetBinary object
GetBinaryAttachment - Class in com.hpe.adm.nga.sdk.attachments
This class hold the GetBinary objects (handle the binary data of a unique Attachment model )
GetBinaryAttachment(OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.attachments.GetBinaryAttachment
 
getBinaryContentName() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest.PostBinaryOctaneHttpRequest
 
getBinaryContentType() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest.PostBinaryOctaneHttpRequest
 
getBinaryInputStream() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest.PostBinaryOctaneHttpRequest
 
getBuildDate() - Method in class com.hpe.adm.nga.sdk.siteadmin.version.Version
The build date returned as a string.
getBuildNumber() - Method in class com.hpe.adm.nga.sdk.siteadmin.version.Version
The internal build number
getBuildRevision() - Method in class com.hpe.adm.nga.sdk.siteadmin.version.Version
The internal revision string
getCallStepString() - Method in class com.hpe.adm.nga.sdk.manualtests.teststeps.CallTestStep
The string of the optional call step
getChildTypes() - Method in class com.hpe.adm.nga.sdk.metadata.features.HierarchyFeature
get Child Types
getContent() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpResponse
Parses the content of the HTTP response from getContent() and reads it into a string.
getContextFieldName() - Method in class com.hpe.adm.nga.sdk.metadata.features.OrderingFeature.Aspect
 
getCreationTime() - Method in class com.hpe.adm.nga.sdk.manualtests.script.GetTestScriptModel
Label: Creation Time Description: The date and time the script was created, according to the ISO-8601 date format.
getDescription() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Description
getDisplayVersion() - Method in class com.hpe.adm.nga.sdk.siteadmin.version.Version
The final displayable version
getEditable() - Method in class com.hpe.adm.nga.sdk.metadata.features.SubTypesFeature
get editable
GetEntities - Class in com.hpe.adm.nga.sdk.entities.get
This class hold the GetEntities objects and serve all functions concern to REST GetEntities.
GetEntities(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.get.GetEntities
 
getEntities(String) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
get a entity model collection based on a given json string
getEntitiesJSONObject(Collection<EntityModel>) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
get a new json object based on a given EntityModel list
getEntitiesJSONObject(Collection<EntityModel>, boolean) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
get a new json object based on a given EntityModel list
getEntitiesModels() - Method in exception com.hpe.adm.nga.sdk.exception.OctanePartialException
getter of collection of entities models
getEntitiesResponse(OctaneHttpRequest) - Method in class com.hpe.adm.nga.sdk.network.OctaneRequest
get entities result based on Http Request
GetEntity - Class in com.hpe.adm.nga.sdk.entities.get
This class hold the GetEntities object of one entity
GetEntity(OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.entities.get.GetEntity
 
getEntityInstance(EntityModel) - Method in class com.hpe.adm.nga.sdk.entities.TypedEntityList.TypedEntityRequest
 
getEntityJSONObject(EntityModel) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
get a new json object based on a given EntityModel object
getEntityJSONObject(EntityModel, boolean) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
get a new json object based on a given EntityModel object
getEntityList(OctaneHttpClient, String, String) - Method in interface com.hpe.adm.nga.sdk.classfactory.OctaneClassFactory
Get the implementation of the EntityList used by the Octane object
getEntityList(OctaneHttpClient, String, Class<T>) - Method in interface com.hpe.adm.nga.sdk.classfactory.OctaneClassFactory
 
GetEntityMetadata - Class in com.hpe.adm.nga.sdk.metadata
This class hold the entity metadata object
GetEntityMetadata(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.metadata.GetEntityMetadata
Creates a new entity object
getEntityModel(JSONObject) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
get a new EntityModel object based on json object
getEntityName() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Entity Name
getEntityResponse(OctaneHttpRequest) - Method in class com.hpe.adm.nga.sdk.network.OctaneRequest
get entity result based on Http Request
getError() - Method in exception com.hpe.adm.nga.sdk.exception.OctaneException
get error model
getErrorModelFromjson(String) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
GetEntities Error model based on a given error json string
getErrorModelFromServletJson(String) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
Parses the servlet error and extracts the underlying message that was set by Octane that can then be used by the exception
getErrorModels() - Method in exception com.hpe.adm.nga.sdk.exception.OctanePartialException
getter of collection of error models
getErrorModels(String) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
GetEntities Error models based on a given error json string
getFieldFeatures() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's field features
GetFieldMetadata - Class in com.hpe.adm.nga.sdk.metadata
This class hold the field metadata object
GetFieldMetadata(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.metadata.GetFieldMetadata
Creates a new Field object
getFieldName() - Method in interface com.hpe.adm.nga.sdk.entities.TypedEntityList.AvailableFields
The name of a field
getFieldName() - Method in interface com.hpe.adm.nga.sdk.entities.TypedEntityList.SortableFields
The name of a field
getFieldType() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's field Type
getFieldTypedata() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Field Type data
getFinalRequestUrl() - Method in class com.hpe.adm.nga.sdk.network.OctaneRequest
 
getFormat() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's format
getHeaderKey() - Method in interface com.hpe.adm.nga.sdk.APIMode
The header key that is sent
getHeaders() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest
 
getHeaders() - Method in class com.hpe.adm.nga.sdk.network.OctaneRequest
 
getHeaderValue() - Method in interface com.hpe.adm.nga.sdk.APIMode
The header value that is sent
getHttpRequestRetryCount() - Static method in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
getId() - Method in class com.hpe.adm.nga.sdk.manualtests.script.GetTestScriptModel
 
getId() - Method in class com.hpe.adm.nga.sdk.manualtests.script.UpdateTestScriptModel
 
getId() - Method in class com.hpe.adm.nga.sdk.metadata.features.HierarchyFeature.Root
get id
getId() - Method in interface com.hpe.adm.nga.sdk.model.Entity
Returns the ID of the entity.
getId() - Method in class com.hpe.adm.nga.sdk.model.EntityModel
 
getId() - Method in class com.hpe.adm.nga.sdk.model.ReferenceErrorModel.ReferenceError
get id
getImplementation(String) - Static method in interface com.hpe.adm.nga.sdk.classfactory.OctaneClassFactory
Get the implementation implementation of OctaneClassFactory, can be modified by sending the class factory name or setting the OCTANE_CLASS_FACTORY_CLASS_NAME system param.
getInputStream() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpResponse
Returns the content of the HTTP response.
getInstance() - Static method in class com.hpe.adm.nga.sdk.model.ModelParser
 
getLabel() - Method in class com.hpe.adm.nga.sdk.metadata.EntityMetadata
get metadata's label
getLabel() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Label
getLastModified() - Method in class com.hpe.adm.nga.sdk.manualtests.script.GetTestScriptModel
Label: Last modified Description: The date and time the script was last modified, according to the ISO-8601 date format.
getMaxLength() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Max Length
getMaxValue() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's max value
getMessage() - Method in exception com.hpe.adm.nga.sdk.exception.OctaneException
 
getMethods() - Method in class com.hpe.adm.nga.sdk.metadata.features.RestFeature
get supported methods
getMinValue() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's min value
getName() - Method in class com.hpe.adm.nga.sdk.metadata.EntityMetadata
get metadata name
getName() - Method in class com.hpe.adm.nga.sdk.metadata.features.Feature
get feature name
getName() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's name
getName() - Method in class com.hpe.adm.nga.sdk.model.BooleanFieldModel
get Field's name
getName() - Method in class com.hpe.adm.nga.sdk.model.DateFieldModel
get Field's name
getName() - Method in class com.hpe.adm.nga.sdk.model.EmptyFieldModel
 
getName() - Method in interface com.hpe.adm.nga.sdk.model.FieldModel
 
getName() - Method in class com.hpe.adm.nga.sdk.model.FloatFieldModel
 
getName() - Method in class com.hpe.adm.nga.sdk.model.LongFieldModel
get Field's name
getName() - Method in class com.hpe.adm.nga.sdk.model.MultiReferenceFieldModel
get name
getName() - Method in class com.hpe.adm.nga.sdk.model.ReferenceErrorModel
get name
getName() - Method in class com.hpe.adm.nga.sdk.model.ReferenceFieldModel
GetEntities name
getName() - Method in class com.hpe.adm.nga.sdk.model.StringFieldModel
get name
getOctaneClassFactoryClassName() - Method in class com.hpe.adm.nga.sdk.Octane.OctaneInternalConfiguration
Returns the class string of the OctaneClassFactory
getOctaneHttpClient() - Method in class com.hpe.adm.nga.sdk.Octane.OctaneInternalConfiguration
Returns the instance of the OctaneHttpClient
GetOctaneHttpRequest(String) - Constructor for class com.hpe.adm.nga.sdk.network.OctaneHttpRequest.GetOctaneHttpRequest
 
getOctaneRequestMethod() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest
 
getOctaneUrl() - Method in class com.hpe.adm.nga.sdk.network.OctaneRequest
 
getOrderFieldName() - Method in class com.hpe.adm.nga.sdk.metadata.features.OrderingFeature.Aspect
 
getParam(String) - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Get the value of the query param
getParentTypes() - Method in class com.hpe.adm.nga.sdk.metadata.features.HierarchyFeature
get Parent Types
getPaths() - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Return the current paths
getQueryString() - Method in class com.hpe.adm.nga.sdk.query.Query
Accessor method of query string
getRelationName() - Method in class com.hpe.adm.nga.sdk.metadata.features.AttachmentsFeature
get relation name
getRelationName() - Method in class com.hpe.adm.nga.sdk.metadata.features.CommentsFeature
 
getRequestUrl() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest
 
getRootEnt() - Method in class com.hpe.adm.nga.sdk.metadata.features.HierarchyFeature
get Root Types
getSanitization() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Sanitization state
getServer() - Method in class com.hpe.adm.nga.sdk.SiteAdmin
Gets an instance of the server API.
getServerVersion() - Method in class com.hpe.adm.nga.sdk.siteadmin.Server
Gets the API for server version
GetServerVersion - Class in com.hpe.adm.nga.sdk.siteadmin.version
This returns an instance to get the version from the server Corresponds to
GetServerVersion(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.siteadmin.version.GetServerVersion
Get the server version instance
getSiteAdmin() - Method in class com.hpe.adm.nga.sdk.SiteAdmin.Builder
 
getTargets() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata.FieldTypeData
 
getTestId() - Method in class com.hpe.adm.nga.sdk.manualtests.teststeps.CallTestStep
The test ID
GetTestScriptModel - Class in com.hpe.adm.nga.sdk.manualtests.script
A model that represents a script that is received by the server.
GetTestScriptModel(EntityModel) - Constructor for class com.hpe.adm.nga.sdk.manualtests.script.GetTestScriptModel
Constructor
getTestStep() - Method in class com.hpe.adm.nga.sdk.manualtests.teststeps.AbstractTestStep
The step without the prefix
getTestSteps() - Method in class com.hpe.adm.nga.sdk.entities.EntityList.TestEntities
An instance of TestStepList for access to the script of the test
GetTestSteps - Class in com.hpe.adm.nga.sdk.manualtests
A class which represents test steps (script) from the API.
getTestStepsAsObjects() - Method in class com.hpe.adm.nga.sdk.manualtests.script.GetTestScriptModel
Returns the test steps from the server as objects.
getTestStepsAsString() - Method in class com.hpe.adm.nga.sdk.manualtests.script.GetTestScriptModel
Returns the test steps from the server as the native string
getTestStepString() - Method in class com.hpe.adm.nga.sdk.manualtests.teststeps.AbstractTestStep
Returns the step as a string including the prefix
getTotalCount() - Method in interface com.hpe.adm.nga.sdk.entities.OctaneCollection
The total count of available entities that answer to the current query
getType() - Method in class com.hpe.adm.nga.sdk.metadata.EntityMetadata
get metadata's type
getType() - Method in class com.hpe.adm.nga.sdk.metadata.features.HierarchyFeature.Root
get type
getType() - Method in class com.hpe.adm.nga.sdk.metadata.features.SubTypesOfFeature
get types
getType() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get Type
getType() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata.Target
 
getType() - Method in interface com.hpe.adm.nga.sdk.model.Entity
Returns the type of the entity.
getType() - Method in class com.hpe.adm.nga.sdk.model.EntityModel
 
gettype() - Method in class com.hpe.adm.nga.sdk.model.ReferenceErrorModel.ReferenceError
get type
getType() - Method in class com.hpe.adm.nga.sdk.model.TypedEntityModel
Returns the type of this entity
GetTypedEntities<T extends TypedEntityModel,E extends GetTypedEntities,F extends TypedEntityList.AvailableFields,G extends TypedEntityList.SortableFields> - Class in com.hpe.adm.nga.sdk.entities.get
The generic super class for the context of get for typed entities.
GetTypedEntities(Class<T>, OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.get.GetTypedEntities
 
GetTypedEntity<T extends TypedEntityModel,E extends GetTypedEntity,F extends TypedEntityList.AvailableFields> - Class in com.hpe.adm.nga.sdk.entities.get
The generic super class for the context of get for typed entities.
GetTypedEntity(Class<T>, OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.entities.get.GetTypedEntity
 
getTypes() - Method in class com.hpe.adm.nga.sdk.metadata.features.SubTypesFeature
get types
getTypes() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata.Target
 
getUrl() - Method in class com.hpe.adm.nga.sdk.metadata.features.RestFeature
get url
getValue() - Method in class com.hpe.adm.nga.sdk.model.BooleanFieldModel
get value
getValue() - Method in class com.hpe.adm.nga.sdk.model.DateFieldModel
get the date in the UTC time zone
getValue() - Method in class com.hpe.adm.nga.sdk.model.EmptyFieldModel
 
getValue(String) - Method in class com.hpe.adm.nga.sdk.model.EntityModel
getter of single field
getValue() - Method in interface com.hpe.adm.nga.sdk.model.FieldModel
 
getValue() - Method in class com.hpe.adm.nga.sdk.model.FloatFieldModel
 
getValue() - Method in class com.hpe.adm.nga.sdk.model.LongFieldModel
get value
getValue() - Method in class com.hpe.adm.nga.sdk.model.MultiReferenceFieldModel
get value
getValue() - Method in class com.hpe.adm.nga.sdk.model.ReferenceErrorModel
get value
getValue() - Method in class com.hpe.adm.nga.sdk.model.ReferenceFieldModel
GetEntities Value
getValue() - Method in class com.hpe.adm.nga.sdk.model.StringFieldModel
get value
getValues() - Method in class com.hpe.adm.nga.sdk.model.EntityModel
getter of entity value
getVersion() - Method in class com.hpe.adm.nga.sdk.siteadmin.version.Version
Gets the version as a MAJOR.MINOR.PATH.BUILD string
getWrappedEntityModel() - Method in class com.hpe.adm.nga.sdk.model.TypedEntityModel
Returns the wrapped EntityModel
GoogleHttpClient - Class in com.hpe.adm.nga.sdk.network.google
HTTP Client using Google's API
GoogleHttpClient(String, Authentication) - Constructor for class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
GoogleHttpClient(String, Authentication, Octane.OctaneCustomSettings) - Constructor for class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
Constructor accepting custom settings for the underlying http transport layer
GroupingFeature - Class in com.hpe.adm.nga.sdk.metadata.features
Created by ngthien on 8/3/2016.
GroupingFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.GroupingFeature
 

H

hasErrorModel(String) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
Checks the message for an error
hasErrorModels(String) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
Checks the message for a list of errors
hashCode() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest
 
hasParam(String) - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Check whether the query param with paramName has already been set via OctaneUrl.setParam(String, String)
hasServletError(String) - Method in class com.hpe.adm.nga.sdk.model.ModelParser
Checks the message for a higher-level servlet error
hasValue() - Method in class com.hpe.adm.nga.sdk.model.EmptyFieldModel
 
hasValue() - Method in interface com.hpe.adm.nga.sdk.model.FieldModel
 
HierarchyFeature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the HierarchyFeature object and serve all functionality concern to Hierarchy Feature
HierarchyFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.HierarchyFeature
 
HierarchyFeature.Root - Class in com.hpe.adm.nga.sdk.metadata.features
Root Data structure
HTTP_STATUS_CODE_PROPERTY_NAME - Static variable in class com.hpe.adm.nga.sdk.model.ErrorModel
 

I

ID_FIELD_NAME - Static variable in class com.hpe.adm.nga.sdk.model.EntityModel
ID field, should always be sent to the server (always dirty)
isAccessibleViaBusinessRules() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's VisibleInUI
isBasicAuthentication() - Method in class com.hpe.adm.nga.sdk.authentication.Authentication
Returns whether this authentication type supports basic authentication
isEditable() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Editable state
isFilterable() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Filterable state
isFinal() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's final state
isGroupable() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Groupable state
isMultiple() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata.FieldTypeData
 
isRequired() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Required state
isReturnByDefault() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's ReturnByDefault state
isSelectable() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Selectable state
isSortable() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Sortable state
isSuccessStatusCode() - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpResponse
 
isUnique() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's Unique state
isUserDefined() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's UserDefined
isVisibleInUI() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata
get FieldMetadata's VisibleInUI

J

JSON_CONTENT_TYPE - Static variable in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest
 
JSONAuthentication - Class in com.hpe.adm.nga.sdk.authentication
An abstract class to use the authentication with a mode set for implementing JSON Authentication This can be overidden if the authentication details are kept obtained in a different manner

L

lastSuccessfulAuthTimestamp - Variable in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
lastUsedAuthentication - Variable in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
limit(int) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntities
Add Limit parameter
limit(int) - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntities
Add Limit parameter
logicalName() - Method in class com.hpe.adm.nga.sdk.metadata.FieldMetadata.Target
 
LongFieldModel - Class in com.hpe.adm.nga.sdk.model
This class hold the LongFieldModel objects and serve as a long type FieldModel data holder
LongFieldModel(String, Long) - Constructor for class com.hpe.adm.nga.sdk.model.LongFieldModel
Creates a new LongFieldModel object
LWSSO_COOKIE_KEY - Static variable in interface com.hpe.adm.nga.sdk.network.OctaneHttpClient
 
lwssoValue - Variable in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 

M

MailingFeature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the MailingFeature object and serve all functionality concern to mailing Feature
MailingFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.MailingFeature
 
Metadata - Class in com.hpe.adm.nga.sdk.metadata
This class hold the metadata object and serves all functionality concern to fields metadata and entity metadata.
Metadata(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.metadata.Metadata
Creates a new Metadata object
metadata() - Method in class com.hpe.adm.nga.sdk.Octane
Creates a new Metadata object.
ModelParser - Class in com.hpe.adm.nga.sdk.model
 
MultiReferenceFieldModel - Class in com.hpe.adm.nga.sdk.model
This class hold the MultiReferenceFieldModel objects and serve as a multi reference type FieldModel data holder
MultiReferenceFieldModel(String, Collection<EntityModel>) - Constructor for class com.hpe.adm.nga.sdk.model.MultiReferenceFieldModel
Creates a new MultiReferenceFieldModel object

N

NO_ENTITY - Static variable in class com.hpe.adm.nga.sdk.Octane
 
NO_TOTAL_COUNT_SET - Static variable in interface com.hpe.adm.nga.sdk.entities.OctaneCollection
Returned when the total count field has not been set
NO_WORKSPACE_ID - Static variable in class com.hpe.adm.nga.sdk.Octane
 
not(String, QueryMethod, Object) - Static method in class com.hpe.adm.nga.sdk.query.Query
QueryBuilder not

O

OAUTH_AUTH_URL - Static variable in interface com.hpe.adm.nga.sdk.network.OctaneHttpClient
 
OAUTH_SIGNOUT_URL - Static variable in interface com.hpe.adm.nga.sdk.network.OctaneHttpClient
 
ObjectFieldModel - Class in com.hpe.adm.nga.sdk.model
This class hold the ObjectFieldModel objects.
ObjectFieldModel(String, String) - Constructor for class com.hpe.adm.nga.sdk.model.ObjectFieldModel
Creates a new StringFieldModel object
Octane - Class in com.hpe.adm.nga.sdk
This class represents the main Octane context.
Octane.Builder - Class in com.hpe.adm.nga.sdk
This class is used to create an Octane instance for normal API usage.
Octane.OctaneCustomSettings - Class in com.hpe.adm.nga.sdk
Octane settings holder containing lower level configurations
Octane.OctaneCustomSettings.Setting - Enum in com.hpe.adm.nga.sdk
 
Octane.OctaneInternalConfiguration - Class in com.hpe.adm.nga.sdk
Used to aggregate internal configurations that need to be passed around
OCTANE_CLASS_FACTORY_CLASS_NAME - Static variable in interface com.hpe.adm.nga.sdk.classfactory.OctaneClassFactory
OCTANE_USER_COOKIE_KEY - Static variable in interface com.hpe.adm.nga.sdk.network.OctaneHttpClient
 
OctaneClassFactory - Interface in com.hpe.adm.nga.sdk.classfactory
Factory for the Octane class, can implemented by clients to modify the behaviour of the sdk Implementations of this class are required to be singleton If you specify a the system param for OctaneClassFactory.getImplementation(String), this method is called to instantiate the class
OctaneClassFactoryClassName(String) - Method in class com.hpe.adm.nga.sdk.Octane.Builder
Sets the OctaneClassFactoryName.
OctaneCollection<T extends Entity> - Interface in com.hpe.adm.nga.sdk.entities
An extension of the Collection interface that incorporates important metadata about the collection that has been returned.
OctaneCollectionSupplier<T extends Entity> - Class in com.hpe.adm.nga.sdk.model
Implementation of the Supplier that returns a new OctaneCollection
OctaneCollectionSupplier(OctaneCollection<? extends Entity>) - Constructor for class com.hpe.adm.nga.sdk.model.OctaneCollectionSupplier
The original collection that will be converted.
OctaneCustomSettings() - Constructor for class com.hpe.adm.nga.sdk.Octane.OctaneCustomSettings
 
OctaneException - Exception in com.hpe.adm.nga.sdk.exception
This extends the RuntimeException objects and serve all functionality concern to Octane Exceptions.
OctaneException(ErrorModel) - Constructor for exception com.hpe.adm.nga.sdk.exception.OctaneException
Creates a new OctaneException object based on error model
octaneHttpClient - Variable in class com.hpe.adm.nga.sdk.entities.EntityList
 
OctaneHttpClient - Interface in com.hpe.adm.nga.sdk.network
HTTP Client Created by leufl on 2/11/2016.
octaneHttpClient - Variable in class com.hpe.adm.nga.sdk.network.OctaneRequest
 
OctaneHttpClient(OctaneHttpClient) - Method in class com.hpe.adm.nga.sdk.Octane.Builder
Sets the OctaneHttpClient instance.
octaneHttpClient - Variable in class com.hpe.adm.nga.sdk.SiteAdmin.Builder
 
OctaneHttpRequest - Class in com.hpe.adm.nga.sdk.network
HTTP request.
OctaneHttpRequest.DeleteOctaneHttpRequest - Class in com.hpe.adm.nga.sdk.network
 
OctaneHttpRequest.GetOctaneHttpRequest - Class in com.hpe.adm.nga.sdk.network
 
OctaneHttpRequest.OctaneRequestMethod - Enum in com.hpe.adm.nga.sdk.network
 
OctaneHttpRequest.PostBinaryOctaneHttpRequest - Class in com.hpe.adm.nga.sdk.network
 
OctaneHttpRequest.PostOctaneHttpRequest - Class in com.hpe.adm.nga.sdk.network
 
OctaneHttpRequest.PutOctaneHttpRequest - Class in com.hpe.adm.nga.sdk.network
 
OctaneHttpResponse - Class in com.hpe.adm.nga.sdk.network
HTTP response.
OctaneHttpResponse(int, InputStream, Charset) - Constructor for class com.hpe.adm.nga.sdk.network.OctaneHttpResponse
 
OctaneInternalConfiguration() - Constructor for class com.hpe.adm.nga.sdk.Octane.OctaneInternalConfiguration
 
OctanePartialException - Exception in com.hpe.adm.nga.sdk.exception
This extends the RuntimeException objects and serve all functionality concern to Octane Partial Exceptions ( an exception that contain error and entities data )
OctanePartialException(Collection<ErrorModel>, Collection<EntityModel>) - Constructor for exception com.hpe.adm.nga.sdk.exception.OctanePartialException
Creates a new OctanePartialException object based on errors and entities models
octaneRequest - Variable in class com.hpe.adm.nga.sdk.entities.get.GetEntities
 
OctaneRequest - Class in com.hpe.adm.nga.sdk.network
An abstract representation of a request
OctaneRequest(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.network.OctaneRequest
 
OctaneRequest(OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.network.OctaneRequest
 
OctaneUrl - Class in com.hpe.adm.nga.sdk.network
Utility class for building URLs for the implementation of the OctaneHttpClient
octaneUserValue - Variable in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
OCTET_STREAM_CONTENT_TYPE - Static variable in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest
 
offset(int) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntities
Add offset parameter
offset(int) - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntities
Add offset parameter
or(String, QueryMethod, Object) - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Generates a builder by applying the logical "or" operator between the current builder and the resulting operation of the input values.
or(Query.QueryBuilder) - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Generates a builder by applying the logical "or" operator between the current builder and the input builder.
OrderingFeature - Class in com.hpe.adm.nga.sdk.metadata.features
Created by ngthien on 8/3/2016.
OrderingFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.OrderingFeature
 
OrderingFeature.Aspect - Class in com.hpe.adm.nga.sdk.metadata.features
 
orNot(String, QueryMethod, Object) - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Generates a builder by applying the logical "or" operator between the current builder and the resulting operation of the input values after negation.
orNot(Query.QueryBuilder) - Method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Generates a builder by applying the logical "or" operator between the current builder and the input builder after negation.

P

parenthesis(Query.QueryBuilder) - Static method in class com.hpe.adm.nga.sdk.query.Query.QueryBuilder
Wraps current builder content into a parenthesis
parseTestSteps(String) - Static method in class com.hpe.adm.nga.sdk.manualtests.teststeps.TestStepParser
Create a list of objects representing the steps
PhasesFeature - Class in com.hpe.adm.nga.sdk.metadata.features
Created by ngthien on 8/3/2016.
PhasesFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.PhasesFeature
 
PostBinaryOctaneHttpRequest(String, InputStream, String, String, String) - Constructor for class com.hpe.adm.nga.sdk.network.OctaneHttpRequest.PostBinaryOctaneHttpRequest
 
PostOctaneHttpRequest(String, String, String) - Constructor for class com.hpe.adm.nga.sdk.network.OctaneHttpRequest.PostOctaneHttpRequest
 
PREFIX - Static variable in class com.hpe.adm.nga.sdk.manualtests.teststeps.CallTestStep
The prefix for the call step
PREFIX - Static variable in class com.hpe.adm.nga.sdk.manualtests.teststeps.TestStep
The Prefix of a normal test step
PREFIX - Static variable in class com.hpe.adm.nga.sdk.manualtests.teststeps.ValidationTestStep
The prefix for the validation test step
PutOctaneHttpRequest(String, String, String) - Constructor for class com.hpe.adm.nga.sdk.network.OctaneHttpRequest.PutOctaneHttpRequest
 

Q

query(Query) - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteEntities
UpdateEntities DeleteEntities with new Query parameters
query(Query) - Method in class com.hpe.adm.nga.sdk.entities.delete.DeleteTypedEntities
 
query(Query) - Method in class com.hpe.adm.nga.sdk.entities.get.GetEntities
 
query(Query) - Method in class com.hpe.adm.nga.sdk.entities.get.GetTypedEntities
 
query(Query) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateEntities
UpdateEntities query parameters
query(Query) - Method in class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntities
 
Query - Class in com.hpe.adm.nga.sdk.query
The class to build complex queries.
Query() - Constructor for class com.hpe.adm.nga.sdk.query.Query
 
Query.QueryBuilder - Class in com.hpe.adm.nga.sdk.query
Object that is used to build Query objects.
QueryMethod - Enum in com.hpe.adm.nga.sdk.query
Used to define the comparison methods that can be used for the Query.QueryBuilder
QueryMethod.Between - Class in com.hpe.adm.nga.sdk.query
 
queryString - Variable in class com.hpe.adm.nga.sdk.query.Query
 

R

ReferenceError(long, String) - Constructor for class com.hpe.adm.nga.sdk.model.ReferenceErrorModel.ReferenceError
Creates a new ReferenceError object
ReferenceErrorModel - Class in com.hpe.adm.nga.sdk.model
This class hold the ReferenceErrorModel objects and serve as a ReferenceError type FieldModel data holder
ReferenceErrorModel(String, ReferenceErrorModel.ReferenceError) - Constructor for class com.hpe.adm.nga.sdk.model.ReferenceErrorModel
Creates a new ReferenceErrorModel object
ReferenceErrorModel.ReferenceError - Class in com.hpe.adm.nga.sdk.model
data structure for referenceError
ReferenceFieldModel - Class in com.hpe.adm.nga.sdk.model
This class hold the ReferenceFieldModel objects and serve as a ReferenceField type FieldModel data holder
ReferenceFieldModel(String, EntityModel) - Constructor for class com.hpe.adm.nga.sdk.model.ReferenceFieldModel
Creates a new ReferenceFieldModel object
removeEntityModel(Collection<EntityModel>, EntityModel) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Remove an entity model from a collection, uses EntityUtil.areEqualByIdAndType(EntityModel, EntityModel)
removeEntityModel(Collection<EntityModel>, EntityModel, EntityUtil.EntityEquator) - Static method in class com.hpe.adm.nga.sdk.model.EntityUtil
Remove an entity model from a collection, can use any EntityUtil.EntityEquator
removeHeader(APIMode) - Method in class com.hpe.adm.nga.sdk.network.OctaneRequest
 
removeValue(String) - Method in class com.hpe.adm.nga.sdk.model.EntityModel
Remove a value from completely, different from setting the value to null
requestFactory - Variable in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
requestInitializer - Variable in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
Request initializer called on every request made by the requestFactory
RestFeature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the RestFeature object and serve all functionality concern to rest Feature
RestFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.RestFeature
 
Root() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.HierarchyFeature.Root
 

S

Server(String, int) - Method in class com.hpe.adm.nga.sdk.Octane.Builder
Sets the domain and the port.
Server(String) - Method in class com.hpe.adm.nga.sdk.Octane.Builder
Sets the domain and the port.
Server(String, int) - Method in class com.hpe.adm.nga.sdk.SiteAdmin.Builder
Sets the domain and the port.
Server(String) - Method in class com.hpe.adm.nga.sdk.SiteAdmin.Builder
Sets the domain and the port.
Server - Class in com.hpe.adm.nga.sdk.siteadmin
Creates an instance that represents the server API
Server(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.siteadmin.Server
Creates a new Server object
set(Octane.OctaneCustomSettings.Setting, Object) - Method in class com.hpe.adm.nga.sdk.Octane.OctaneCustomSettings
 
setComment(String) - Method in class com.hpe.adm.nga.sdk.manualtests.script.UpdateTestScriptModel
Sets the comment for the script
setDqlQueryParam(Query) - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Set a param named "query" that is used to filter data
setHeaders(Set<APIMode>) - Method in class com.hpe.adm.nga.sdk.network.OctaneHttpRequest
 
setLimitParam(int) - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Set query param named "limit", for the Octane API it controls max number of results returned from the data-set,
can be used for pagination together with OctaneUrl.setOffsetParam(int)
setName(String) - Method in class com.hpe.adm.nga.sdk.metadata.features.Feature
set feature name
setName(String) - Method in class com.hpe.adm.nga.sdk.model.MultiReferenceFieldModel
set name
setOffsetParam(int) - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Set query param named "offset", for the Octane API it controls the offset from the fist entity of the data-set,
can be used for pagination together with OctaneUrl.setLimitParam(int)
setOrderByParam(String, boolean) - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Set the value of the "order_by" param
setParam(String, String) - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Set query param
setRevisionType(UpdateTestScriptModel.TestScriptRevisionType) - Method in class com.hpe.adm.nga.sdk.manualtests.script.UpdateTestScriptModel
Sets the revision type for the script
setTestSteps(List<AbstractTestStep>) - Method in class com.hpe.adm.nga.sdk.manualtests.script.UpdateTestScriptModel
Sets the test steps to update represented as objects Do NOT use for gherkin tests - they should be uploaded as a simple string with the Gherkin script
setTestSteps(String) - Method in class com.hpe.adm.nga.sdk.manualtests.script.UpdateTestScriptModel
Sets the test steps to update represented as a simple JSON string (needs to confirm to the format as seen in the documentation)
settings(Octane.OctaneCustomSettings) - Method in class com.hpe.adm.nga.sdk.Octane.Builder
Configure a settings provider with custom settings like: readTimeout
setValue(String, Boolean) - Method in class com.hpe.adm.nga.sdk.model.BooleanFieldModel
set Field's name/value
setValue(String, ZonedDateTime) - Method in class com.hpe.adm.nga.sdk.model.DateFieldModel
set Field's name/value.
setValue(String, Object) - Method in class com.hpe.adm.nga.sdk.model.EmptyFieldModel
 
setValue(FieldModel) - Method in class com.hpe.adm.nga.sdk.model.EntityModel
setter of single field, update if field exists
setValue(String, T) - Method in interface com.hpe.adm.nga.sdk.model.FieldModel
 
setValue(String, Float) - Method in class com.hpe.adm.nga.sdk.model.FloatFieldModel
 
setValue(String, Long) - Method in class com.hpe.adm.nga.sdk.model.LongFieldModel
set Field's name/value
setValue(String, Collection<EntityModel>) - Method in class com.hpe.adm.nga.sdk.model.MultiReferenceFieldModel
set name/value;
setValue(String, ReferenceErrorModel.ReferenceError) - Method in class com.hpe.adm.nga.sdk.model.ReferenceErrorModel
set value
setValue(String, EntityModel) - Method in class com.hpe.adm.nga.sdk.model.ReferenceFieldModel
Set name/value
setValue(String, String) - Method in class com.hpe.adm.nga.sdk.model.StringFieldModel
set value - name/value
setValues(Set<FieldModel>) - Method in class com.hpe.adm.nga.sdk.model.EntityModel
setter of new entity value, all old fields are cleared
setValues(long, String) - Method in class com.hpe.adm.nga.sdk.model.ReferenceErrorModel.ReferenceError
set value
sharedSpace(UUID) - Method in class com.hpe.adm.nga.sdk.Octane.Builder
Sets the shared_space id to be a UUID object
sharedSpace(long) - Method in class com.hpe.adm.nga.sdk.Octane.Builder
Sets the shared_space id to be a long
signOut() - Method in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
signOut() - Method in interface com.hpe.adm.nga.sdk.network.OctaneHttpClient
Signs out and removes cookies
signOut() - Method in class com.hpe.adm.nga.sdk.Octane
Signs out of the Octane server.
SimpleBasicAuthentication - Class in com.hpe.adm.nga.sdk.authentication
Basic implementation for using basic authentication with Octane.
SimpleBasicAuthentication(String, String, APIMode) - Constructor for class com.hpe.adm.nga.sdk.authentication.SimpleBasicAuthentication
 
SimpleBasicAuthentication(String, String) - Constructor for class com.hpe.adm.nga.sdk.authentication.SimpleBasicAuthentication
 
SimpleClientAuthentication - Class in com.hpe.adm.nga.sdk.authentication
Default class to enable api key authentications Created by brucesp on 23/05/2016.
SimpleClientAuthentication(String, String, APIMode) - Constructor for class com.hpe.adm.nga.sdk.authentication.SimpleClientAuthentication
 
SimpleClientAuthentication(String, String) - Constructor for class com.hpe.adm.nga.sdk.authentication.SimpleClientAuthentication
 
SimpleUserAuthentication - Class in com.hpe.adm.nga.sdk.authentication
Default class to enable user authentications Created by brucesp on 23/05/2016.
SimpleUserAuthentication(String, String, APIMode) - Constructor for class com.hpe.adm.nga.sdk.authentication.SimpleUserAuthentication
 
SimpleUserAuthentication(String, String) - Constructor for class com.hpe.adm.nga.sdk.authentication.SimpleUserAuthentication
 
SiteAdmin - Class in com.hpe.adm.nga.sdk
Represents the octane site admin APIs.
SiteAdmin.Builder - Class in com.hpe.adm.nga.sdk
This class is used to create an SiteAdmin instance for site admin API usage.
statement(String, QueryMethod, Object) - Static method in class com.hpe.adm.nga.sdk.query.Query
QueryBuilder Statement
StringFieldModel - Class in com.hpe.adm.nga.sdk.model
This class hold the StringFieldModel objects and serve as a string type FieldModel data holder
StringFieldModel(String, String) - Constructor for class com.hpe.adm.nga.sdk.model.StringFieldModel
Creates a new StringFieldModel object
SubTypesFeature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the SubTypesFeature object and serve all functionality concern to SubTypes Feature
SubTypesFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.SubTypesFeature
 
SubTypesOfFeature - Class in com.hpe.adm.nga.sdk.metadata.features
This class hold the SubTypesOfFeature object and serve all functionality concern to SubTypesOf Feature
SubTypesOfFeature() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.SubTypesOfFeature
 

T

Target() - Constructor for class com.hpe.adm.nga.sdk.metadata.FieldMetadata.Target
 
TechnicalPreviewAPIMode - Static variable in interface com.hpe.adm.nga.sdk.APIMode
Enables the technical preview mode
TestEntities(String) - Constructor for class com.hpe.adm.nga.sdk.entities.EntityList.TestEntities
Set entityId parameter
TestStep - Class in com.hpe.adm.nga.sdk.manualtests.teststeps
A normal test step
TestStep(String) - Constructor for class com.hpe.adm.nga.sdk.manualtests.teststeps.TestStep
Constructor
TestStepList - Class in com.hpe.adm.nga.sdk.manualtests
An object that enables getting or updating (or creating) test steps using the SDK
TestStepList(OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.manualtests.TestStepList
The constructor.
TestStepParser - Class in com.hpe.adm.nga.sdk.manualtests.teststeps
Used to parse the step to see what type of test it is and to create the correct object instance
TestStepParser() - Constructor for class com.hpe.adm.nga.sdk.manualtests.teststeps.TestStepParser
 
testSteps(UpdateTestScriptModel) - Method in class com.hpe.adm.nga.sdk.manualtests.UpdateTestSteps
An instance of the model to update
toString() - Method in class com.hpe.adm.nga.sdk.model.EntityModel
 
toString() - Method in class com.hpe.adm.nga.sdk.model.ErrorModel
 
toString() - Method in class com.hpe.adm.nga.sdk.network.OctaneUrl
Build the url string from the state of this object
toString() - Method in class com.hpe.adm.nga.sdk.Octane.Builder
 
toString() - Method in class com.hpe.adm.nga.sdk.query.Query
 
toString() - Method in class com.hpe.adm.nga.sdk.SiteAdmin.Builder
 
TypedEntityList - Class in com.hpe.adm.nga.sdk.entities
The abstract super class for getting entity lists for typed entities.
TypedEntityList() - Constructor for class com.hpe.adm.nga.sdk.entities.TypedEntityList
 
TypedEntityList.AvailableFields - Interface in com.hpe.adm.nga.sdk.entities
An interface that marks the fields in the entity that can be selected in queries and field selection
TypedEntityList.SortableFields - Interface in com.hpe.adm.nga.sdk.entities
An interface that marks the fields in the entity that can be sorted
TypedEntityList.TypedEntityRequest<T extends TypedEntityModel> - Class in com.hpe.adm.nga.sdk.entities
An instance of a request for typed entities such as create or get
TypedEntityModel - Class in com.hpe.adm.nga.sdk.model
The super type for the typed entity models.
TypedEntityModel() - Constructor for class com.hpe.adm.nga.sdk.model.TypedEntityModel
Default Constructor using a new EntityModel
TypedEntityModel(EntityModel) - Constructor for class com.hpe.adm.nga.sdk.model.TypedEntityModel
Constructor with an existing EntityModel.
TypedEntityRequest(Class<T>) - Constructor for class com.hpe.adm.nga.sdk.entities.TypedEntityList.TypedEntityRequest
 

U

UdfFearture - Class in com.hpe.adm.nga.sdk.metadata.features
Created by ngthien on 8/3/2016.
UdfFearture() - Constructor for class com.hpe.adm.nga.sdk.metadata.features.UdfFearture
 
update() - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList.Attachments
getter of a new UpdateEntities Object
update() - Method in class com.hpe.adm.nga.sdk.attachments.AttachmentList
getter of attachmentList UpdateEntities object ( same functionality as EntityList.UpdateEntities )
update() - Method in class com.hpe.adm.nga.sdk.entities.EntityList.Entities
getter of a UpdateEntities object with specific entity
update() - Method in class com.hpe.adm.nga.sdk.entities.EntityList
getter of an UpdateEntities object of EntityList ( EntityList object handle a collection of entity models )
update() - Method in class com.hpe.adm.nga.sdk.manualtests.TestStepList
Returns an instance of UpdateTestSteps in order to update or create test steps
UpdateEntities - Class in com.hpe.adm.nga.sdk.entities.update
This class hold the UpdateEntities objects and serve all functions concern to REST put.
UpdateEntities(OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.update.UpdateEntities
 
UpdateEntity - Class in com.hpe.adm.nga.sdk.entities.update
This class hold the UpdateEntities object of one entity
UpdateEntity(OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.entities.update.UpdateEntity
 
UpdateTestScriptModel - Class in com.hpe.adm.nga.sdk.manualtests.script
A model that represents a script that can be updated.
UpdateTestScriptModel() - Constructor for class com.hpe.adm.nga.sdk.manualtests.script.UpdateTestScriptModel
 
UpdateTestScriptModel.TestScriptRevisionType - Enum in com.hpe.adm.nga.sdk.manualtests.script
Represents the revision type (see Octane test script documentation)
UpdateTestSteps - Class in com.hpe.adm.nga.sdk.manualtests
The class that can be used to update or create the test script for the given test
UpdateTypedEntities<T extends TypedEntityModel,E extends UpdateTypedEntities> - Class in com.hpe.adm.nga.sdk.entities.update
The generic super class for the context of update for typed entities.
UpdateTypedEntities(Class<T>, OctaneHttpClient, String) - Constructor for class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntities
 
UpdateTypedEntity<T extends TypedEntityModel,E extends UpdateTypedEntity> - Class in com.hpe.adm.nga.sdk.entities.update
The generic super class for the context of get for typed entities.
UpdateTypedEntity(Class<T>, OctaneHttpClient, String, String) - Constructor for class com.hpe.adm.nga.sdk.entities.update.UpdateTypedEntity
 
urlDomain - Variable in class com.hpe.adm.nga.sdk.entities.EntityList
 
urlDomain - Variable in class com.hpe.adm.nga.sdk.network.google.GoogleHttpClient
 
urlDomain - Variable in class com.hpe.adm.nga.sdk.SiteAdmin.Builder
 

V

ValidationTestStep - Class in com.hpe.adm.nga.sdk.manualtests.teststeps
A class representing the validation test step.
ValidationTestStep(String) - Constructor for class com.hpe.adm.nga.sdk.manualtests.teststeps.ValidationTestStep
Constructor
valueOf(String) - Static method in enum com.hpe.adm.nga.sdk.manualtests.script.UpdateTestScriptModel.TestScriptRevisionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hpe.adm.nga.sdk.metadata.FieldMetadata.AccessLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hpe.adm.nga.sdk.metadata.FieldMetadata.FieldType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hpe.adm.nga.sdk.model.EntityMetadata.AvailableMethods
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hpe.adm.nga.sdk.model.EntityModel.EntityState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hpe.adm.nga.sdk.network.OctaneHttpRequest.OctaneRequestMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hpe.adm.nga.sdk.Octane.OctaneCustomSettings.Setting
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hpe.adm.nga.sdk.query.QueryMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.hpe.adm.nga.sdk.manualtests.script.UpdateTestScriptModel.TestScriptRevisionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hpe.adm.nga.sdk.metadata.FieldMetadata.AccessLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hpe.adm.nga.sdk.metadata.FieldMetadata.FieldType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hpe.adm.nga.sdk.model.EntityMetadata.AvailableMethods
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hpe.adm.nga.sdk.model.EntityModel.EntityState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hpe.adm.nga.sdk.network.OctaneHttpRequest.OctaneRequestMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hpe.adm.nga.sdk.Octane.OctaneCustomSettings.Setting
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hpe.adm.nga.sdk.query.QueryMethod
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in com.hpe.adm.nga.sdk.siteadmin.version
An object corresponding to the information that can be obtained from the Octane API
VERSION_DATE_FORMAT - Static variable in class com.hpe.adm.nga.sdk.siteadmin.version.Version
Represents the format that the version date is returned as

W

workSpace(long) - Method in class com.hpe.adm.nga.sdk.Octane.Builder
Sets the workspace id to be a long.
wrappedEntityModel - Variable in class com.hpe.adm.nga.sdk.model.TypedEntityModel
The typed entity model wraps a normal EntityModel
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2021 Micro Focus. All rights reserved.