|
|
|||||
| Package com.dassault_systemes.PPRNBbase.uid |
Class PortalUID
|
| Class Hierarchy |
java.lang.Object | +-com.dassault_systemes.PPRNBbase.uid.PortalUID
| Class Location |
| Class Description |
public class PortalUID
Class defined to : - create an universal identifier - access to Universal Identifier APIs String format : UID/Adapter/Environment/ID.Type UID is a key word identifying an universal identifier The Universal identifier supports optionnal parameters String format : UID/Adapter/Environment/ID.Type?param1=valur1¶m2=value2 To manipulate these parameters use the following methods : - addParameter - extractParameters - isParameters
| Field Summary |
| Constructor Summary |
| Method Summary |
| public void | addParameter(String iKey, String iValue)
Adds a parameter to the the PortalUID |
| public boolean | equals(Object iUid)
Indicates whether some other object is equal to this one |
| public Hashtable | extractParameters()
Returns all the parameters |
| public String | getAdapter()
Returns the Adapter ID |
| public String | getEnvironment()
Returns the Environment ID |
| public String | getExtension()
If there is an Extension parameter, returns its value. |
| public String | getID()
Returns the ID |
| public static PortalUID | getPortalUID(String iPortalUIDString)
Returns a PortalUID object from its string representation |
| public static PortalUID | getPortalUID(String iAdapter, String iEnvironment, String iId, String iType)
Returns a new PortalUID object from its Adapter, Environment, Id and Type |
| public String | getType()
Returns the Type |
| public int | hashCode()
Returns the hash code value for this object We don't use the parameters to calculate it |
| public boolean | isParameters()
Returns true if the portalUID contains parameters else false |
| public static boolean | isUIDFormat(String iUid)
Returns true if the string value is a Universal ID else false |
| public String | toString()
Returns the string representation of the PortalUID |
| public String | toStringWithoutParameters()
Return the string representation of the PortalUID without the optionals parameters |
| Field Detail |
| Constructor Detail |
| Method Detail |
public void addParameter(String iKey, String iValue)
Adds a parameter to the the PortalUID
iKeyiValue
public boolean equals(Object iUid)
Indicates whether some other object is equal to this one
iUid
public Hashtable extractParameters()
Returns all the parameters
public String getAdapter()
Returns the Adapter ID
public String getEnvironment()
Returns the Environment ID
public String getExtension()
If there is an Extension parameter, returns its value. Otherwise return the type.
public String getID()
Returns the ID
public static PortalUID getPortalUID(String iPortalUIDString)
Returns a PortalUID object from its string representation
iPortalUIDString
public static PortalUID getPortalUID(String iAdapter, String iEnvironment, String iId, String iType)
Returns a new PortalUID object from its Adapter, Environment, Id and Type
iAdapteriEnvironmentiIdiType
public String getType()
Returns the Type
public int hashCode()
Returns the hash code value for this object
We don't use the parameters to calculate it
public boolean isParameters()
Returns true if the portalUID contains parameters else false
public static boolean isUIDFormat(String iUid)
Returns true if the string value is a Universal ID else false
iUid
public String toString()
Returns the string representation of the PortalUID
public String toStringWithoutParameters()
Return the string representation of the PortalUID without the optionals parameters