Package com.hybris.cockpitng.dataaccess.facades.permissions

Interface PermissionManagementFacade

All Known Subinterfaces:

PermissionManagementFacadeStrategy

All Known Implementing Classes:

DefaultPermissionManagementFacade

public interface PermissionManagementFacade

Allows managing principal permissions.

Method Summary

Modifier and Type	Method	Description
void	deletePermission(Permission permission)	Delete permission assignment.
Permission	getFieldPermission(java.lang.String principal, java.lang.String typeCode, java.lang.String field, java.lang.String permissionName)	Returns a Permission object for the given permissionName, type's field and principal.
PermissionInfo	getFieldPermissionInfo(java.lang.String principal, java.lang.String typeCode, java.lang.String field)	Returns a PermissionInfo object representing the permission values of a field on a type for a given principal.
PermissionInfo	getPrincipalPermissionInfo(java.lang.String principal, java.lang.String typeCode)	Returns all permissions for the given principal
java.util.Collection<PermissionInfo>	getPrincipalsWithPermissionAssignment(java.lang.String typeCode)	Returns permission infos related to all principals who have any permission assignment for the given type.
Permission	getTypePermission(java.lang.String principal, java.lang.String typeCode, java.lang.String permissionName)	Returns permission by given name for given type and principal.
PermissionInfo	getTypePermissionInfo(java.lang.String principal, java.lang.String typeCode)	Returns all permissions for the given type
java.util.Collection<PermissionInfo>	getTypePermissionInfosForPrincipal(java.lang.String principal)	Returns all PermissionInfos related to all types for which a given principal has any permission assignments.
void	setPermission(Permission permission)	Store new permission assignment.
PermissionInfo	updatePermissionInfo(Permission permission)	Reload of the PermissionInfo.

Method Detail

getTypePermission

Permission getTypePermission(java.lang.String principal,
                             java.lang.String typeCode,
                             java.lang.String permissionName)

Returns permission by given name for given type and principal.

Parameters:

principal - - principal for which permission is fetched.

typeCode - - type for which permission is fetched.

permissionName - - permission name

Returns:

permission for given inputs

getTypePermissionInfo

PermissionInfo getTypePermissionInfo(java.lang.String principal,
                                     java.lang.String typeCode)

Returns all permissions for the given type

Parameters:

principal - - principal for which permissions are fetched.

typeCode - - type for which permissions are fetched.

Returns:

permission info for the given type.

getPrincipalPermissionInfo

PermissionInfo getPrincipalPermissionInfo(java.lang.String principal,
                                          java.lang.String typeCode)

Returns all permissions for the given principal

Parameters:

principal - - principal for which permissions are fetched.

typeCode - - type for which permissions are fetched.

Returns:

permission info for the given principal.

getFieldPermission

Permission getFieldPermission(java.lang.String principal,
                              java.lang.String typeCode,
                              java.lang.String field,
                              java.lang.String permissionName)

Returns a Permission object for the given permissionName, type's field and principal.

Parameters:

principal - - principal for which permission is fetched.

typeCode - - type for which permission is fetched.

permissionName - - permission name

field - - field for which permission is fetched.

Returns:

permission for the given field.

getFieldPermissionInfo

PermissionInfo getFieldPermissionInfo(java.lang.String principal,
                                      java.lang.String typeCode,
                                      java.lang.String field)

Returns a PermissionInfo object representing the permission values of a field on a type for a given principal.

Parameters:

principal - - principal for which permission is fetched.

typeCode - - type for which permission is fetched.

field - - field or attribute for which permission is fetched.

Returns:

permission info for the given field.

getPrincipalsWithPermissionAssignment

java.util.Collection<PermissionInfo> getPrincipalsWithPermissionAssignment(java.lang.String typeCode)

Returns permission infos related to all principals who have any permission assignment for the given type.

Parameters:

typeCode - - principals with permission assignments to this type will be fetched.

Returns:

Collection of PermissionInfos

getTypePermissionInfosForPrincipal

java.util.Collection<PermissionInfo> getTypePermissionInfosForPrincipal(java.lang.String principal)

Returns all PermissionInfos related to all types for which a given principal has any permission assignments.

Parameters:

principal - - principal for which permission is fetched.

Returns:

Collection of PermissionInfos.

setPermission

void setPermission(Permission permission)

Store new permission assignment.

Parameters:

permission - to set.

deletePermission

void deletePermission(Permission permission)

Delete permission assignment.

Parameters:

permission - to delete.

updatePermissionInfo

PermissionInfo updatePermissionInfo(Permission permission)

Reload of the PermissionInfo.

Parameters:

permission - to update

Returns:

updated permission info.