de.hybris.platform.jalo.user

Class UserGroup

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.jalo.security.GeneratedPrincipal

de.hybris.platform.jalo.security.Principal

de.hybris.platform.jalo.security.GeneratedPrincipalGroup

de.hybris.platform.jalo.security.PrincipalGroup

de.hybris.platform.jalo.user.GeneratedUserGroup

de.hybris.platform.jalo.user.UserGroup

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

GeneratedB2BUserGroup, GeneratedBackofficeRole, GeneratedCompany, GeneratedCsAgentGroup, GeneratedCustomerList, GeneratedStoreEmployeeGroup, TestUserGroup

public class UserGroup
extends GeneratedUserGroup

The user group item in the hybris platform.

Usergroups are used to organize users. Further groups may be used for permission management, since any user right assigned to a group automaticaly applies to its members.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields inherited from class de.hybris.platform.jalo.user.GeneratedUserGroup

DEFAULT_INITIAL_ATTRIBUTES, HMCXML, READABLELANGUAGES, WRITEABLELANGUAGES

Fields inherited from class de.hybris.platform.jalo.security.GeneratedPrincipalGroup

LOCNAME, MAXBRUTEFORCELOGINATTEMPTS, MEMBERS, PRINCIPALGROUPRELATION_MARKMODIFIED, PRINCIPALGROUPRELATION_SRC_ORDERED, PRINCIPALGROUPRELATION_TGT_ORDERED

Fields inherited from class de.hybris.platform.jalo.security.Principal

ALLGROUPS, ALLSEARCHRESTRICTIONS, DISPLAYNAME, PRINCIPAL_GROUP_RELATION_NAME

Fields inherited from class de.hybris.platform.jalo.security.GeneratedPrincipal

DESCRIPTION, GROUPS, NAME, SEARCHRESTRICTIONS, SEARCHRESTRICTIONSHANDLER, UID

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
UserGroup()

Method Summary

Modifier and Type	Method and Description
void	checkSystemPrincipal() Deprecated. since ages - useUserService.getAdminUserGroup()
Address	createAddress() Deprecated. since ages - useAddressService.createAddressForOwner(ItemModel)
Address	createAddress(java.util.Map fields) Deprecated. since ages - useAddressService.createAddressForOwner(ItemModel)
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
java.util.Collection	getAllAddresses() Deprecated. since ages - UseAddressService.getAddressesForOwner(ItemModel)
boolean	isAdmin() Deprecated. since ages - useUserService.isAdminGroup(UserGroupModel)
void	setUid(SessionContext ctx, java.lang.String value) Generated method - Setter of the Principal.uid attribute.

Methods inherited from class de.hybris.platform.jalo.user.GeneratedUserGroup

getDefaultAttributeModes, getHmcXML, getHmcXML, getReadableLanguages, getReadableLanguages, getWriteableLanguages, getWriteableLanguages, setHmcXML, setHmcXML, setReadableLanguages, setReadableLanguages, setWriteableLanguages, setWriteableLanguages

Methods inherited from class de.hybris.platform.jalo.security.PrincipalGroup

addMember, addMember, addToGroup, addToGroups, containsMember, containsMember, getAllDisplayName, getAllLocNames, getDisplayName, getMembers, removeMember, removeMember, setAllLocNames, setGroups, setMembers

Methods inherited from class de.hybris.platform.jalo.security.GeneratedPrincipalGroup

addToMembers, addToMembers, getAllLocName, getAllLocName, getLocName, getLocName, getMaxBruteForceLoginAttempts, getMaxBruteForceLoginAttempts, getMaxBruteForceLoginAttemptsAsPrimitive, getMaxBruteForceLoginAttemptsAsPrimitive, getMembers, getMembersCount, getMembersCount, isMarkModifiedDisabled, removeFromMembers, removeFromMembers, setAllLocName, setAllLocName, setLocName, setLocName, setMaxBruteForceLoginAttempts, setMaxBruteForceLoginAttempts, setMaxBruteForceLoginAttempts, setMaxBruteForceLoginAttempts, setMembers, setMembers

Methods inherited from class de.hybris.platform.jalo.security.Principal

addGlobalNegativePermission, addGlobalPermission, addGlobalPermissions, addGlobalPositivePermission, checkConsistencyUid, checkGlobalPermission, checkOwnGlobalPermission, clearGlobalPermission, clearGlobalPermissions, getAllDisplayName, getAllGlobalNegativePermissions, getAllGlobalPositivePermissions, getAllGroups, getAllGroups, getAllSearchRestrictions, getAllSearchRestrictions, getDisplayName, getGlobalNegativePermissions, getGlobalPermissions, getGlobalPositivePermissions, getGroups, getItemPermissionsMap, getUID, getUid, isMemberOf, isMemberOf, remove, removeFromGroup, setItemPermissionsByMap, setUID, toString

Methods inherited from class de.hybris.platform.jalo.security.GeneratedPrincipal

addToGroups, getDescription, getDescription, getGroups, getGroupsCount, getGroupsCount, getName, getName, getSearchRestrictions, getSearchRestrictions, getUid, removeFromGroups, removeFromGroups, setDescription, setDescription, setGroups, setName, setName, setUid

Methods inherited from class de.hybris.platform.jalo.GenericItem

getInitialProperties, getNonInitialAttributes

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserGroup

public UserGroup()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Description copied from class: Item

Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
Sn example:

 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }

 

Overrides:

createItem in class GenericItem

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

checkSystemPrincipal

@Deprecated
public void checkSystemPrincipal()
                                      throws ConsistencyCheckException

Deprecated. since ages - useUserService.getAdminUserGroup()

Specified by:

checkSystemPrincipal in class Principal

Throws:

ConsistencyCheckException

setUid

public void setUid(SessionContext ctx,
                   java.lang.String value)
            throws ConsistencyCheckException

Description copied from class: GeneratedPrincipal

Generated method - Setter of the Principal.uid attribute.

Overrides:

setUid in class GeneratedPrincipal

value - the uid

Throws:

ConsistencyCheckException

getAllAddresses

@Deprecated
public java.util.Collection getAllAddresses()

Deprecated. since ages - UseAddressService.getAddressesForOwner(ItemModel)

All addresses of this user.

createAddress

@Deprecated
public Address createAddress()

Deprecated. since ages - useAddressService.createAddressForOwner(ItemModel)

Creates a new address for this user. To remove an address use its remove method !

createAddress

@Deprecated
public Address createAddress(java.util.Map fields)

Deprecated. since ages - useAddressService.createAddressForOwner(ItemModel)

Creates a new address for this user, filled with the fields given in the parameter map. To remove an address use its remove method !

isAdmin

@Deprecated
public boolean isAdmin()

Deprecated. since ages - useUserService.isAdminGroup(UserGroupModel)

checks if this group has admin status. this is true if the group actually is the admin group or is a subgroup of the admin group.

Specified by:

isAdmin in class Principal