Class TagProviderProps
- java.lang.Object
-
- com.inductiveautomation.ignition.common.tags.model.TagProviderProps
-
- All Implemented Interfaces:
java.io.Serializable
public class TagProviderProps extends java.lang.Object implements java.io.Serializable
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TagProviderProps.Builder
-
Field Summary
Fields Modifier and Type Field Description static int
FLAG_IS_RUNTIME_STATUS
This flag indicates that the provider is a "status" system, which has the following implications:
1) Cannot be used for project's default provider.
2) Does not appear on the tag status page.static int
FLAG_IS_TOPLEVEL
A flag that indicates that this provider is always displayed in the top level of the tag browser and not hidden away in the "All Providers" node.static int
FLAG_PROVIDES_COMPLEX_TYPES
Indicates that the provider's TYPES folder should always be shown.static int
FLAG_SUPPORTS_HISTORY
Indicates that the tags in this provider should be queried for history THROUGH the provider, not directly against their history provider.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Set<TagTypeDescriptor>
getAllowedTypes()
Flags
getAttributes()
java.lang.String
getDescription()
EditRights
getEditRights()
java.lang.String
getName()
TagPath
getPath()
boolean
isEnabled()
boolean
isRuntime()
boolean
isTopLevel()
static TagProviderProps.Builder
newBuilder()
boolean
supportsComplexTypes()
boolean
supportsHistory()
-
-
-
Field Detail
-
FLAG_IS_TOPLEVEL
public static final int FLAG_IS_TOPLEVEL
A flag that indicates that this provider is always displayed in the top level of the tag browser and not hidden away in the "All Providers" node.- See Also:
- Constant Field Values
-
FLAG_SUPPORTS_HISTORY
public static final int FLAG_SUPPORTS_HISTORY
Indicates that the tags in this provider should be queried for history THROUGH the provider, not directly against their history provider.- See Also:
- Constant Field Values
-
FLAG_IS_RUNTIME_STATUS
public static final int FLAG_IS_RUNTIME_STATUS
This flag indicates that the provider is a "status" system, which has the following implications:
1) Cannot be used for project's default provider.
2) Does not appear on the tag status page.- See Also:
- Constant Field Values
-
FLAG_PROVIDES_COMPLEX_TYPES
public static final int FLAG_PROVIDES_COMPLEX_TYPES
Indicates that the provider's TYPES folder should always be shown.- See Also:
- Constant Field Values
-
-
Method Detail
-
getPath
public TagPath getPath()
-
getName
public java.lang.String getName()
-
getDescription
public java.lang.String getDescription()
-
isEnabled
public boolean isEnabled()
-
getAttributes
public Flags getAttributes()
-
supportsHistory
public boolean supportsHistory()
-
supportsComplexTypes
public boolean supportsComplexTypes()
-
isRuntime
public boolean isRuntime()
-
isTopLevel
public boolean isTopLevel()
-
getEditRights
public EditRights getEditRights()
-
getAllowedTypes
public java.util.Set<TagTypeDescriptor> getAllowedTypes()
-
newBuilder
public static TagProviderProps.Builder newBuilder()
-
-