org.alfresco.module.org_alfresco_module_rm.caveat

Interface RMCaveatConfigComponent

All Known Implementing Classes:

RMCaveatConfigComponentImpl

public interface RMCaveatConfigComponent

Method Summary

Modifier and Type	Method and Description
void	addRMConstraint(String listName) Add RM constraint
void	addRMConstraintListValue(String listName, String authorityName, String value) Add RM constraint value for given authority
void	deleteRMConstraint(String listName) Delete RM Constraint
Map<String,List<String>>	getListDetails(String listName) Get the details of a caveat list
List<String>	getRMAllowedValues(String constraintName) Get allowed values for given caveat list (for current user)
List<org.alfresco.service.namespace.QName>	getRMCaveatModels() Get custom caveat models
RMConstraintInfo	getRMConstraint(String listName) Get RM constraint list
boolean	hasAccess(org.alfresco.service.cmr.repository.NodeRef nodeRef) Check whether access to 'record component' node is vetoed for current user due to caveat(s)
void	init()
void	removeRMConstraintListAuthority(String listName, String authorityName) Remove RM constraint authority (all values)
void	removeRMConstraintListValue(String listName, String valueName) Remove RM constraint value (all authorities)
org.alfresco.service.cmr.repository.NodeRef	updateOrCreateCaveatConfig(File jsonFile)
org.alfresco.service.cmr.repository.NodeRef	updateOrCreateCaveatConfig(InputStream is)
org.alfresco.service.cmr.repository.NodeRef	updateOrCreateCaveatConfig(String jsonString)
void	updateRMConstraintListAuthority(String listName, String authorityName, List<String> values) Update RM constraint values for given authority
void	updateRMConstraintListValue(String listName, String valueName, List<String> authorities) Update RM constraint authorities for given value

Method Detail

init

void init()

getRMAllowedValues

List<String> getRMAllowedValues(String constraintName)

Get allowed values for given caveat list (for current user)

Parameters:

constraintName -

Returns:

getRMCaveatModels

List<org.alfresco.service.namespace.QName> getRMCaveatModels()

Get custom caveat models

Returns:

hasAccess

boolean hasAccess(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Check whether access to 'record component' node is vetoed for current user due to caveat(s)

Parameters:

nodeRef -

Returns:

false, if caveat(s) veto access otherwise return true

getRMConstraint

RMConstraintInfo getRMConstraint(String listName)

Get RM constraint list

Parameters:

listName - the name of the RMConstraintList

addRMConstraint

void addRMConstraint(String listName)

Add RM constraint

addRMConstraintListValue

void addRMConstraintListValue(String listName,
                              String authorityName,
                              String value)

Add RM constraint value for given authority

updateRMConstraintListAuthority

void updateRMConstraintListAuthority(String listName,
                                     String authorityName,
                                     List<String> values)

Update RM constraint values for given authority

updateRMConstraintListValue

void updateRMConstraintListValue(String listName,
                                 String valueName,
                                 List<String> authorities)

Update RM constraint authorities for given value

removeRMConstraintListValue

void removeRMConstraintListValue(String listName,
                                 String valueName)

Remove RM constraint value (all authorities)

removeRMConstraintListAuthority

void removeRMConstraintListAuthority(String listName,
                                     String authorityName)

Remove RM constraint authority (all values)

deleteRMConstraint

void deleteRMConstraint(String listName)

Delete RM Constraint

Parameters:

listName - the name of the RMConstraintList

getListDetails

Map<String,List<String>> getListDetails(String listName)

Get the details of a caveat list

Parameters:

listName -

Returns:

updateOrCreateCaveatConfig

org.alfresco.service.cmr.repository.NodeRef updateOrCreateCaveatConfig(File jsonFile)

updateOrCreateCaveatConfig

org.alfresco.service.cmr.repository.NodeRef updateOrCreateCaveatConfig(String jsonString)

updateOrCreateCaveatConfig

org.alfresco.service.cmr.repository.NodeRef updateOrCreateCaveatConfig(InputStream is)