com.atlassian.jira.sharing.type
Interface ShareTypeValidator

All Known Implementing Classes:

GlobalShareTypeValidator, GroupShareTypeValidator, ProjectShareTypeValidator

public interface ShareTypeValidator

Interface that defines the validation of a particular ShareType. Validation is checking that its associated SharePermission or ShareTypeSearchParameter is valid.

Field Summary

static String

ERROR_KEY Key used for any error messages.

Method Summary

boolean	checkSearchParameter(JiraServiceContext ctx, ShareTypeSearchParameter searchParameter) Check to see if the passed SearchParameter is valid for the ShareType.
boolean	checkSharePermission(JiraServiceContext ctx, SharePermission permission) Checks if the passed SharePermission is valid for the associated ShareType.

Field Detail

ERROR_KEY

static final String ERROR_KEY

Key used for any error messages.

See Also:

Constant Field Values

Method Detail

checkSharePermission

boolean checkSharePermission(JiraServiceContext ctx,
                             SharePermission permission)

Checks if the passed SharePermission is valid for the associated ShareType.

Parameters:

ctx - Context containing the user that is to store the SharePermission, the i18n bean and an ErrorCollection

permission - the SharePermission to check.

Returns:

true if the permission is valid or false otherwise.

checkSearchParameter

boolean checkSearchParameter(JiraServiceContext ctx,
                             ShareTypeSearchParameter searchParameter)

Check to see if the passed SearchParameter is valid for the ShareType.

Parameters:

ctx - Context containing the user that is to store the SharePermission, the i18n bean and an ErrorCollection

searchParameter - the parameter is check.

Returns:

true if the parameter is valid or false otherwise.