|
|
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 |
boolean | isUIDFormat(String iUid) |
PortalUID | getPortalUID(String iAdapter, String iEnvironment, String iId, String iType) |
PortalUID | getPortalUID(String iPortalUIDString) |
void | addParameter(String iKey, String iValue) |
Hashtable | extractParameters() |
String | getAdapter() |
String | getEnvironment() |
String | getID() |
String | getType() |
String | getExtension() |
boolean | isParameters() |
int | hashCode() |
boolean | equals(Object iUid) |
String | toString() |
String | toStringWithoutParameters() |
Field Detail |
Constructor Detail |
Method Detail |
boolean isUIDFormat(String iUid)Returns true if the string value is a Universal ID else false
iUid
PortalUID getPortalUID(String iAdapter, String iEnvironment, String iId, String iType)Returns a new PortalUID object from its Adapter, Environment, Id and Type
iAdapter
iEnvironment
iId
iType
PortalUID getPortalUID(String iPortalUIDString)Returns a PortalUID object from its string representation
iPortalUIDString
void addParameter(String iKey, String iValue)Adds a parameter to the the PortalUID
iKey
iValue
Hashtable extractParameters()Returns all the parameters
String getAdapter()Returns the Adapter ID
String getEnvironment()Returns the Environment ID
String getID()Returns the ID
String getType()Returns the Type
String getExtension()If there is an Extension parameter, returns its value. Otherwise return the type.
boolean isParameters()Returns true if the portalUID contains parameters else false
int hashCode()Returns the hash code value for this object We don't use the parameters to calculate it
boolean equals(Object iUid)Indicates whether some other object is equal to this one
iUid
String toString()Returns the string representation of the PortalUID
String toStringWithoutParameters()Return the string representation of the PortalUID without the optionals parameters