org.alfresco.module.org_alfresco_module_rm.caveat

Interface RMCaveatConfigService

All Known Implementing Classes:

RMCaveatConfigServiceImpl

public interface RMCaveatConfigService

Method Summary

Modifier and Type	Method and Description
RMConstraintInfo	addRMConstraint(String listName, String listTitle, String[] allowedValues) add RM constraint list
void	addRMConstraintListValue(String listName, String authorityName, String value) Add a single value to an authority in a list.
void	deleteRMConstraint(String listName) delete RM Constraint
Set<RMConstraintInfo>	getAllRMConstraints()
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)
RMConstraintInfo	getRMConstraint(String listName)
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 an authority from a list
void	removeRMConstraintListValue(String listName, String valueName) Remove an authority from a list
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)
RMConstraintInfo	updateRMConstraintAllowedValues(String listName, String[] allowedValues) update RM constraint list allowed values
void	updateRMConstraintListAuthority(String listName, String authorityName, List<String> values) Replace the values for an authority in a list.
void	updateRMConstraintListValue(String listName, String value, List<String> authorities) Replace the values for an authority in a list.
RMConstraintInfo	updateRMConstraintTitle(String listName, String newTitle) update RM constraint Title

Method Detail

init

void init()

getRMAllowedValues

List<String> getRMAllowedValues(String constraintName)

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

Parameters:

constraintName -

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)

getAllRMConstraints

Set<RMConstraintInfo> getAllRMConstraints()

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)

addRMConstraint

RMConstraintInfo addRMConstraint(String listName,
                                 String listTitle,
                                 String[] allowedValues)

add RM constraint list

Parameters:

listName - the name of the RMConstraintList

listTitle -

updateRMConstraintAllowedValues

RMConstraintInfo updateRMConstraintAllowedValues(String listName,
                                                 String[] allowedValues)

update RM constraint list allowed values

Parameters:

listName - the name of the RMConstraintList - can not be changed

allowedValues -

updateRMConstraintTitle

RMConstraintInfo updateRMConstraintTitle(String listName,
                                         String newTitle)

update RM constraint Title

Parameters:

listName - the name of the RMConstraintList - can not be changed

allowedValues -

deleteRMConstraint

void deleteRMConstraint(String listName)

delete RM Constraint

Parameters:

listName - the name of the RMConstraintList

addRMConstraintListValue

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

Add a single value to an authority in a list. The existing values of the list remain.

Parameters:

listName - the name of the RMConstraintList

authorityName -

values -

Throws:

org.alfresco.error.AlfrescoRuntimeException - if either the list or the authority do not already exist.

updateRMConstraintListAuthority

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

Replace the values for an authority in a list. The existing values are removed. If the authority does not already exist in the list, it will be added

Parameters:

listName - the name of the RMConstraintList

authorityName -

values -

removeRMConstraintListAuthority

void removeRMConstraintListAuthority(String listName,
                                     String authorityName)

Remove an authority from a list

Parameters:

listName - the name of the RMConstraintList

authorityName -

values -

updateRMConstraintListValue

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

Replace the values for an authority in a list. The existing values are removed. If the authority does not already exist in the list, it will be added

Parameters:

listName - the name of the RMConstraintList

value -

authorities -

removeRMConstraintListValue

void removeRMConstraintListValue(String listName,
                                 String valueName)

Remove an authority from a list

Parameters:

listName - the name of the RMConstraintList

authorityName -

value -