TypeFilter

java.lang.Object
- com.inductiveautomation.ignition.common.sqltags.history.annotations.TypeFilter

All Implemented Interfaces:

java.io.Serializable
```
public class TypeFilter
extends java.lang.Object
implements java.io.Serializable
```
This filter is used to specify types of annotations to return during a query.
User: these annotations have data that are created by users. These are the general purpose annotations that most people think of.
System: these are virtual annotations that are generated by different subsystems. All of them are identified by the pattern "system/{id}".
Types can be specified by broad category, or by specific ids by creating a custom filter.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static TypeFilter`	`ALL`	Includes all types, both system and user defined.
`static TypeFilter`	`SYSTEM_ONLY`	Includes all system-space types.
`static java.lang.String`	`SYSTEM_TYPEID`	The type id used to identify all system-space types.
`static TypeFilter`	`USER_ONLY`	Includes all user-space types.
`static java.lang.String`	`USER_TYPEID`	The type id used to identify all user-space types.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`allowSystem()`
`boolean`	`allowUser()`
`static TypeFilter`	`custom(java.lang.String... typeIds)`
`boolean`	`isAllowed(java.lang.String typeId)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - USER_TYPEID
```
public static final java.lang.String USER_TYPEID
```
    The type id used to identify all user-space types. Typically not used directly, but can be used to specify a custom list of all user types, and specific system types.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_TYPEID
```
public static final java.lang.String SYSTEM_TYPEID
```
    The type id used to identify all system-space types. Typically not used directly, but can be used to specify a custom list of all system types, and specific user types.
    
    See Also:
    
    Constant Field Values
  - ALL
```
public static final TypeFilter ALL
```
    Includes all types, both system and user defined.
  - USER_ONLY
```
public static final TypeFilter USER_ONLY
```
    Includes all user-space types. These are annotation types whose data is generated by the user.
  - SYSTEM_ONLY
```
public static final TypeFilter SYSTEM_ONLY
```
    Includes all system-space types. These are annotation types whose data is generated by a sub-system.
- Method Detail
  - custom
```
public static TypeFilter custom(java.lang.String... typeIds)
```
  - allowSystem
```
public boolean allowSystem()
```
  - allowUser
```
public boolean allowUser()
```
  - isAllowed
```
public boolean isAllowed(java.lang.String typeId)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object