com.cumulocity.sdk.client.option

Class SystemOptionApiImpl

java.lang.Object

com.cumulocity.sdk.client.option.SystemOptionApiImpl

All Implemented Interfaces:

SystemOptionApi

public class SystemOptionApiImpl
extends Object
implements SystemOptionApi

Constructor Summary

Constructors

Constructor and Description
SystemOptionApiImpl(RestConnector restConnector, TenantApiRepresentation tenantApiRepresentation)

Method Summary

Modifier and Type	Method and Description
OptionRepresentation	getOption(com.cumulocity.model.option.OptionPK optionPK) Gets an option by id Requires role ROLE_OPTION_MANAGEMENT_READ

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SystemOptionApiImpl

public SystemOptionApiImpl(RestConnector restConnector,
                           TenantApiRepresentation tenantApiRepresentation)

Method Detail

getOption

public OptionRepresentation getOption(com.cumulocity.model.option.OptionPK optionPK)
                               throws SDKException

Description copied from interface: SystemOptionApi

Gets an option by id Requires role ROLE_OPTION_MANAGEMENT_READ

Specified by:

getOption in interface SystemOptionApi

Parameters:

optionPK - id of the option to search for

Returns:

the system option with the given id

Throws:

SDKException - if the option is not found or if the query failed