Class PrincipalModel
java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.core.model.security.PrincipalModel
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
PrincipalGroupModel,UserModel
Generated model class for type Principal first defined at extension core.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringGenerated relation code constant for relationCategory2PrincipalRelationdefining source attributeaccessibleCategoriesin extensioncatalog.static final StringGenerated relation code constant for relationCommentWatcherRelationdefining source attributewatchedCommentsin extensioncomments.static final StringGenerated relation code constant for relationSyncItemJob2Principaldefining source attributesyncJobsin extensioncatalog.static final StringGenerated model type code constant.static final StringGenerated relation code constant for relationWorkflowTemplate2PrincipalRelationdefining source attributevisibleTemplatesin extensionworkflow.static final StringGenerated constant - Attribute key ofPrincipal.accessibleCategoriesattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofPrincipal.allGroupsattribute defined at extensioncore.static final StringGenerated constant - Attribute key ofPrincipal.allSearchRestrictionsattribute defined at extensioncore.static final StringGenerated constant - Attribute key ofPrincipal.backOfficeLoginDisabledattribute defined at extensionbackoffice.static final StringGenerated constant - Attribute key ofPrincipal.descriptionattribute defined at extensioncore.static final StringGenerated constant - Attribute key ofPrincipal.displayNameattribute defined at extensioncore.static final StringGenerated constant - Attribute key ofPrincipal.groupsattribute defined at extensioncore.static final StringGenerated constant - Attribute key ofPrincipal.nameattribute defined at extensioncore.static final StringGenerated constant - Attribute key ofPrincipal.profilePictureattribute defined at extensioncomments.static final StringGenerated constant - Attribute key ofPrincipal.readableCatalogVersionsattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofPrincipal.searchRestrictionsattribute defined at extensioncore.static final StringGenerated constant - Attribute key ofPrincipal.syncJobsattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofPrincipal.uidattribute defined at extensioncore.static final StringGenerated constant - Attribute key ofPrincipal.visibleTemplatesattribute defined at extensionworkflow.static final StringGenerated constant - Attribute key ofPrincipal.watchedCommentsattribute defined at extensioncomments.static final StringGenerated constant - Attribute key ofPrincipal.writableCatalogVersionsattribute defined at extensioncatalog.Fields inherited from class de.hybris.platform.core.model.ItemModel
_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALEDFields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY -
Constructor Summary
ConstructorsConstructorDescriptionGenerated constructor - Default constructor for generic creation.PrincipalModel(ItemModel _owner, String _uid) Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parametersPrincipalModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx) Generated constructor - Default constructor for creation with existing contextPrincipalModel(String _uid) Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parameters -
Method Summary
Modifier and TypeMethodDescriptionGenerated method - Getter of thePrincipal.accessibleCategoriesattribute defined at extensioncatalog.Deprecated, for removal: This API element is subject to removal in a future version.since ages - use { @link #getAllGroups()} insteadGenerated method - Getter of thePrincipal.allGroupsdynamic attribute defined at extensioncore.Deprecated, for removal: This API element is subject to removal in a future version.since ages - use { @link #getAllSearchRestrictions()} insteadGenerated method - Getter of thePrincipal.allSearchRestrictionsdynamic attribute defined at extensioncore.Generated method - Getter of thePrincipal.backOfficeLoginDisabledattribute defined at extensionbackoffice.Generated method - Getter of thePrincipal.descriptionattribute defined at extensioncore.Generated method - Getter of thePrincipal.displayNamedynamic attribute defined at extensioncore.getDisplayName(Locale loc) Generated method - Getter of thePrincipal.displayNamedynamic attribute defined at extensioncore.Generated method - Getter of thePrincipal.groupsattribute defined at extensioncore.getName()Generated method - Getter of thePrincipal.nameattribute defined at extensioncore.Generated method - Getter of thePrincipal.profilePictureattribute defined at extensioncomments.Generated method - Getter of thePrincipal.readableCatalogVersionsattribute defined at extensioncatalog.Deprecated, for removal: This API element is subject to removal in a future version.since ages - use { @link #getSearchRestrictions()} insteadGenerated method - Getter of thePrincipal.searchRestrictionsattribute defined at extensioncore.Generated method - Getter of thePrincipal.syncJobsattribute defined at extensioncatalog.getUid()Generated method - Getter of thePrincipal.uidattribute defined at extensioncore.Generated method - Getter of thePrincipal.visibleTemplatesattribute defined at extensionworkflow.Generated method - Getter of thePrincipal.watchedCommentsattribute defined at extensioncomments.Generated method - Getter of thePrincipal.writableCatalogVersionsattribute defined at extensioncatalog.voidGenerated method - Setter ofPrincipal.backOfficeLoginDisabledattribute defined at extensionbackoffice.voidsetDescription(String value) Generated method - Setter ofPrincipal.descriptionattribute defined at extensioncore.voidsetGroups(Set<PrincipalGroupModel> value) Generated method - Setter ofPrincipal.groupsattribute defined at extensioncore.voidGenerated method - Setter ofPrincipal.nameattribute defined at extensioncore.voidsetProfilePicture(MediaModel value) Generated method - Setter ofPrincipal.profilePictureattribute defined at extensioncomments.voidGenerated method - Setter ofPrincipal.readableCatalogVersionsattribute defined at extensioncatalog.voidsetSyncJobs(Collection<SyncItemJobModel> value) Generated method - Setter ofPrincipal.syncJobsattribute defined at extensioncatalog.voidGenerated method - Setter ofPrincipal.uidattribute defined at extensioncore.voidGenerated method - Setter ofPrincipal.visibleTemplatesattribute defined at extensionworkflow.voidsetWatchedComments(List<CommentModel> value) Generated method - Setter ofPrincipal.watchedCommentsattribute defined at extensioncomments.voidGenerated method - Setter ofPrincipal.writableCatalogVersionsattribute defined at extensioncatalog.Methods inherited from class de.hybris.platform.core.model.ItemModel
getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwnerMethods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace
-
Field Details
-
_TYPECODE
Generated model type code constant.- See Also:
-
_CATEGORY2PRINCIPALRELATION
Generated relation code constant for relationCategory2PrincipalRelationdefining source attributeaccessibleCategoriesin extensioncatalog.- See Also:
-
_SYNCITEMJOB2PRINCIPAL
Generated relation code constant for relationSyncItemJob2Principaldefining source attributesyncJobsin extensioncatalog.- See Also:
-
_WORKFLOWTEMPLATE2PRINCIPALRELATION
Generated relation code constant for relationWorkflowTemplate2PrincipalRelationdefining source attributevisibleTemplatesin extensionworkflow.- See Also:
-
_COMMENTWATCHERRELATION
Generated relation code constant for relationCommentWatcherRelationdefining source attributewatchedCommentsin extensioncomments.- See Also:
-
DESCRIPTION
Generated constant - Attribute key ofPrincipal.descriptionattribute defined at extensioncore.- See Also:
-
NAME
Generated constant - Attribute key ofPrincipal.nameattribute defined at extensioncore.- See Also:
-
DISPLAYNAME
Generated constant - Attribute key ofPrincipal.displayNameattribute defined at extensioncore.- See Also:
-
UID
Generated constant - Attribute key ofPrincipal.uidattribute defined at extensioncore.- See Also:
-
ALLSEARCHRESTRICTIONS
Generated constant - Attribute key ofPrincipal.allSearchRestrictionsattribute defined at extensioncore.- See Also:
-
ALLGROUPS
Generated constant - Attribute key ofPrincipal.allGroupsattribute defined at extensioncore.- See Also:
-
GROUPS
Generated constant - Attribute key ofPrincipal.groupsattribute defined at extensioncore.- See Also:
-
SEARCHRESTRICTIONS
Generated constant - Attribute key ofPrincipal.searchRestrictionsattribute defined at extensioncore.- See Also:
-
ACCESSIBLECATEGORIES
Generated constant - Attribute key ofPrincipal.accessibleCategoriesattribute defined at extensioncatalog.- See Also:
-
WRITABLECATALOGVERSIONS
Generated constant - Attribute key ofPrincipal.writableCatalogVersionsattribute defined at extensioncatalog.- See Also:
-
READABLECATALOGVERSIONS
Generated constant - Attribute key ofPrincipal.readableCatalogVersionsattribute defined at extensioncatalog.- See Also:
-
SYNCJOBS
Generated constant - Attribute key ofPrincipal.syncJobsattribute defined at extensioncatalog.- See Also:
-
VISIBLETEMPLATES
Generated constant - Attribute key ofPrincipal.visibleTemplatesattribute defined at extensionworkflow.- See Also:
-
PROFILEPICTURE
Generated constant - Attribute key ofPrincipal.profilePictureattribute defined at extensioncomments.- See Also:
-
WATCHEDCOMMENTS
Generated constant - Attribute key ofPrincipal.watchedCommentsattribute defined at extensioncomments.- See Also:
-
BACKOFFICELOGINDISABLED
Generated constant - Attribute key ofPrincipal.backOfficeLoginDisabledattribute defined at extensionbackoffice.- See Also:
-
-
Constructor Details
-
PrincipalModel
public PrincipalModel()Generated constructor - Default constructor for generic creation. -
PrincipalModel
public PrincipalModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx) Generated constructor - Default constructor for creation with existing context- Parameters:
ctx- the model context to be injected, must not be null
-
PrincipalModel
Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parametersGenerated constructor - Constructor with all mandatory attributes.- Parameters:
_uid- initial attribute declared by typePrincipalat extensioncore
-
PrincipalModel
Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parametersGenerated constructor - for all mandatory and initial attributes.- Parameters:
_owner- initial attribute declared by typeItemat extensioncore_uid- initial attribute declared by typePrincipalat extensioncore
-
-
Method Details
-
getAccessibleCategories
@Accessor(qualifier="accessibleCategories", type=GETTER) public Collection<CategoryModel> getAccessibleCategories()Generated method - Getter of thePrincipal.accessibleCategoriesattribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the accessibleCategories - catalog categories which are accessible for this principal
-
getAllgroups
Deprecated, for removal: This API element is subject to removal in a future version.since ages - use { @link #getAllGroups()} insteadGenerated method - Getter of thePrincipal.allGroupsdynamic attribute defined at extensioncore. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the allGroups
-
getAllGroups
Generated method - Getter of thePrincipal.allGroupsdynamic attribute defined at extensioncore. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the allGroups
-
getAllsearchrestrictions
@Deprecated(since="ages", forRemoval=true) public Collection<SearchRestrictionModel> getAllsearchrestrictions()Deprecated, for removal: This API element is subject to removal in a future version.since ages - use { @link #getAllSearchRestrictions()} insteadGenerated method - Getter of thePrincipal.allSearchRestrictionsdynamic attribute defined at extensioncore. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the allSearchRestrictions
-
getAllSearchRestrictions
@Accessor(qualifier="allSearchRestrictions", type=GETTER) public Collection<SearchRestrictionModel> getAllSearchRestrictions()Generated method - Getter of thePrincipal.allSearchRestrictionsdynamic attribute defined at extensioncore. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the allSearchRestrictions
-
getBackOfficeLoginDisabled
@Accessor(qualifier="backOfficeLoginDisabled", type=GETTER) public Boolean getBackOfficeLoginDisabled()Generated method - Getter of thePrincipal.backOfficeLoginDisabledattribute defined at extensionbackoffice.- Returns:
- the backOfficeLoginDisabled
-
getDescription
Generated method - Getter of thePrincipal.descriptionattribute defined at extensioncore.- Returns:
- the description
-
getDisplayName
Generated method - Getter of thePrincipal.displayNamedynamic attribute defined at extensioncore.- Returns:
- the displayName
-
getDisplayName
Generated method - Getter of thePrincipal.displayNamedynamic attribute defined at extensioncore.- Parameters:
loc- the value localization key- Returns:
- the displayName
- Throws:
IllegalArgumentException- if localization key cannot be mapped to data language
-
getGroups
Generated method - Getter of thePrincipal.groupsattribute defined at extensioncore. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the groups
-
getName
Generated method - Getter of thePrincipal.nameattribute defined at extensioncore.- Returns:
- the name
-
getProfilePicture
Generated method - Getter of thePrincipal.profilePictureattribute defined at extensioncomments.- Returns:
- the profilePicture
-
getReadableCatalogVersions
@Accessor(qualifier="readableCatalogVersions", type=GETTER) public List<CatalogVersionModel> getReadableCatalogVersions()Generated method - Getter of thePrincipal.readableCatalogVersionsattribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the readableCatalogVersions
-
getSearchrestrictions
@Deprecated(since="ages", forRemoval=true) public Collection<SearchRestrictionModel> getSearchrestrictions()Deprecated, for removal: This API element is subject to removal in a future version.since ages - use { @link #getSearchRestrictions()} insteadGenerated method - Getter of thePrincipal.searchRestrictionsattribute defined at extensioncore. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the searchRestrictions
-
getSearchRestrictions
@Accessor(qualifier="searchRestrictions", type=GETTER) public Collection<SearchRestrictionModel> getSearchRestrictions()Generated method - Getter of thePrincipal.searchRestrictionsattribute defined at extensioncore. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the searchRestrictions
-
getSyncJobs
Generated method - Getter of thePrincipal.syncJobsattribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the syncJobs
-
getUid
Generated method - Getter of thePrincipal.uidattribute defined at extensioncore.- Returns:
- the uid
-
getVisibleTemplates
@Accessor(qualifier="visibleTemplates", type=GETTER) public Collection<WorkflowTemplateModel> getVisibleTemplates()Generated method - Getter of thePrincipal.visibleTemplatesattribute defined at extensionworkflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the visibleTemplates
-
getWatchedComments
Generated method - Getter of thePrincipal.watchedCommentsattribute defined at extensioncomments. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the watchedComments
-
getWritableCatalogVersions
@Accessor(qualifier="writableCatalogVersions", type=GETTER) public List<CatalogVersionModel> getWritableCatalogVersions()Generated method - Getter of thePrincipal.writableCatalogVersionsattribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the writableCatalogVersions
-
setBackOfficeLoginDisabled
@Accessor(qualifier="backOfficeLoginDisabled", type=SETTER) public void setBackOfficeLoginDisabled(Boolean value) Generated method - Setter ofPrincipal.backOfficeLoginDisabledattribute defined at extensionbackoffice.- Parameters:
value- the backOfficeLoginDisabled
-
setDescription
Generated method - Setter ofPrincipal.descriptionattribute defined at extensioncore.- Parameters:
value- the description
-
setGroups
Generated method - Setter ofPrincipal.groupsattribute defined at extensioncore.- Parameters:
value- the groups
-
setName
Generated method - Setter ofPrincipal.nameattribute defined at extensioncore.- Parameters:
value- the name
-
setProfilePicture
Generated method - Setter ofPrincipal.profilePictureattribute defined at extensioncomments.- Parameters:
value- the profilePicture
-
setReadableCatalogVersions
@Accessor(qualifier="readableCatalogVersions", type=SETTER) public void setReadableCatalogVersions(List<CatalogVersionModel> value) Generated method - Setter ofPrincipal.readableCatalogVersionsattribute defined at extensioncatalog.- Parameters:
value- the readableCatalogVersions
-
setSyncJobs
@Accessor(qualifier="syncJobs", type=SETTER) public void setSyncJobs(Collection<SyncItemJobModel> value) Generated method - Setter ofPrincipal.syncJobsattribute defined at extensioncatalog.- Parameters:
value- the syncJobs
-
setUid
Generated method - Setter ofPrincipal.uidattribute defined at extensioncore.- Parameters:
value- the uid
-
setVisibleTemplates
@Accessor(qualifier="visibleTemplates", type=SETTER) public void setVisibleTemplates(Collection<WorkflowTemplateModel> value) Generated method - Setter ofPrincipal.visibleTemplatesattribute defined at extensionworkflow.- Parameters:
value- the visibleTemplates
-
setWatchedComments
@Accessor(qualifier="watchedComments", type=SETTER) public void setWatchedComments(List<CommentModel> value) Generated method - Setter ofPrincipal.watchedCommentsattribute defined at extensioncomments.- Parameters:
value- the watchedComments
-
setWritableCatalogVersions
@Accessor(qualifier="writableCatalogVersions", type=SETTER) public void setWritableCatalogVersions(List<CatalogVersionModel> value) Generated method - Setter ofPrincipal.writableCatalogVersionsattribute defined at extensioncatalog.- Parameters:
value- the writableCatalogVersions
-