Package com.thingworx.deprecation
Interface ISupportsDeprecation
- All Known Implementing Classes:
AlertServices
,ApplicationKey
,Authenticator
,CollectionsServices
,ConfigurationTable
,ConfigurationTableDefinition
,ContentLoader
,CSVFileServices
,CustomAuthenticator
,DashboardFunctions
,DataShape
,DataTableThing
,DataThing
,DataThingWithEvents
,DeviceFunctions
,DirectoryService
,EncryptionServices
,EntityServices
,ExtensibleRootEntity
,ExtensionPackage
,FileRepositoryThing
,Group
,InfoTableFunctions
,LocalizationTable
,LogRetrievalStrategy
,MediaEntity
,Menu
,Network
,NotificationHandler
,Organization
,PlatformSubsystem
,Project
,PropertyDefinition
,RemoteThing
,RemoteThingWithFileTransfer
,RemoteThingWithTunnels
,RemoteThingWithTunnelsAndFileTransfer
,ReportingStrategy
,Resource
,RootEntity
,RuntimeLocalizationFunctions
,SCIMSubsystem
,ScriptServices
,Searcher
,SecurityClaimsAuthenticator
,SecurityMonitorThing
,SecurityServices
,ServiceDefinition
,ServiceProviderEntity
,SessionInfo
,SourceControlFunctions
,StreamThing
,Subsystem
,SubsystemMonitoring
,Thing
,ThingShape
,ThingTemplate
,User
,UserManagementSubsystem
,Vocabulary
-
Method Summary
Modifier and TypeMethodDescriptiondefault org.json.JSONObject
default boolean
default boolean
isDeprecatedBefore
(String version) default String
since()
-
Method Details
-
getDeprecated
The method returns JSONObject for
deprecated
aspect. Ifdeprecated
object is null, it will return null.- Returns:
- JSONObject for deprecated aspect.
-
since
The method will return value of since set in deprecated aspect. If
deprecated
object is null, it will return null.- Returns:
- String since value of deprecated aspect.
-
isDeprecated
The method checks if the caller is deprecated or not. It returns true if deprecated aspect has been set, otherwise returns false.
- Returns:
- true if deprecated aspect is set, else returns false.
-
isDeprecatedBefore
The method compares the passed version string with the value of since set in deprecated aspect. If the passed version is greater than or equal to value of since, it returns true. If the passed version less than value of since, it returns false.
- Parameters:
version
- The version string needed to check for deprecation- Returns:
- true if the passed version is greater than value of since.
-