com.ibm.as400.access

Class DirectoryEntry



  • public class DirectoryEntry
    extends Object
    The DirectoryEntry class represents system distribution directory information for a particular directory entry. Use the DirectoryEntryList.getEntries() method to obtain a DirectoryEntry object.

    For more information on the system distribution directory and its entries, see the WRKDIRE, ADDDIRE, and RMVDIRE OS/400 CL commands.

    See Also:
    DirectoryEntryList, User

    • Method Detail

      • getAdministrationDomain

        public String getAdministrationDomain()
        Returns the administration domain.
        Returns:
        The administration domain.
      • getBuilding

        public String getBuilding()
        Returns the building.
        Returns:
        The building.
      • getCCMailAddress

        public String getCCMailAddress()
        Returns the cc:Mail address.
        Returns:
        The address.
      • getCCMailComment

        public String getCCMailComment()
        Returns the cc:Mail comment.
        Returns:
        The comment.
      • getCompany

        public String getCompany()
        Returns the company.
        Returns:
        The company.
      • getCountry

        public String getCountry()
        Returns the country or region.
        Returns:
        The country or region code.
      • getDepartment

        public String getDepartment()
        Returns the department.
        Returns:
        The department.
      • getDLOOwner

        public String getDLOOwner()
        Returns which profile will be assigned ownership of the document library objects (DLOs) for this directory entry. Valid values are:
        • *USRPRF - The user profile.
        • *GRPPRF - The group profile.
        Returns:
        The DLO owner.
      • getDomainDefinedAttributeType1

        public String getDomainDefinedAttributeType1()
        Returns the type of domain-defined attribute 1.
        Returns:
        The type.
      • getDomainDefinedAttributeType2

        public String getDomainDefinedAttributeType2()
        Returns the type of domain-defined attribute 2.
        Returns:
        The type.
      • getDomainDefinedAttributeType3

        public String getDomainDefinedAttributeType3()
        Returns the type of domain-defined attribute 3.
        Returns:
        The type.
      • getDomainDefinedAttributeType4

        public String getDomainDefinedAttributeType4()
        Returns the type of domain-defined attribute 4.
        Returns:
        The type.
      • getDomainDefinedAttributeValue1

        public String getDomainDefinedAttributeValue1()
        Returns the value of domain-defined attribute 1.
        Returns:
        The value.
      • getDomainDefinedAttributeValue2

        public String getDomainDefinedAttributeValue2()
        Returns the value of domain-defined attribute 2.
        Returns:
        The value.
      • getDomainDefinedAttributeValue3

        public String getDomainDefinedAttributeValue3()
        Returns the value of domain-defined attribute 3.
        Returns:
        The value.
      • getDomainDefinedAttributeValue4

        public String getDomainDefinedAttributeValue4()
        Returns the value of domain-defined attribute 4.
        Returns:
        The value.
      • getFaxNumber

        public String getFaxNumber()
        Returns the fax telephone number.
        Returns:
        The fax telephone number.
      • getFirstName

        public String getFirstName()
        Returns the first name.
        Returns:
        The first name.
      • getFullName

        public String getFullName()
        Returns the full name.
        Returns:
        The full name.
      • getGenerationQualifier

        public String getGenerationQualifier()
        Returns the generation qualifier.
        Returns:
        The generation qualifier.
      • getGivenName

        public String getGivenName()
        Returns the given name.
        Returns:
        The given name.
      • getInitials

        public String getInitials()
        Returns the initials.
        Returns:
        The initials.
      • getJobTitle

        public String getJobTitle()
        Returns the job title.
        Returns:
        The job title.
      • getLastName

        public String getLastName()
        Returns the last name.
        Returns:
        The last name.
      • getLocation

        public String getLocation()
        Returns the location.
        Returns:
        The location.
      • getMailingAddress1

        public String getMailingAddress1()
        Returns line 1 of the mailing address.
        Returns:
        The mailing address.
      • getMailingAddress2

        public String getMailingAddress2()
        Returns line 2 of the mailing address.
        Returns:
        The mailing address.
      • getMailingAddress3

        public String getMailingAddress3()
        Returns line 3 of the mailing address.
        Returns:
        The mailing address.
      • getMailingAddress4

        public String getMailingAddress4()
        Returns line 4 of the mailing address.
        Returns:
        The mailing address.
      • getMailServiceLevel

        public String getMailServiceLevel()
        Returns the value of the mail service level field and product ID. This value is blank when the mail service name is one of the special values: *USRIDX, *SYSMS, or *DOMINO; or the mail service level field does not exist in the directory entry; or the mail service level field in the directory entry is blank.
        Returns:
        The mail service level.
        See Also:
        getMailServiceName()
      • getMailServiceName

        public String getMailServiceName()
        Returns the field name portion of the mail server framework service level. Special values include:
        • *USRIDX - User index.
        • *SYSMS - System message store.
        • *DOMINO - Lotus Domino mail database.
        Returns:
        The mail service name.
      • getMailServiceProductID

        public String getMailServiceProductID()
        Returns the product ID portion of the mail server framework service level. Special values include *NONE, which indicates that there is no product ID.
        Returns:
        The mail service product ID.
      • getMiddleName

        public String getMiddleName()
        Returns the middle name.
        Returns:
        The middle name.
      • getNetworkUserID

        public String getNetworkUserID()
        Returns the network user ID.
        Returns:
        The network user ID.
      • getOffice

        public String getOffice()
        Returns the office.
        Returns:
        The office.
      • getOrganization

        public String getOrganization()
        Returns the organization.
        Returns:
        The organization.
      • getOrganizationUnit1

        public String getOrganizationUnit1()
        Returns organization unit 1.
        Returns:
        The organization unit.
      • getOrganizationUnit2

        public String getOrganizationUnit2()
        Returns organization unit 1.
        Returns:
        The organization unit.
      • getOrganizationUnit3

        public String getOrganizationUnit3()
        Returns organization unit 1.
        Returns:
        The organization unit.
      • getOrganizationUnit4

        public String getOrganizationUnit4()
        Returns organization unit 1.
        Returns:
        The organization unit.
      • getORName

        public String getORName()
        Returns the paper representation of the X.400 O/R name, if one exists.
        Returns:
        The X.400 O/R name.
      • getPreferredAddressName

        public String getPreferredAddressName()
        Returns the field name portion of the preferred address. The field name can be a special value, user-defined field name, or an IBM-defined field name. Special values include:
        • *USRID - User ID/address.
        • *ORNAME - X.400 O/R name.
        • *SMTP - SMTP name.
        Returns:
        The preferred address name.
      • getPreferredAddressProductID

        public String getPreferredAddressProductID()
        Returns the product ID portion of the preferred address. Special values include:
        • *IBM - Indicates an IBM-defined field name.
        • *NONE - Indicates that there is no product ID.
        Returns:
        The product ID.
      • getPreferredAddressTypeName

        public String getPreferredAddressTypeName()
        Returns the address type name of the preferred address.
        Returns:
        The name of the preferred address type.
      • getPreferredAddressTypeValue

        public String getPreferredAddressTypeValue()
        Returns the address type value of the preferred address.
        Returns:
        The value of the preferred address type.
      • getPreferredAddressValue

        public String getPreferredAddressValue()
        Returns the value of the preferred address field and product ID. This format of this String is dependent upon the preferred address name:
        • When the name is *USRID, the value consists of an 8-character user ID, 8-character user address, 8-character system name, and 8-character system group.
        • When the name is *ORNAME, the value consists of an X.400 O/R name formatted based on those fields that exist for this user, up to 909 characters.
        • When the name is *SMTP, the value consists of a 24-character STMP user ID and a 256-character SMTP domain or route, followed by an optional 64-character SMTP user ID (if the SMTP names are converted using the CVTNAMSMTP command).
        • When the name is an IBM-defined or user-defined field, the value consists of the field in the system distribution directory, with a maximum size of 512 characters.
        Returns:
        The value of the preferred address.
        See Also:
        getPreferredAddressName()
      • getPreferredName

        public String getPreferredName()
        Returns the preferred name.
        Returns:
        The preferred name.
      • getPrivateManagementDomain

        public String getPrivateManagementDomain()
        Returns the private management domain.
        Returns:
        The private management domain.
      • getSMTPDomain

        public String getSMTPDomain()
        Returns the SMTP domain, if one exists. Either the SMTP domain or route can exist, not both.
        Returns:
        The SMTP domain.
        See Also:
        getSMTPRoute()
      • getSMTPRoute

        public String getSMTPRoute()
        Returns the SMTP route, if one exists. Either the SMTP domain or route can exist, not both.
        Returns:
        The SMTP route.
        See Also:
        getSMTPDomain()
      • getSMTPUserID

        public String getSMTPUserID()
        Returns the SMTP user ID, if one exists.
        Returns:
        The SMTP user ID.
      • getSurname

        public String getSurname()
        Returns the surname.
        Returns:
        The surname.
      • getSystem

        public AS400 getSystem()
        Returns the system.
        Returns:
        The system.
      • getSystemGroup

        public String getSystemGroup()
        Returns the system group of this directory entry.
        Returns:
        The system group.
      • getSystemName

        public String getSystemName()
        Returns the system name of this directory entry.
        Returns:
        The system name.
      • getTelephoneNumber1

        public String getTelephoneNumber1()
        Returns the first telephone number.
        Returns:
        The telephone number.
      • getTelephoneNumber2

        public String getTelephoneNumber2()
        Returns the second telephone number.
        Returns:
        The telephone number.
      • getText

        public String getText()
        Returns the text for this directory entry. This is not the same as the user description.
        Returns:
        The text.
      • getUserAddress

        public String getUserAddress()
        Returns the address of this directory entry.
        Returns:
        The address.
      • getUserDescription

        public String getUserDescription()
        Returns the user description field for this directory entry.
        Returns:
        The description.
      • getUserID

        public String getUserID()
        Returns the user ID of this directory entry. This is not the same as the associated user profile.
        Returns:
        The user ID (which has a maximum length of 8 characters).
        See Also:
        getUserProfile()
      • getUserProfile

        public String getUserProfile()
        Returns the user profile name associated with this entry. This is not the same as the entry's user ID.
        Returns:
        The user profile (which has a maximum length of 10 characters).
        See Also:
        getUserID()
      • isIndirectUser

        public boolean isIndirectUser()
        Indicates if this entry represents an indirect user. This only applies to local directory entries.
        Returns:
        true if the user is an indirect user; false otherwise.
        See Also:
        isLocal()
      • isLocal

        public boolean isLocal()
        Indicates if this entry is a local entry.
        Returns:
        true if this is a local entry; false if it is a shadowed entry.
      • isManager

        public boolean isManager()
        Indicates if this entry represents a manager.
        Returns:
        true if the user is a manager; false otherwise.
      • isMessageMailNotification

        public boolean isMessageMailNotification()
        Indicates a type of mail notification used for this entry.
        Returns:
        true if notification of messages is enabled for this entry; false otherwise.
        See Also:
        getMailNotification(), isPriorityMailNotification()
      • isPrintCoverPage

        public boolean isPrintCoverPage()
        Indicates if the cover page is to be printed. This only applies to local directory entries.
        Returns:
        true if the cover page is to be printed; false otherwise.
        See Also:
        isLocal()
      • isPriorityMailNotification

        public boolean isPriorityMailNotification()
        Indicates a type of mail notification used for this entry.
        Returns:
        true if notification of priority, private, and important mail is enabled for this entry; false otherwise.
        See Also:
        getMailNotification(), isMessageMailNotification()
      • isSynchronized

        public boolean isSynchronized()
        Indicates whether this entry should be synchronized with directories other than the System Distribution Directory.
        Returns:
        true if synchronization is allowed; false otherwise.