org.eclipse.dirigible.repository.api

Interface IEntityInformation

public interface IEntityInformation

Through this interface the user can obtain information on a particular repository entity.

Help methods are available in the PermissionsHelper class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PERMISSION_GROUP_READ This flag indicates that users, part of the owner's group, are allowed to read this entity.
static int	PERMISSION_GROUP_UPDATE This flag indicates that users, part of the owner's group, are allowed to update the content of this entity.
static int	PERMISSION_GROUP_WRITE This flag indicates that users, part of the owner's group, are allowed to write or delete this entity.
static int	PERMISSION_NONE This flag indicates that no one has any rights to this entity.
static int	PERMISSION_OTHERS_READ This flag indicates that all other users are allowed to read this entity.
static int	PERMISSION_OTHERS_UPDATE This flag indicates that all other users are allowed to update this entity's contents.
static int	PERMISSION_OTHERS_WRITE This flag indicates that all other users are allowed to write or delete this entity.
static int	PERMISSION_OWNER_READ This flag indicates that the owner of this entity is allowed to read its content.
static int	PERMISSION_OWNER_UPDATE This flag indicates that the owner of this entity is allowed to update its content.
static int	PERMISSION_OWNER_WRITE This flag indicates that the owner of this entity is allowed to write or delete it.
static int	PERMISSION_UNKNOWN This flag indicates that a permission status for this entity could not be evaluated.

Method Summary

Modifier and Type	Method and Description
Date	getCreatedAt() Timestamp of the creation of the entity.
String	getCreatedBy() The creator of the entity.
Date	getModifiedAt() Timestamp of the last modification of the entity.
String	getModifiedBy() The last modifier of the entity.
String	getName() Returns the name of the entity.
String	getPath() Returns the path of the entity within the repository.
int	getPermissions() Returns a flag mask indicating the permissions of this entity.
Long	getSize() Returns the size of this resource.

Field Detail

PERMISSION_UNKNOWN

static final int PERMISSION_UNKNOWN

This flag indicates that a permission status for this entity could not be evaluated.

See Also:

Constant Field Values

PERMISSION_NONE

static final int PERMISSION_NONE

This flag indicates that no one has any rights to this entity.

See Also:

Constant Field Values

PERMISSION_OWNER_READ

static final int PERMISSION_OWNER_READ

This flag indicates that the owner of this entity is allowed to read its content.

See Also:

Constant Field Values

PERMISSION_OWNER_WRITE

static final int PERMISSION_OWNER_WRITE

This flag indicates that the owner of this entity is allowed to write or delete it.

See Also:

Constant Field Values

PERMISSION_OWNER_UPDATE

static final int PERMISSION_OWNER_UPDATE

This flag indicates that the owner of this entity is allowed to update its content.

See Also:

Constant Field Values

PERMISSION_GROUP_READ

static final int PERMISSION_GROUP_READ

This flag indicates that users, part of the owner's group, are allowed to read this entity.

See Also:

Constant Field Values

PERMISSION_GROUP_WRITE

static final int PERMISSION_GROUP_WRITE

This flag indicates that users, part of the owner's group, are allowed to write or delete this entity.

See Also:

Constant Field Values

PERMISSION_GROUP_UPDATE

static final int PERMISSION_GROUP_UPDATE

This flag indicates that users, part of the owner's group, are allowed to update the content of this entity.

See Also:

Constant Field Values

PERMISSION_OTHERS_READ

static final int PERMISSION_OTHERS_READ

This flag indicates that all other users are allowed to read this entity.

See Also:

Constant Field Values

PERMISSION_OTHERS_WRITE

static final int PERMISSION_OTHERS_WRITE

This flag indicates that all other users are allowed to write or delete this entity.

See Also:

Constant Field Values

PERMISSION_OTHERS_UPDATE

static final int PERMISSION_OTHERS_UPDATE

This flag indicates that all other users are allowed to update this entity's contents.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the name of the entity.

If the implementation cannot find the requested information, then a value of null is returned.

Returns:

the name of the IEntity

getPath

String getPath()

Returns the path of the entity within the repository.

If the implementation cannot find the requested information, then a value of null is returned.

Returns:

the path of the IEntity

getPermissions

int getPermissions()

Returns a flag mask indicating the permissions of this entity. The result is a set of permission flags or-ed together.

If the implementation cannot find the requested information, then a value of PERMISSION_UNKNOWN is returned.

Returns:

the permission mask

See Also:

PERMISSION_OWNER_READ, PERMISSION_OWNER_WRITE, PERMISSION_OWNER_UPDATE, PERMISSION_GROUP_READ, PERMISSION_GROUP_WRITE, PERMISSION_GROUP_UPDATE, PERMISSION_OTHERS_READ, PERMISSION_OTHERS_WRITE, PERMISSION_OTHERS_UPDATE

getSize

Long getSize()

Returns the size of this resource.

If the implementation cannot find the requested information, then a value of null is returned.

Returns:

the size property of the IEntity

getCreatedBy

String getCreatedBy()

The creator of the entity.

Returns:

the created by property of the IEntity

getCreatedAt

Date getCreatedAt()

Timestamp of the creation of the entity.

Returns:

the created at property of the IEntity

getModifiedBy

String getModifiedBy()

The last modifier of the entity.

Returns:

the modified by property of the IEntity

getModifiedAt

Date getModifiedAt()

Timestamp of the last modification of the entity.

Returns:

the modified at property of the IEntity