Package org.sakaiproject.api.common.edu.person

Interface EduPerson

    • Method Detail

      • getAffiliation

        String getAffiliation()
        Specifies the person's relationship(s) to the institution in broad categories such as student, faculty, staff, alum, etc. (See controlled vocabulary). Permissible values (if controlled) faculty, student, staff, alum, member, affiliate, employee.
        Returns:

      • setAffiliation

        void setAffiliation​(String affiliation)
        Specifies the person's relationship(s) to the institution in broad categories such as student, faculty, staff, alum, etc. (See controlled vocabulary). Permissible values (if controlled) faculty, student, staff, alum, member, affiliate, employee.

      • getEntitlement

        String getEntitlement()
        URI (either URN or URL) that indicates a set of rights to specific resources.
        Returns:

      • setEntitlement

        void setEntitlement​(String entitlement)
        URI (either URN or URL) that indicates a set of rights to specific resources.

      • getNickname

        String getNickname()
        Person's nickname, or the informal name by which they are accustomed to be hailed.
        Returns:

      • setNickname

        void setNickname​(String nickname)
        Person's nickname, or the informal name by which they are accustomed to be hailed.

      • getOrgDn

        String getOrgDn()
        The distinguished name (DN) of the of the directory entry representing the institution with which the person is associated.
        Returns:

      • setOrgDn

        void setOrgDn​(String orgDn)
        The distinguished name (DN) of the of the directory entry representing the institution with which the person is associated.

      • getOrgUnitDn

        String getOrgUnitDn()
        The distinguished name(s) (DN) of the directory entries representing the person's Organizational Unit(s). May be multivalued, as for example, in the case of a faculty member with appointments in multiple departments or a person who is a student in one department and an employee in another.
        Returns:

      • setOrgUnitDn

        void setOrgUnitDn​(String orgUnitDn)
        The distinguished name(s) (DN) of the directory entries representing the person's Organizational Unit(s). May be multivalued, as for example, in the case of a faculty member with appointments in multiple departments or a person who is a student in one department and an employee in another.

      • getPrimaryAffiliation

        String getPrimaryAffiliation()
        Specifies the person's PRIMARY relationship to the institution in broad categories such as student, faculty, staff, alum, etc. (See controlled vocabulary). Permissible values (if controlled) faculty, student, staff, alum, member, affiliate, employee.
        Returns:

      • setPrimaryAffiliation

        void setPrimaryAffiliation​(String primaryAffiliation)
        Specifies the person's PRIMARY relationship to the institution in broad categories such as student, faculty, staff, alum, etc. (See controlled vocabulary). Permissible values (if controlled) faculty, student, staff, alum, member, affiliate, employee.

      • getPrimaryOrgUnitDn

        String getPrimaryOrgUnitDn()
        The distinguished name (DN) of the directory entry representing the person's primary Organizational Unit(s).
        Returns:

      • setPrimaryOrgUnitDn

        void setPrimaryOrgUnitDn​(String primaryOrgUnitDn)
        The distinguished name (DN) of the directory entry representing the person's primary Organizational Unit(s).

      • getPrincipalName

        String getPrincipalName()
        The "NetID" of the person for the purposes of inter-institutional authentication. Should be stored in the form of user_at_univ.edu, where univ.edu is the name of the local security domain.
        Returns:

      • setPrincipalName

        void setPrincipalName​(String principalName)
        The "NetID" of the person for the purposes of inter-institutional authentication. Should be stored in the form of user_at_univ.edu, where univ.edu is the name of the local security domain.

      • getPrincipalNamePrior

        String getPrincipalNamePrior()
        Each value of this multi-valued attribute represents an ePPN (eduPersonPrincipalName) value that was previously associated with the entry. The values MUST NOT include the currently valid ePPN value. There is no implied or assumed order to the values. This attribute MUST NOT be populated if ePPN values are ever reassigned to a different entry (after, for example, a period of dormancy). That is, they MUST be unique in space and over time.
        Returns:

      • setPrincipalNamePrior

        void setPrincipalNamePrior​(String principalNamePrior)
        Each value of this multi-valued attribute represents an ePPN (eduPersonPrincipalName) value that was previously associated with the entry. The values MUST NOT include the currently valid ePPN value. There is no implied or assumed order to the values. This attribute MUST NOT be populated if ePPN values are ever reassigned to a different entry (after, for example, a period of dormancy). That is, they MUST be unique in space and over time.
        Parameters:
        PrincipalNamePrior -

      • getScopedAffiliation

        String getScopedAffiliation()
        Specifies the person's affiliation within a particular security domain in broad categories such as student, faculty, staff, alum, etc. The values consist of a left and right component separated by an "@" sign. The left component is one of the values from the eduPersonAffiliation controlled vocabulary. This right-hand side syntax of eduPersonScopedAffiliation intentionally matches that used for the right-hand side values for eduPersonPrincipalName. The "scope" portion MUST be the administrative domain to which the affiliation applies. Multiple "@" signs are not recommended, but in any case, the first occurrence of the "@" sign starting from the left is to be taken as the delimiter between components. Thus, user identifier is to the left, security domain to the right of the first "@". This parsing rule conforms to the POSIX "greedy" disambiguation method in regular expression processing.
        Returns:

      • setScopedAffiliation

        void setScopedAffiliation​(String scopedAffiliation)
        Specifies the person's affiliation within a particular security domain in broad categories such as student, faculty, staff, alum, etc. The values consist of a left and right component separated by an "@" sign. The left component is one of the values from the eduPersonAffiliation controlled vocabulary. This right-hand side syntax of eduPersonScopedAffiliation intentionally matches that used for the right-hand side values for eduPersonPrincipalName. The "scope" portion MUST be the administrative domain to which the affiliation applies. Multiple "@" signs are not recommended, but in any case, the first occurrence of the "@" sign starting from the left is to be taken as the delimiter between components. Thus, user identifier is to the left, security domain to the right of the first "@". This parsing rule conforms to the POSIX "greedy" disambiguation method in regular expression processing. * @param scopedAffiliation

      • getTargetedID

        String getTargetedID()
        A persistent, non-reassigned, opaque identifier for a principal.
        Returns:

      • setTargetedID

        void setTargetedID​(String targetedID)
        A persistent, non-reassigned, opaque identifier for a principal.
        Parameters:
        targetedID -

      • getAssurance

        String getAssurance()
        Set of URIs that assert compliance with specific standards for identity assurance.
        Returns:

      • setAssurance

        void setAssurance​(String assurance)
        Set of URIs that assert compliance with specific standards for identity assurance.
        Parameters:
        assurance -

      • getUniqueId

        String getUniqueId()
        * A long-lived, non re-assignable, omnidirectional identifier suitable for use as a principal identifier by authentication providers or as a unique external key by applications.
        Returns:

      • setUniqueId

        void setUniqueId​(String uniqueId)
        A long-lived, non re-assignable, omnidirectional identifier suitable for use as a principal identifier by authentication providers or as a unique external key by applications.
        Parameters:
        uniqueId -

      • getOrcid

        String getOrcid()
        Returns:

      • setOrcid

        void setOrcid​(String orcid)
        Parameters:
        orcid -