com.splunk
Class EntityMetadata

java.lang.Object
  com.splunk.EntityMetadata

public class EntityMetadata
extends java.lang.Object

The EntityMetadata class provides access to the metadata properties of a corresponding entity. Use Entity.getMetadata to obtain an instance of this class.

Method Summary

boolean	canChangePermissions() Indicates whether this entity's permission can be changed.
boolean	canShareApp() Indicates whether this entity can be shared via an app.
boolean	canShareGlobal() Indicates whether the entity can be shared globally.
boolean	canShareUser() Indicates whether the entity can be shared to a specific user.
boolean	canWrite() Indicates whether this entity can be modified.
java.lang.String	getApp() Returns the app context of this entity.
java.lang.String	getOwner() Returns the username of the entity owner.
Record	getPermissions() Returns this entity's permissions, which represent an allowable inclusive action:list-of-roles map.
java.lang.String	getSharing() Returns how this entity is shared (app, global, and/or user).
boolean	isModifiable() Indicates whether this entity can be modified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

canChangePermissions

public boolean canChangePermissions()

Indicates whether this entity's permission can be changed.

Returns:

true if this entity's permission can be changed, false if not.

canShareApp

public boolean canShareApp()

Indicates whether this entity can be shared via an app.

Returns:

true if this entity can be shared via an app, false if not.

canShareGlobal

public boolean canShareGlobal()

Indicates whether the entity can be shared globally.

Returns:

true if this entity can be shared globally, false if not.

canShareUser

public boolean canShareUser()

Indicates whether the entity can be shared to a specific user.

Returns:

true if this entity can be shared to a specific user, false if not.

canWrite

public boolean canWrite()

Indicates whether this entity can be modified.

Returns:

true if this entity can be modified, false if not.

getApp

public java.lang.String getApp()

Returns the app context of this entity.

Returns:

The app context of this entity.

getOwner

public java.lang.String getOwner()

Returns the username of the entity owner.

Returns:

The entity owner's username.

getPermissions

public Record getPermissions()

Returns this entity's permissions, which represent an allowable inclusive action:list-of-roles map.

Returns:

This entity's permissions map.

getSharing

public java.lang.String getSharing()

Returns how this entity is shared (app, global, and/or user).

Returns:

Values that indicate how this entity is shared.

isModifiable

public boolean isModifiable()

Indicates whether this entity can be modified.

Returns:

true if this entity can be modified, false if not.