Package com.thingworx.accesscontrol

Interface ISupportsAccessModifier

All Known Implementing Classes:

ConfigurationTable, ConfigurationTableDefinition, DataShape, DataTableThing, DataThing, DataThingWithEvents, FileRepositoryThing, LocalizationTable, LogRetrievalStrategy, MediaEntity, Menu, Network, NotificationHandler, PropertyDefinition, RemoteThing, RemoteThingWithFileTransfer, RemoteThingWithTunnels, RemoteThingWithTunnelsAndFileTransfer, ReportingStrategy, SecurityMonitorThing, ServiceDefinition, StreamThing, Thing, ThingShape, ThingTemplate

@ThingworxExtensionApiClass(since={9,4})
public interface ISupportsAccessModifier

Method Summary

Modifier and Type	Method	Description
default org.json.JSONObject	getAccessModifier()
default java.lang.String	getAccessModifierScope()
default org.json.JSONArray	getExemptList()
default boolean	hasAccessModifier()
default boolean	isInternalAccess()
default boolean	isPrivateAccess()
default boolean	isRestrictedAccess()

Method Detail

getAccessModifier

@ThingworxExtensionApiMethod(since={9,4})
default org.json.JSONObject getAccessModifier()

The method returns JSONObject for accessModifier aspect. If accessModifier is empty or not set, then it will return null.

Returns:

JSONObject for accessModifier aspect.

hasAccessModifier

@ThingworxExtensionApiMethod(since={9,4})
default boolean hasAccessModifier()

getAccessModifierScope

@ThingworxExtensionApiMethod(since={9,4})
default java.lang.String getAccessModifierScope()

The method returns value of Scope of accessModifier aspect. If accessModifier is empty or not set, then it will return null.

Returns:

String scope value of accessModifier aspect.

isPrivateAccess

@ThingworxExtensionApiMethod(since={9,4})
default boolean isPrivateAccess()

The method returns true if the scope is PRIVATE for accessModifier aspect. It will return false otherwise.

Returns:

true if the scope is PRIVATE else returns false.

isRestrictedAccess

@ThingworxExtensionApiMethod(since={9,4})
default boolean isRestrictedAccess()

The method returns true if the scope is RESTRICTED for accessModifier aspect. It will return false otherwise.

Returns:

true if the scope is RESTRICTED else returns false.

isInternalAccess

@ThingworxExtensionApiMethod(since={9,4})
default boolean isInternalAccess()

The method returns true if the scope is INTERNAL for accessModifier aspect. It will return false otherwise.

Returns:

true if the scope is INTERNAL else returns false.

getExemptList

@ThingworxExtensionApiMethod(since={9,4})
default org.json.JSONArray getExemptList()

The method returns exemptList JSONArray for RESTRICTED accessModifier. It will return null in case of other accessModifier scope values.

Returns:

JSONArray exemptList for accessModifier aspect.