edu.internet2.middleware.grouper.permissions
Interface PermissionEntry

All Superinterfaces:

java.lang.Comparable<PermissionEntry>

All Known Implementing Classes:

PermissionEntryBase, PermissionEntryImpl, PITPermissionAllView

public interface PermissionEntry
extends java.lang.Comparable<PermissionEntry>

Author:

shilen

Nested Class Summary

static class

PermissionEntry.PermissionType type of permission, either assigned to role, or assigned to role and user combined

Method Summary

java.lang.String	getAction() action on the permission (e.g. read, write, assign (default), etc
java.lang.String	getActionId() action on the permission (e.g. read, write, assign (default), etc
java.lang.String	getAssignmentNotes() notes on the assignment of privilege
AttributeAssign	getAttributeAssign() get attribute assign
int	getAttributeAssignActionSetDepth() depth of action hierarchy, 0 means immediate
AttributeAssignDelegatable	getAttributeAssignDelegatable() get the enum for delegatable, do not return null
java.lang.String	getAttributeAssignDelegatableDb() internal method for hibernate to persist this enum
java.lang.String	getAttributeAssignId() id of the attribute assign row, either to the role, or to the role member pair
AttributeDef	getAttributeDef()
java.lang.String	getAttributeDefId() id of the attributeDef
AttributeDefName	getAttributeDefName() get attribute def name
java.lang.String	getAttributeDefNameDispName() display name of the attribute def name which is the permission assigned to the role or subject
java.lang.String	getAttributeDefNameId() id of the attribute def name which is the permission
java.lang.String	getAttributeDefNameName() name of the attribute def name which is the permission assigned to the role or subject
int	getAttributeDefNameSetDepth() depth of attributeDefName set hierarchy, 0 means immediate
java.sql.Timestamp	getDisabledTime() if there is a date here, and it is in the past, this assignment is disabled
java.lang.Long	getDisabledTimeDb() if there is a date here, and it is in the past, this assignment is disabled
java.lang.String	getDisallowedDb() if this is a permission, then if this permission assignment is allowed or not
java.lang.String	getEnabledDb() true or false for if this assignment is enabled (e.g. might have expired)
java.sql.Timestamp	getEnabledTime() if there is a date here, and it is in the future, this assignment is disabled until that time
java.lang.Long	getEnabledTimeDb() if there is a date here, and it is in the future, this assignment is disabled until that time
java.sql.Timestamp	getEndTime() The end time for this permission entry.
java.sql.Timestamp	getImmediateMshipDisabledTime() when the underlying membership will be disabled
java.lang.Long	getImmediateMshipDisabledTimeDb() when the underlying membership will be disabled
java.sql.Timestamp	getImmediateMshipEnabledTime() when the underlying membership was enabled
java.lang.Long	getImmediateMshipEnabledTimeDb() when the underlying membership was enabled
Member	getMember() get the member
java.lang.String	getMemberId() id of the member that has the permission
int	getMembershipDepth() depth of memberships, 0 means immediate
java.lang.String	getMembershipId() id of the membership row
PermissionHeuristics	getPermissionHeuristics() cache the weighting of this assignment
PermissionEntry.PermissionType	getPermissionType() type of permission, either assigned to role, or assigned to role and user combined: role_subject
java.lang.String	getPermissionTypeDb() type of permission, either assigned to role, or assigned to role and user combined: role_subject
Role	getRole() owner role
java.lang.String	getRoleDisplayName() display name of the role which the subject is in to have the permission
java.lang.String	getRoleId() id of the role which the subject is in to get the permission
java.lang.String	getRoleName() role which has the permission or which the subject must be in to have the permission
int	getRoleSetDepth() depth of role hierarchy, 0 means immediate, -1 means no role set involved
java.sql.Timestamp	getStartTime() The start time for this permission entry.
java.lang.String	getSubjectId() subject id of the subject which has the permissions
java.lang.String	getSubjectSourceId() source id of the subject which has the permissions
boolean	isActive() Whether this permission entry currently exists.
boolean	isAllowedOverall() this will be if this permissions is allowed (not in DB/assignment, but overall).
boolean	isDisallowed() if this is a permission, then if this permission assignment is allowed or not
boolean	isEnabled() true or false for if this assignment is enabled (e.g. might have expired)
boolean	isImmediate(PermissionEntry.PermissionType thePermissionType)
boolean	isImmediateMembership() see if the membership is unassignable directly
boolean	isImmediatePermission() see if the permission is unassignable directly
void	setAction(java.lang.String action1) action on the permission (e.g. read, write, assign (default), etc
void	setActionId(java.lang.String actionId1) action on the permission (e.g. read, write, assign (default), etc
void	setAllowedOverall(boolean allowedOverall1) this will be if this permissions is allowed (not in DB/assignment, but overall).
void	setAssignmentNotes(java.lang.String assignmentNotes1) notes on the assignment of privilege
void	setAttributeAssignActionSetDepth(int attributeAssignActionSetDepth1) depth of action hierarchy, 0 means immediate
void	setAttributeAssignDelegatable(AttributeAssignDelegatable attributeAssignDelegatable1)
void	setAttributeAssignDelegatableDb(java.lang.String theAttributeAssignDelegatableDb) internal method for hibernate to set if delegatable
void	setAttributeAssignId(java.lang.String attributeAssignId1) id of the attribute assign row, either to the role, or to the role member pair
void	setAttributeDefId(java.lang.String attributeDefId1) id of the attributeDef
void	setAttributeDefNameDispName(java.lang.String attributeDefNameDispName1) display name of the attribute def name which is the permission assigned to the role or subject
void	setAttributeDefNameId(java.lang.String attributeDefNameId1) id of the attribute def name which is the permission
void	setAttributeDefNameName(java.lang.String attributeDefNameName1) name of the attribute def name which is the permission assigned to the role or subject
void	setAttributeDefNameSetDepth(int attributeDefNameSetDepth1) depth of attributeDefName set hierarchy, 0 means immediate
void	setDisabledTime(java.sql.Timestamp disabledTimeDb1) if there is a date here, and it is in the past, this assignment is disabled
void	setDisabledTimeDb(java.lang.Long disabledTimeDb1) if there is a date here, and it is in the past, this assignment is disabled
void	setDisallowed(boolean disallowed1) if this is a permission, then if this permission assignment is allowed or not
void	setDisallowedDb(java.lang.String disallowed1) if this is a permission, then if this permission assignment is allowed or not
void	setEnabled(boolean enabled1) true or false for if this assignment is enabled (e.g. might have expired)
void	setEnabledDb(java.lang.String enabled1) true or false for if this assignment is enabled (e.g. might have expired)
void	setEnabledTime(java.sql.Timestamp enabledTimeDb1) if there is a date here, and it is in the future, this assignment is disabled until that time
void	setEnabledTimeDb(java.lang.Long enabledTimeDb1) if there is a date here, and it is in the future, this assignment is disabled until that time
void	setImmediateMshipDisabledTimeDb(java.lang.Long immediateMshipDisabledTimeDb1) when the underlying membership was enabled
void	setImmediateMshipDisabledTimeDb(java.sql.Timestamp immediateMshipDisabledTimeDb1) when the underlying membership was enabled
void	setImmediateMshipEnabledTime(java.sql.Timestamp immediateMshipEnabledTimeDb1) when the underlying membership was enabled
void	setImmediateMshipEnabledTimeDb(java.lang.Long immediateMshipEnabledTimeDb1) when the underlying membership was enabled
void	setMemberId(java.lang.String memberId1) id of the member that has the permission
void	setMembershipDepth(int membershipDepth1) depth of memberships, 0 means immediate
void	setMembershipId(java.lang.String membershipId1) id of the membership row
void	setPermissionHeuristics(PermissionHeuristics permissionHeuristics1) cache the weighting of this assignment
void	setPermissionTypeDb(java.lang.String permissionTypeDb1) type of permission, either assigned to role, or assigned to role and user combined: role_subject
void	setRoleDisplayName(java.lang.String roleDisplayName1) display name of the role which the subject is in to have the permission
void	setRoleId(java.lang.String roleId1) id of the role which the subject is in to get the permission
void	setRoleName(java.lang.String roleName1) role which has the permission or which the subject must be in to have the permission
void	setRoleSetDepth(int roleSetDepth1) depth of role hierarchy, 0 means immediate, -1 means no role set involved
void	setSubjectId(java.lang.String subjectId1) subject id of the subject which has the permissions
void	setSubjectSourceId(java.lang.String subjectSourceId1) source id of the subject which has the permissions

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isAllowedOverall

boolean isAllowedOverall()

this will be if this permissions is allowed (not in DB/assignment, but overall). So if we are considering limits, and the limit is false, then this will be false for a permission where the disallow is set to false

Returns:

true if allowed overall

setAllowedOverall

void setAllowedOverall(boolean allowedOverall1)

this will be if this permissions is allowed (not in DB/assignment, but overall). So if we are considering limits, and the limit is false, then this will be false for a permission where the disallow is set to false

Parameters:

allowedOverall1 -

getAssignmentNotes

java.lang.String getAssignmentNotes()

notes on the assignment of privilege

Returns:

notes

setAssignmentNotes

void setAssignmentNotes(java.lang.String assignmentNotes1)

notes on the assignment of privilege

Parameters:

assignmentNotes1 -

getImmediateMshipEnabledTimeDb

java.lang.Long getImmediateMshipEnabledTimeDb()

when the underlying membership was enabled

Returns:

time

getImmediateMshipEnabledTime

java.sql.Timestamp getImmediateMshipEnabledTime()

when the underlying membership was enabled

Returns:

time

setImmediateMshipEnabledTimeDb

void setImmediateMshipEnabledTimeDb(java.lang.Long immediateMshipEnabledTimeDb1)

when the underlying membership was enabled

Parameters:

immediateMshipEnabledTimeDb1 -

setImmediateMshipEnabledTime

void setImmediateMshipEnabledTime(java.sql.Timestamp immediateMshipEnabledTimeDb1)

when the underlying membership was enabled

Parameters:

immediateMshipEnabledTimeDb1 -

getImmediateMshipDisabledTimeDb

java.lang.Long getImmediateMshipDisabledTimeDb()

when the underlying membership will be disabled

Returns:

time

setImmediateMshipDisabledTimeDb

void setImmediateMshipDisabledTimeDb(java.lang.Long immediateMshipDisabledTimeDb1)

when the underlying membership was enabled

Parameters:

immediateMshipDisabledTimeDb1 -

getImmediateMshipDisabledTime

java.sql.Timestamp getImmediateMshipDisabledTime()

when the underlying membership will be disabled

Returns:

time

setImmediateMshipDisabledTimeDb

void setImmediateMshipDisabledTimeDb(java.sql.Timestamp immediateMshipDisabledTimeDb1)

when the underlying membership was enabled

Parameters:

immediateMshipDisabledTimeDb1 -

getActionId

java.lang.String getActionId()

action on the permission (e.g. read, write, assign (default), etc

Returns:

action

setActionId

void setActionId(java.lang.String actionId1)

action on the permission (e.g. read, write, assign (default), etc

Parameters:

actionId1 -

getPermissionHeuristics

PermissionHeuristics getPermissionHeuristics()

cache the weighting of this assignment

Returns:

the permission heuristic

setPermissionHeuristics

void setPermissionHeuristics(PermissionHeuristics permissionHeuristics1)

cache the weighting of this assignment

Parameters:

permissionHeuristics1 -

getMembershipDepth

int getMembershipDepth()

depth of memberships, 0 means immediate

Returns:

depth

setMembershipDepth

void setMembershipDepth(int membershipDepth1)

depth of memberships, 0 means immediate

Parameters:

membershipDepth1 -

getRoleSetDepth

int getRoleSetDepth()

depth of role hierarchy, 0 means immediate, -1 means no role set involved

Returns:

depth

setRoleSetDepth

void setRoleSetDepth(int roleSetDepth1)

depth of role hierarchy, 0 means immediate, -1 means no role set involved

Parameters:

roleSetDepth1 -

getAttributeDefNameSetDepth

int getAttributeDefNameSetDepth()

depth of attributeDefName set hierarchy, 0 means immediate

Returns:

depth

setAttributeDefNameSetDepth

void setAttributeDefNameSetDepth(int attributeDefNameSetDepth1)

depth of attributeDefName set hierarchy, 0 means immediate

Parameters:

attributeDefNameSetDepth1 -

getAttributeAssignActionSetDepth

int getAttributeAssignActionSetDepth()

depth of action hierarchy, 0 means immediate

Returns:

depth

setAttributeAssignActionSetDepth

void setAttributeAssignActionSetDepth(int attributeAssignActionSetDepth1)

depth of action hierarchy, 0 means immediate

Parameters:

attributeAssignActionSetDepth1 -

getRoleName

java.lang.String getRoleName()

role which has the permission or which the subject must be in to have the permission

Returns:

the roleName

setRoleName

void setRoleName(java.lang.String roleName1)

role which has the permission or which the subject must be in to have the permission

Parameters:

roleName1 - the roleName to set

getSubjectSourceId

java.lang.String getSubjectSourceId()

source id of the subject which has the permissions

Returns:

the subjectSourceId

setSubjectSourceId

void setSubjectSourceId(java.lang.String subjectSourceId1)

source id of the subject which has the permissions

Parameters:

subjectSourceId1 - the subjectSourceId to set

getSubjectId

java.lang.String getSubjectId()

subject id of the subject which has the permissions

Returns:

the subjectId

setSubjectId

void setSubjectId(java.lang.String subjectId1)

subject id of the subject which has the permissions

Parameters:

subjectId1 - the subjectId to set

getAction

java.lang.String getAction()

action on the permission (e.g. read, write, assign (default), etc

Returns:

the action

setAction

void setAction(java.lang.String action1)

action on the permission (e.g. read, write, assign (default), etc

Parameters:

action1 - the action to set

getAttributeDefNameName

java.lang.String getAttributeDefNameName()

name of the attribute def name which is the permission assigned to the role or subject

Returns:

the attributeDefNameName

setAttributeDefNameName

void setAttributeDefNameName(java.lang.String attributeDefNameName1)

name of the attribute def name which is the permission assigned to the role or subject

Parameters:

attributeDefNameName1 - the attributeDefNameName to set

getAttributeDefNameDispName

java.lang.String getAttributeDefNameDispName()

display name of the attribute def name which is the permission assigned to the role or subject

Returns:

the attributeDefNameDispName

setAttributeDefNameDispName

void setAttributeDefNameDispName(java.lang.String attributeDefNameDispName1)

display name of the attribute def name which is the permission assigned to the role or subject

Parameters:

attributeDefNameDispName1 - the attributeDefNameDispName to set

getRoleDisplayName

java.lang.String getRoleDisplayName()

display name of the role which the subject is in to have the permission

Returns:

the roleDisplayName

setRoleDisplayName

void setRoleDisplayName(java.lang.String roleDisplayName1)

display name of the role which the subject is in to have the permission

Parameters:

roleDisplayName1 - the roleDisplayName to set

getRoleId

java.lang.String getRoleId()

id of the role which the subject is in to get the permission

Returns:

the roleId

getRole

Role getRole()

owner role

Returns:

the ownerRole

getAttributeDefName

AttributeDefName getAttributeDefName()

get attribute def name

Returns:

attributeDefName

getAttributeAssign

AttributeAssign getAttributeAssign()

get attribute assign

Returns:

attributeAssign

setRoleId

void setRoleId(java.lang.String roleId1)

id of the role which the subject is in to get the permission

Parameters:

roleId1 - the roleId to set

getAttributeDefId

java.lang.String getAttributeDefId()

id of the attributeDef

Returns:

the attributeDefId

getAttributeDef

AttributeDef getAttributeDef()

Returns:

attributeDef

setAttributeDefId

void setAttributeDefId(java.lang.String attributeDefId1)

id of the attributeDef

Parameters:

attributeDefId1 - the attributeDefId to set

getMemberId

java.lang.String getMemberId()

id of the member that has the permission

Returns:

the memberId

getMember

Member getMember()

get the member

Returns:

the member

setMemberId

void setMemberId(java.lang.String memberId1)

id of the member that has the permission

Parameters:

memberId1 - the memberId to set

getAttributeDefNameId

java.lang.String getAttributeDefNameId()

id of the attribute def name which is the permission

Returns:

the attributeDefNameId

setAttributeDefNameId

void setAttributeDefNameId(java.lang.String attributeDefNameId1)

id of the attribute def name which is the permission

Parameters:

attributeDefNameId1 - the attributeDefNameId to set

getAttributeAssignDelegatable

AttributeAssignDelegatable getAttributeAssignDelegatable()

get the enum for delegatable, do not return null

Returns:

the attributeAssignDelegatable

getAttributeAssignDelegatableDb

java.lang.String getAttributeAssignDelegatableDb()

internal method for hibernate to persist this enum

Returns:

the string value (enum name)

getDisabledTime

java.sql.Timestamp getDisabledTime()

if there is a date here, and it is in the past, this assignment is disabled

Returns:

the disabledTimeDb

getDisabledTimeDb

java.lang.Long getDisabledTimeDb()

if there is a date here, and it is in the past, this assignment is disabled

Returns:

the disabledTimeDb

getEnabledDb

java.lang.String getEnabledDb()

true or false for if this assignment is enabled (e.g. might have expired)

Returns:

the enabled

getEnabledTime

java.sql.Timestamp getEnabledTime()

if there is a date here, and it is in the future, this assignment is disabled until that time

Returns:

the enabledTimeDb

getEnabledTimeDb

java.lang.Long getEnabledTimeDb()

if there is a date here, and it is in the future, this assignment is disabled until that time

Returns:

the enabledTimeDb

isEnabled

boolean isEnabled()

true or false for if this assignment is enabled (e.g. might have expired)

Returns:

the enabled

setAttributeAssignDelegatable

void setAttributeAssignDelegatable(AttributeAssignDelegatable attributeAssignDelegatable1)

Parameters:

attributeAssignDelegatable1 - the attributeAssignDelegatable to set

setAttributeAssignDelegatableDb

void setAttributeAssignDelegatableDb(java.lang.String theAttributeAssignDelegatableDb)

internal method for hibernate to set if delegatable

Parameters:

theAttributeAssignDelegatableDb -

setDisabledTime

void setDisabledTime(java.sql.Timestamp disabledTimeDb1)

if there is a date here, and it is in the past, this assignment is disabled

Parameters:

disabledTimeDb1 - the disabledTimeDb to set

setDisabledTimeDb

void setDisabledTimeDb(java.lang.Long disabledTimeDb1)

if there is a date here, and it is in the past, this assignment is disabled

Parameters:

disabledTimeDb1 - the disabledTimeDb to set

setEnabled

void setEnabled(boolean enabled1)

true or false for if this assignment is enabled (e.g. might have expired)

Parameters:

enabled1 - the enabled to set

setEnabledDb

void setEnabledDb(java.lang.String enabled1)

true or false for if this assignment is enabled (e.g. might have expired)

Parameters:

enabled1 - the enabled to set

setEnabledTime

void setEnabledTime(java.sql.Timestamp enabledTimeDb1)

if there is a date here, and it is in the future, this assignment is disabled until that time

Parameters:

enabledTimeDb1 - the enabledTimeDb to set

setEnabledTimeDb

void setEnabledTimeDb(java.lang.Long enabledTimeDb1)

if there is a date here, and it is in the future, this assignment is disabled until that time

Parameters:

enabledTimeDb1 - the enabledTimeDb to set

getPermissionTypeDb

java.lang.String getPermissionTypeDb()

type of permission, either assigned to role, or assigned to role and user combined: role_subject

Returns:

type of permission

setPermissionTypeDb

void setPermissionTypeDb(java.lang.String permissionTypeDb1)

type of permission, either assigned to role, or assigned to role and user combined: role_subject

Parameters:

permissionTypeDb1 -

getPermissionType

PermissionEntry.PermissionType getPermissionType()

type of permission, either assigned to role, or assigned to role and user combined: role_subject

Returns:

permission type

getMembershipId

java.lang.String getMembershipId()

id of the membership row

Returns:

id of the membership row

isImmediate

boolean isImmediate(PermissionEntry.PermissionType thePermissionType)

Parameters:

thePermissionType -

Returns:

if immediate, considering which permission type we are looking at

isImmediateMembership

boolean isImmediateMembership()

see if the membership is unassignable directly

Returns:

true if immediate

isImmediatePermission

boolean isImmediatePermission()

see if the permission is unassignable directly

Returns:

true if immediate

setMembershipId

void setMembershipId(java.lang.String membershipId1)

id of the membership row

Parameters:

membershipId1 -

getAttributeAssignId

java.lang.String getAttributeAssignId()

id of the attribute assign row, either to the role, or to the role member pair

Returns:

id

setAttributeAssignId

void setAttributeAssignId(java.lang.String attributeAssignId1)

id of the attribute assign row, either to the role, or to the role member pair

Parameters:

attributeAssignId1 -

getDisallowedDb

java.lang.String getDisallowedDb()

if this is a permission, then if this permission assignment is allowed or not

Returns:

the allowed

isDisallowed

boolean isDisallowed()

if this is a permission, then if this permission assignment is allowed or not

Returns:

if allowed

setDisallowed

void setDisallowed(boolean disallowed1)

if this is a permission, then if this permission assignment is allowed or not

Parameters:

disallowed1 - the allowed to set

setDisallowedDb

void setDisallowedDb(java.lang.String disallowed1)

if this is a permission, then if this permission assignment is allowed or not

Parameters:

disallowed1 - the allowed to set

getEndTime

java.sql.Timestamp getEndTime()

The end time for this permission entry. This is for point in time.

Returns:

end time

getStartTime

java.sql.Timestamp getStartTime()

The start time for this permission entry. This is for point in time.

Returns:

start time

isActive

boolean isActive()

Whether this permission entry currently exists. If the object is not from point in time, this is always true.

Returns:

true if active