Interface Capability
-
- All Known Subinterfaces:
CompositeCapability
- All Known Implementing Classes:
AbstractCapability
,ChangeOrDeleteReferencesCapability
,CreateCapability
,DeclarativeCapability
,DeclarativeCompositeCapability
,DeleteLinksCapability
,EditNonRecordMetadataCapability
,UpdateCapability
,ViewRecordsCapability
@AlfrescoPublicApi public interface Capability
Capability Interface.- Author:
- andyh, Roy Wetherall
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
evaluate(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Evaluates the capability.int
evaluate(org.alfresco.service.cmr.repository.NodeRef source, org.alfresco.service.cmr.repository.NodeRef target)
Evaluates the capability, taking into account a target.String
getDescription()
Get the description of the capabilityGroup
getGroup()
Gets the group of a capabilityint
getIndex()
Gets the index of a capabilityString
getName()
Get the name of the capabilityString
getTitle()
Get the title of the capabilityorg.alfresco.service.cmr.security.AccessStatus
hasPermission(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Does this capability apply to this nodeRef?int
hasPermissionRaw(org.alfresco.service.cmr.repository.NodeRef nodeRef)
boolean
isPrivate()
Indicates whether this is a private capability or not.
-
-
-
Method Detail
-
hasPermission
org.alfresco.service.cmr.security.AccessStatus hasPermission(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Does this capability apply to this nodeRef?- Parameters:
nodeRef
-- Returns:
-
hasPermissionRaw
int hasPermissionRaw(org.alfresco.service.cmr.repository.NodeRef nodeRef)
- Parameters:
nodeRef
-- Returns:
-
evaluate
int evaluate(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Evaluates the capability.- Parameters:
nodeRef
-- Returns:
-
evaluate
int evaluate(org.alfresco.service.cmr.repository.NodeRef source, org.alfresco.service.cmr.repository.NodeRef target)
Evaluates the capability, taking into account a target.- Parameters:
source
- source node referencetarget
- target node reference- Returns:
- int permission value
-
isPrivate
boolean isPrivate()
Indicates whether this is a private capability or not. Private capabilities are used internally, otherwise they are made available to the user to assign to roles.- Returns:
- boolean true if private, false otherwise
-
getName
String getName()
Get the name of the capability- Returns:
- String capability name
-
getTitle
String getTitle()
Get the title of the capability- Returns:
- String capability title
-
getDescription
String getDescription()
Get the description of the capability- Returns:
- String capability description
-
getGroup
Group getGroup()
Gets the group of a capability- Returns:
- Group capability group
-
getIndex
int getIndex()
Gets the index of a capability- Returns:
- int capability index
-
-