filenet.vw.api

Class VWParticipant

  • java.lang.Object
    • filenet.vw.api.VWParticipant
  • All Implemented Interfaces:
    IVWtoXML, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

    public final class VWParticipant
extends java.lang.Object
implements java.io.Externalizable, java.lang.Cloneable, IVWtoXML
    Use this class to represent the name of a user or user group in any of the following ways:

    • "Short" (logon) name
    • Distinguished name (DN)
    • Display name (configurable)

    Since:
    VWWS3.10
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor and Description
      VWParticipant()
      Constructs a participant object.
      VWParticipant(java.lang.String theParticipantName)
      Constructs a participant object and sets the participant name property.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Object clone()
      Creates a clone of this VWParticipant object.
      boolean equals(java.lang.Object o) 
      java.lang.String getDisplayName()
      Gets the participant display name.
      java.lang.String getDistinguishedName()
      Gets the distinguished name (DN) of the participant user or group.
      java.lang.String getDomainName()
      Gets the name of the domain associated with the VWParticipant object.
      java.lang.String getGUID()
      Gets the GUID of the participant.
      java.lang.String getParticipantName()
      Returns the "short" or "logon" name of a participant user or group.
      long getUserId()
      Gets the user id associated with the VWParticipant object.
      int hashCode() 
      boolean isGroup()
      Indicates if the current instance of VWParticipant is a group.
      boolean isVerified()
      Return true if this object was initialized using data from the server
      void readExternal(java.io.ObjectInput in) 
      void setParticipantName(java.lang.String theParticipantName)
      Sets the "short" or "logon" name of a participant user or group.
      java.lang.String toString()
      Returns the "short" or "logon" name of a participant user or group.
      void toXML(java.lang.StringBuffer theBuffer)
      Appends an XML string representing this instance to the buffer specified.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.io.Externalizable

        writeExternal

    • Field Detail

      • PARTICIPANT_TYPE_UNDEFINED

        public static final int PARTICIPANT_TYPE_UNDEFINED
        Value of 0; indicates the participant type is undefined.
        See Also:
        Constant Field Values

      • PARTICIPANT_TYPE_USER

        public static final int PARTICIPANT_TYPE_USER
        Value of 1; indicates the participant type is user.
        See Also:
        Constant Field Values

      • PARTICIPANT_TYPE_GROUP

        public static final int PARTICIPANT_TYPE_GROUP
        Value of 2; indicates the participant type is group.
        See Also:
        Constant Field Values

    • Constructor Detail

      • VWParticipant

        public VWParticipant()
        Constructs a participant object.

      • VWParticipant

        public VWParticipant(java.lang.String theParticipantName)
        Constructs a participant object and sets the participant name property.
        Parameters:
        theParticipantName - "Short" or "logon" name of a participant user or group.

    • Method Detail

      • isVerified

        public boolean isVerified()
        Return true if this object was initialized using data from the server
        Returns:
        true if this object was initialized using data from the server

      • clone

        public java.lang.Object clone()
        Creates a clone of this VWParticipant object.
        Overrides:
        clone in class java.lang.Object
        Returns:
        a clone of this instance.

      • getParticipantName

        public java.lang.String getParticipantName()
        Returns the "short" or "logon" name of a participant user or group.
        Returns:
        The "short" or "login" name of the participant user or group
        See Also:
        VWParticipant.setParticipantName(String)

      • setParticipantName

        public void setParticipantName(java.lang.String theParticipantName)
        Sets the "short" or "logon" name of a participant user or group.
        Parameters:
        theParticipantName - The "short" or "login" name of the participant user or group

      • toString

        public java.lang.String toString()
        Returns the "short" or "logon" name of a participant user or group.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The "short" or "login" name of the participant user or group
        See Also:
        VWParticipant.getParticipantName()

      • getDistinguishedName

        public java.lang.String getDistinguishedName()
        Gets the distinguished name (DN) of the participant user or group.
        Returns:
        The distinguished name of the participant user or group

      • getDisplayName

        public java.lang.String getDisplayName()
        Gets the participant display name.
        Returns:
        The display name of the participant user or group

      • getGUID

        public java.lang.String getGUID()
        Gets the GUID of the participant.
        Returns:
        The GUID of the participant

      • getUserId

        public long getUserId()
        Gets the user id associated with the VWParticipant object.
        Returns:
        The user id of the participant associated with the VWParticipant object.

      • getDomainName

        public java.lang.String getDomainName()
        Gets the name of the domain associated with the VWParticipant object.
        Returns:
        The domain name

      • isGroup

        public boolean isGroup()
        Indicates if the current instance of VWParticipant is a group.
        Returns:
        true if the participant is a group

      • toXML

        public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
        Appends an XML string representing this instance to the buffer specified.

        Warning: This XML string is nonextensible, and cannot be modified in any way.

        Specified by:
        toXML in interface IVWtoXML
        Parameters:
        theBuffer - A StringBuffer that will be appended with the XML content.
        Throws:
        VWException - Thrown if the specified buffer is null.
        See Also:
        VWXMLUtil

      • readExternal

        public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException

      • equals

        public boolean equals(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
Skip navigation links
Process API

© Copyright IBM Corporation 2002, 2019. All rights reserved.