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 Description static intPERMISSION_GROUP_READThis flag indicates that users, part of the owner's group, are allowed to read this entity.static intPERMISSION_GROUP_UPDATEThis flag indicates that users, part of the owner's group, are allowed to update the content of this entity.static intPERMISSION_GROUP_WRITEThis flag indicates that users, part of the owner's group, are allowed to write or delete this entity.static intPERMISSION_NONEThis flag indicates that no one has any rights to this entity.static intPERMISSION_OTHERS_READThis flag indicates that all other users are allowed to read this entity.static intPERMISSION_OTHERS_UPDATEThis flag indicates that all other users are allowed to update this entity's contents.static intPERMISSION_OTHERS_WRITEThis flag indicates that all other users are allowed to write or delete this entity.static intPERMISSION_OWNER_READThis flag indicates that the owner of this entity is allowed to read its content.static intPERMISSION_OWNER_UPDATEThis flag indicates that the owner of this entity is allowed to update its content.static intPERMISSION_OWNER_WRITEThis flag indicates that the owner of this entity is allowed to write or delete it.static intPERMISSION_UNKNOWNThis flag indicates that a permission status for this entity could not be evaluated. -
Method Summary
Modifier and Type Method Description DategetCreatedAt()Timestamp of the creation of the entity.StringgetCreatedBy()The creator of the entity.DategetModifiedAt()Timestamp of the last modification of the entity.StringgetModifiedBy()The last modifier of the entity.StringgetName()Returns the name of the entity.StringgetPath()Returns the path of the entity within the repository.intgetPermissions()Returns a flag mask indicating the permissions of this entity.LonggetSize()Returns the size of this resource.
-
Field Details
-
PERMISSION_UNKNOWN
static final int PERMISSION_UNKNOWNThis flag indicates that a permission status for this entity could not be evaluated.- See Also:
- Constant Field Values
-
PERMISSION_NONE
static final int PERMISSION_NONEThis flag indicates that no one has any rights to this entity.- See Also:
- Constant Field Values
-
PERMISSION_OWNER_READ
static final int PERMISSION_OWNER_READThis 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_WRITEThis 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_UPDATEThis 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_READThis 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_WRITEThis 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_UPDATEThis 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_READThis 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_WRITEThis 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_UPDATEThis flag indicates that all other users are allowed to update this entity's contents.- See Also:
- Constant Field Values
-
-
Method Details
-
getName
String getName()Returns the name of the entity.If the implementation cannot find the requested information, then a value of
nullis 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
nullis 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_UNKNOWNis 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
nullis 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
-