Package de.hybris.platform.core.model.security

Class PrincipalModel

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • _CATEGORY2PRINCIPALRELATION

        public static final java.lang.String _CATEGORY2PRINCIPALRELATION
        Generated relation code constant for relation Category2PrincipalRelation defining source attribute accessibleCategories in extension catalog.
        See Also:
        Constant Field Values

      • _SYNCITEMJOB2PRINCIPAL

        public static final java.lang.String _SYNCITEMJOB2PRINCIPAL
        Generated relation code constant for relation SyncItemJob2Principal defining source attribute syncJobs in extension catalog.
        See Also:
        Constant Field Values

      • _WORKFLOWTEMPLATE2PRINCIPALRELATION

        public static final java.lang.String _WORKFLOWTEMPLATE2PRINCIPALRELATION
        Generated relation code constant for relation WorkflowTemplate2PrincipalRelation defining source attribute visibleTemplates in extension workflow.
        See Also:
        Constant Field Values

      • _COMMENTWATCHERRELATION

        public static final java.lang.String _COMMENTWATCHERRELATION
        Generated relation code constant for relation CommentWatcherRelation defining source attribute watchedComments in extension comments.
        See Also:
        Constant Field Values

      • _PRINCIPAL2COCKPITUICOMPONENTREADACCESSRELATION

        public static final java.lang.String _PRINCIPAL2COCKPITUICOMPONENTREADACCESSRELATION
        Generated relation code constant for relation Principal2CockpitUIComponentReadAccessRelation defining source attribute readableCockpitUIComponents in extension cockpit.
        See Also:
        Constant Field Values

      • _PRINCIPAL2COCKPITUICOMPONENTWRITEACCESSRELATION

        public static final java.lang.String _PRINCIPAL2COCKPITUICOMPONENTWRITEACCESSRELATION
        Generated relation code constant for relation Principal2CockpitUIComponentWriteAccessRelation defining source attribute writableCockpitUIComponents in extension cockpit.
        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of Principal.description attribute defined at extension core.
        See Also:
        Constant Field Values

      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of Principal.name attribute defined at extension core.
        See Also:
        Constant Field Values

      • DISPLAYNAME

        public static final java.lang.String DISPLAYNAME
        Generated constant - Attribute key of Principal.displayName attribute defined at extension core.
        See Also:
        Constant Field Values

      • UID

        public static final java.lang.String UID
        Generated constant - Attribute key of Principal.uid attribute defined at extension core.
        See Also:
        Constant Field Values

      • ALLSEARCHRESTRICTIONS

        public static final java.lang.String ALLSEARCHRESTRICTIONS
        Generated constant - Attribute key of Principal.allSearchRestrictions attribute defined at extension core.
        See Also:
        Constant Field Values

      • ALLGROUPS

        public static final java.lang.String ALLGROUPS
        Generated constant - Attribute key of Principal.allGroups attribute defined at extension core.
        See Also:
        Constant Field Values

      • GROUPS

        public static final java.lang.String GROUPS
        Generated constant - Attribute key of Principal.groups attribute defined at extension core.
        See Also:
        Constant Field Values

      • SEARCHRESTRICTIONS

        public static final java.lang.String SEARCHRESTRICTIONS
        Generated constant - Attribute key of Principal.searchRestrictions attribute defined at extension core.
        See Also:
        Constant Field Values

      • ACCESSIBLECATEGORIES

        public static final java.lang.String ACCESSIBLECATEGORIES
        Generated constant - Attribute key of Principal.accessibleCategories attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • WRITABLECATALOGVERSIONS

        public static final java.lang.String WRITABLECATALOGVERSIONS
        Generated constant - Attribute key of Principal.writableCatalogVersions attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • READABLECATALOGVERSIONS

        public static final java.lang.String READABLECATALOGVERSIONS
        Generated constant - Attribute key of Principal.readableCatalogVersions attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • SYNCJOBS

        public static final java.lang.String SYNCJOBS
        Generated constant - Attribute key of Principal.syncJobs attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • VISIBLETEMPLATES

        public static final java.lang.String VISIBLETEMPLATES
        Generated constant - Attribute key of Principal.visibleTemplates attribute defined at extension workflow.
        See Also:
        Constant Field Values

      • PROFILEPICTURE

        public static final java.lang.String PROFILEPICTURE
        Generated constant - Attribute key of Principal.profilePicture attribute defined at extension comments.
        See Also:
        Constant Field Values

      • WATCHEDCOMMENTS

        public static final java.lang.String WATCHEDCOMMENTS
        Generated constant - Attribute key of Principal.watchedComments attribute defined at extension comments.
        See Also:
        Constant Field Values

      • BACKOFFICELOGINDISABLED

        public static final java.lang.String BACKOFFICELOGINDISABLED
        Generated constant - Attribute key of Principal.backOfficeLoginDisabled attribute defined at extension backoffice.
        See Also:
        Constant Field Values

      • READCOLLECTIONS

        public static final java.lang.String READCOLLECTIONS
        Generated constant - Attribute key of Principal.readCollections attribute defined at extension cockpit.
        See Also:
        Constant Field Values

      • WRITECOLLECTIONS

        public static final java.lang.String WRITECOLLECTIONS
        Generated constant - Attribute key of Principal.writeCollections attribute defined at extension cockpit.
        See Also:
        Constant Field Values

      • COCKPITUICONFIGURATIONS

        public static final java.lang.String COCKPITUICONFIGURATIONS
        Generated constant - Attribute key of Principal.cockpitUIConfigurations attribute defined at extension cockpit.
        See Also:
        Constant Field Values

      • READABLECOCKPITUICOMPONENTS

        public static final java.lang.String READABLECOCKPITUICOMPONENTS
        Generated constant - Attribute key of Principal.readableCockpitUIComponents attribute defined at extension cockpit.
        See Also:
        Constant Field Values

      • WRITABLECOCKPITUICOMPONENTS

        public static final java.lang.String WRITABLECOCKPITUICOMPONENTS
        Generated constant - Attribute key of Principal.writableCockpitUIComponents attribute defined at extension cockpit.
        See Also:
        Constant Field Values

      • READSAVEDQUERIES

        public static final java.lang.String READSAVEDQUERIES
        Generated constant - Attribute key of Principal.readSavedQueries attribute defined at extension cockpit.
        See Also:
        Constant Field Values

      • LDAPSEARCHBASE

        public static final java.lang.String LDAPSEARCHBASE
        Generated constant - Attribute key of Principal.ldapsearchbase attribute defined at extension ldap.
        See Also:
        Constant Field Values

      • DN

        public static final java.lang.String DN
        Generated constant - Attribute key of Principal.DN attribute defined at extension ldap.
        See Also:
        Constant Field Values

      • CN

        public static final java.lang.String CN
        Generated constant - Attribute key of Principal.CN attribute defined at extension ldap.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PrincipalModel

        public PrincipalModel()
        Generated constructor - Default constructor for generic creation.

      • PrincipalModel

        public PrincipalModel​(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(since="4.1.1",
            forRemoval=true)
public PrincipalModel​(java.lang.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
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _uid - initial attribute declared by type Principal at extension core

      • PrincipalModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public PrincipalModel​(ItemModel _owner,
                      java.lang.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
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _owner - initial attribute declared by type Item at extension core
        _uid - initial attribute declared by type Principal at extension core

    • Method Detail

      • getAccessibleCategories

        @Accessor(qualifier="accessibleCategories",
          type=GETTER)
public java.util.Collection<CategoryModel> getAccessibleCategories()
        Generated method - Getter of the Principal.accessibleCategories attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the accessibleCategories - catalog categories which are accessible for this principal

      • getAllgroups

        @Deprecated(since="ages",
            forRemoval=true)
public java.util.Set<PrincipalGroupModel> getAllgroups()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since ages - use { @link #getAllGroups()} instead
        Generated method - Getter of the Principal.allGroups dynamic attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the allGroups

      • getAllGroups

        @Accessor(qualifier="allGroups",
          type=GETTER)
public java.util.Set<PrincipalGroupModel> getAllGroups()
        Generated method - Getter of the Principal.allGroups dynamic attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the allGroups

      • getAllsearchrestrictions

        @Deprecated(since="ages",
            forRemoval=true)
public java.util.Collection<SearchRestrictionModel> getAllsearchrestrictions()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since ages - use { @link #getAllSearchRestrictions()} instead
        Generated method - Getter of the Principal.allSearchRestrictions dynamic attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the allSearchRestrictions

      • getAllSearchRestrictions

        @Accessor(qualifier="allSearchRestrictions",
          type=GETTER)
public java.util.Collection<SearchRestrictionModel> getAllSearchRestrictions()
        Generated method - Getter of the Principal.allSearchRestrictions dynamic attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the allSearchRestrictions

      • getBackOfficeLoginDisabled

        @Accessor(qualifier="backOfficeLoginDisabled",
          type=GETTER)
public java.lang.Boolean getBackOfficeLoginDisabled()
        Generated method - Getter of the Principal.backOfficeLoginDisabled attribute defined at extension backoffice.
        Returns:
        the backOfficeLoginDisabled

      • getCN

        @Accessor(qualifier="CN",
          type=GETTER)
public java.lang.String getCN()
        Generated method - Getter of the Principal.CN attribute defined at extension ldap.
        Returns:
        the CN

      • getCockpitUIConfigurations

        @Accessor(qualifier="cockpitUIConfigurations",
          type=GETTER)
public java.util.Collection<CockpitUIComponentConfigurationModel> getCockpitUIConfigurations()
        Generated method - Getter of the Principal.cockpitUIConfigurations attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the cockpitUIConfigurations

      • getDescription

        @Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription()
        Generated method - Getter of the Principal.description attribute defined at extension core.
        Returns:
        the description

      • getDisplayName

        @Accessor(qualifier="displayName",
          type=GETTER)
public java.lang.String getDisplayName()
        Generated method - Getter of the Principal.displayName dynamic attribute defined at extension core.
        Returns:
        the displayName

      • getDisplayName

        @Accessor(qualifier="displayName",
          type=GETTER)
public java.lang.String getDisplayName​(java.util.Locale loc)
        Generated method - Getter of the Principal.displayName dynamic attribute defined at extension core.
        Parameters:
        loc - the value localization key
        Returns:
        the displayName
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getDN

        @Accessor(qualifier="DN",
          type=GETTER)
public java.lang.String getDN()
        Generated method - Getter of the Principal.DN attribute defined at extension ldap.
        Returns:
        the DN

      • getGroups

        @Accessor(qualifier="groups",
          type=GETTER)
public java.util.Set<PrincipalGroupModel> getGroups()
        Generated method - Getter of the Principal.groups attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the groups

      • getLdapsearchbase

        @Accessor(qualifier="ldapsearchbase",
          type=GETTER)
public java.lang.String getLdapsearchbase()
        Generated method - Getter of the Principal.ldapsearchbase attribute defined at extension ldap.
        Returns:
        the ldapsearchbase - CAUTION: You have to copy the value of the attribute 'LDAPSEARCHBASE' to the attribute 'DN', yourself !!!

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName()
        Generated method - Getter of the Principal.name attribute defined at extension core.
        Returns:
        the name

      • getProfilePicture

        @Accessor(qualifier="profilePicture",
          type=GETTER)
public MediaModel getProfilePicture()
        Generated method - Getter of the Principal.profilePicture attribute defined at extension comments.
        Returns:
        the profilePicture

      • getReadableCatalogVersions

        @Accessor(qualifier="readableCatalogVersions",
          type=GETTER)
public java.util.List<CatalogVersionModel> getReadableCatalogVersions()
        Generated method - Getter of the Principal.readableCatalogVersions attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the readableCatalogVersions

      • getReadableCockpitUIComponents

        @Accessor(qualifier="readableCockpitUIComponents",
          type=GETTER)
public java.util.Collection<CockpitUIComponentAccessRightModel> getReadableCockpitUIComponents()
        Generated method - Getter of the Principal.readableCockpitUIComponents attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the readableCockpitUIComponents

      • getReadCollections

        @Accessor(qualifier="readCollections",
          type=GETTER)
public java.util.Collection<CockpitObjectAbstractCollectionModel> getReadCollections()
        Generated method - Getter of the Principal.readCollections attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the readCollections

      • getReadSavedQueries

        @Accessor(qualifier="readSavedQueries",
          type=GETTER)
public java.util.Collection<CockpitSavedQueryModel> getReadSavedQueries()
        Generated method - Getter of the Principal.readSavedQueries attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the readSavedQueries

      • getSearchrestrictions

        @Deprecated(since="ages",
            forRemoval=true)
public java.util.Collection<SearchRestrictionModel> getSearchrestrictions()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since ages - use { @link #getSearchRestrictions()} instead
        Generated method - Getter of the Principal.searchRestrictions attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the searchRestrictions

      • getSearchRestrictions

        @Accessor(qualifier="searchRestrictions",
          type=GETTER)
public java.util.Collection<SearchRestrictionModel> getSearchRestrictions()
        Generated method - Getter of the Principal.searchRestrictions attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the searchRestrictions

      • getSyncJobs

        @Accessor(qualifier="syncJobs",
          type=GETTER)
public java.util.Collection<SyncItemJobModel> getSyncJobs()
        Generated method - Getter of the Principal.syncJobs attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the syncJobs

      • getUid

        @Accessor(qualifier="uid",
          type=GETTER)
public java.lang.String getUid()
        Generated method - Getter of the Principal.uid attribute defined at extension core.
        Returns:
        the uid

      • getVisibleTemplates

        @Accessor(qualifier="visibleTemplates",
          type=GETTER)
public java.util.Collection<WorkflowTemplateModel> getVisibleTemplates()
        Generated method - Getter of the Principal.visibleTemplates attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the visibleTemplates

      • getWatchedComments

        @Accessor(qualifier="watchedComments",
          type=GETTER)
public java.util.List<CommentModel> getWatchedComments()
        Generated method - Getter of the Principal.watchedComments attribute defined at extension comments. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the watchedComments

      • getWritableCatalogVersions

        @Accessor(qualifier="writableCatalogVersions",
          type=GETTER)
public java.util.List<CatalogVersionModel> getWritableCatalogVersions()
        Generated method - Getter of the Principal.writableCatalogVersions attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the writableCatalogVersions

      • getWritableCockpitUIComponents

        @Accessor(qualifier="writableCockpitUIComponents",
          type=GETTER)
public java.util.Collection<CockpitUIComponentAccessRightModel> getWritableCockpitUIComponents()
        Generated method - Getter of the Principal.writableCockpitUIComponents attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the writableCockpitUIComponents

      • getWriteCollections

        @Accessor(qualifier="writeCollections",
          type=GETTER)
public java.util.Collection<CockpitObjectAbstractCollectionModel> getWriteCollections()
        Generated method - Getter of the Principal.writeCollections attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the writeCollections

      • setBackOfficeLoginDisabled

        @Accessor(qualifier="backOfficeLoginDisabled",
          type=SETTER)
public void setBackOfficeLoginDisabled​(java.lang.Boolean value)
        Generated method - Setter of Principal.backOfficeLoginDisabled attribute defined at extension backoffice.
        Parameters:
        value - the backOfficeLoginDisabled

      • setCN

        @Accessor(qualifier="CN",
          type=SETTER)
public void setCN​(java.lang.String value)
        Generated method - Setter of Principal.CN attribute defined at extension ldap.
        Parameters:
        value - the CN

      • setCockpitUIConfigurations

        @Accessor(qualifier="cockpitUIConfigurations",
          type=SETTER)
public void setCockpitUIConfigurations​(java.util.Collection<CockpitUIComponentConfigurationModel> value)
        Generated method - Setter of Principal.cockpitUIConfigurations attribute defined at extension cockpit.
        Parameters:
        value - the cockpitUIConfigurations

      • setDescription

        @Accessor(qualifier="description",
          type=SETTER)
public void setDescription​(java.lang.String value)
        Generated method - Setter of Principal.description attribute defined at extension core.
        Parameters:
        value - the description

      • setDN

        @Accessor(qualifier="DN",
          type=SETTER)
public void setDN​(java.lang.String value)
        Generated method - Setter of Principal.DN attribute defined at extension ldap.
        Parameters:
        value - the DN

      • setGroups

        @Accessor(qualifier="groups",
          type=SETTER)
public void setGroups​(java.util.Set<PrincipalGroupModel> value)
        Generated method - Setter of Principal.groups attribute defined at extension core.
        Parameters:
        value - the groups

      • setLdapsearchbase

        @Accessor(qualifier="ldapsearchbase",
          type=SETTER)
public void setLdapsearchbase​(java.lang.String value)
        Generated method - Setter of Principal.ldapsearchbase attribute defined at extension ldap.
        Parameters:
        value - the ldapsearchbase - CAUTION: You have to copy the value of the attribute 'LDAPSEARCHBASE' to the attribute 'DN', yourself !!!

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value)
        Generated method - Setter of Principal.name attribute defined at extension core.
        Parameters:
        value - the name

      • setProfilePicture

        @Accessor(qualifier="profilePicture",
          type=SETTER)
public void setProfilePicture​(MediaModel value)
        Generated method - Setter of Principal.profilePicture attribute defined at extension comments.
        Parameters:
        value - the profilePicture

      • setReadableCatalogVersions

        @Accessor(qualifier="readableCatalogVersions",
          type=SETTER)
public void setReadableCatalogVersions​(java.util.List<CatalogVersionModel> value)
        Generated method - Setter of Principal.readableCatalogVersions attribute defined at extension catalog.
        Parameters:
        value - the readableCatalogVersions

      • setReadableCockpitUIComponents

        @Accessor(qualifier="readableCockpitUIComponents",
          type=SETTER)
public void setReadableCockpitUIComponents​(java.util.Collection<CockpitUIComponentAccessRightModel> value)
        Generated method - Setter of Principal.readableCockpitUIComponents attribute defined at extension cockpit.
        Parameters:
        value - the readableCockpitUIComponents

      • setReadSavedQueries

        @Accessor(qualifier="readSavedQueries",
          type=SETTER)
public void setReadSavedQueries​(java.util.Collection<CockpitSavedQueryModel> value)
        Generated method - Setter of Principal.readSavedQueries attribute defined at extension cockpit.
        Parameters:
        value - the readSavedQueries

      • setSyncJobs

        @Accessor(qualifier="syncJobs",
          type=SETTER)
public void setSyncJobs​(java.util.Collection<SyncItemJobModel> value)
        Generated method - Setter of Principal.syncJobs attribute defined at extension catalog.
        Parameters:
        value - the syncJobs

      • setUid

        @Accessor(qualifier="uid",
          type=SETTER)
public void setUid​(java.lang.String value)
        Generated method - Setter of Principal.uid attribute defined at extension core.
        Parameters:
        value - the uid

      • setVisibleTemplates

        @Accessor(qualifier="visibleTemplates",
          type=SETTER)
public void setVisibleTemplates​(java.util.Collection<WorkflowTemplateModel> value)
        Generated method - Setter of Principal.visibleTemplates attribute defined at extension workflow.
        Parameters:
        value - the visibleTemplates

      • setWatchedComments

        @Accessor(qualifier="watchedComments",
          type=SETTER)
public void setWatchedComments​(java.util.List<CommentModel> value)
        Generated method - Setter of Principal.watchedComments attribute defined at extension comments.
        Parameters:
        value - the watchedComments

      • setWritableCatalogVersions

        @Accessor(qualifier="writableCatalogVersions",
          type=SETTER)
public void setWritableCatalogVersions​(java.util.List<CatalogVersionModel> value)
        Generated method - Setter of Principal.writableCatalogVersions attribute defined at extension catalog.
        Parameters:
        value - the writableCatalogVersions

      • setWritableCockpitUIComponents

        @Accessor(qualifier="writableCockpitUIComponents",
          type=SETTER)
public void setWritableCockpitUIComponents​(java.util.Collection<CockpitUIComponentAccessRightModel> value)
        Generated method - Setter of Principal.writableCockpitUIComponents attribute defined at extension cockpit.
        Parameters:
        value - the writableCockpitUIComponents