public class Metadata extends Object implements Comparable<Metadata>, Serializable
MetadataItem
,
Serialized FormModifier and Type | Field and Description |
---|---|
static String |
SYSTEM_SCOPE
Default scope, gathers default entities and can also be used to share entities across scopes.
|
Constructor and Description |
---|
Metadata()
Instantiates a new Metadata.
|
Metadata(String id)
Instantiates a new Metadata with the specified identifier.
|
Metadata(String scope,
String id,
String name,
String description)
Instantiates a new Metadata with the provided information.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Metadata o) |
boolean |
equals(Object o) |
String |
getDescription()
Retrieves the description.
|
String |
getId()
Retrieves the identifier for the entity associated with this Metadata
|
String |
getName()
Retrieves the name.
|
String |
getScope()
Retrieves the scope for the entity associated with this Metadata
|
Set<String> |
getSystemTags()
Retrieves a set of
String system tag names associated with this Metadata |
Set<String> |
getTags()
Retrieves a set of
String tag names associated with this Metadata |
int |
hashCode() |
boolean |
isEnabled()
Whether the associated entity is considered active by the context server, in particular to check if rules need to be created / triggered
|
boolean |
isHidden()
Whether the associated entity is considered for internal purposes only and should therefore be hidden to accessing UIs.
|
boolean |
isMissingPlugins()
Whether the associated entity is waiting on additional plugins to become available to be able to properly perform its function.
|
boolean |
isReadOnly()
Whether the associated entity can be accessed but not modified.
|
void |
setDescription(String description)
Sets the description.
|
void |
setEnabled(boolean enabled)
Specifies whether the associated entity should be active or not.
|
void |
setHidden(boolean hidden)
Specifies whether the associated entity is hidden.
|
void |
setId(String id)
Sets the id.
|
void |
setMissingPlugins(boolean missingPlugins)
Specifies whether the associated entity is waiting on additional plugins to become available.
|
void |
setName(String name)
Sets the name.
|
void |
setReadOnly(boolean readOnly)
Specifies whether the associated entity should be only accessed and not modified.
|
void |
setScope(String scope)
Sets the scope.
|
void |
setSystemTags(Set<String> systemTags)
Sets the system tags.
|
void |
setTags(Set<String> tags)
Sets the tags.
|
public static final String SYSTEM_SCOPE
public Metadata()
public Metadata(String id)
id
- the identifier for this Metadatapublic String getId()
public void setId(String id)
id
- the idpublic String getName()
public void setName(String name)
name
- the namepublic String getDescription()
public void setDescription(String description)
description
- the descriptionpublic String getScope()
Item for a deeper discussion of scopes
public void setScope(String scope)
scope
- the scopepublic Set<String> getTags()
String
tag names associated with this MetadataString
tag names associated with this Metadatapublic Set<String> getSystemTags()
String
system tag names associated with this MetadataString
system tag names associated with this Metadatapublic void setSystemTags(Set<String> systemTags)
systemTags
- the system tag idspublic boolean isEnabled()
true
if the associated entity is enabled, false
otherwisepublic void setEnabled(boolean enabled)
enabled
- true
if the associated entity is enabled, false
otherwisepublic boolean isMissingPlugins()
true
if plugins are missing, false
otherwisepublic void setMissingPlugins(boolean missingPlugins)
missingPlugins
- true
if plugins are missing, false
otherwisepublic boolean isHidden()
true
if the associated entity needs to be hidden, false
otherwisepublic void setHidden(boolean hidden)
hidden
- true
if the associated entity needs to be hidden, false
otherwisepublic boolean isReadOnly()
true
if the associated entity can be accessed but not modified, false
otherwisepublic void setReadOnly(boolean readOnly)
readOnly
- true
if the associated entity can be accessed but not modified, false
otherwisepublic int compareTo(Metadata o)
compareTo
in interface Comparable<Metadata>
Copyright © 2014–2023 Apache Software Foundation. All rights reserved.