Oracle® Collaboration Suite Workspaces API Reference
10g (10.1.1.0.2)

Part No. B16233-01


oracle.workspaces
Class CwUid

java.lang.Object
  extended byoracle.workspaces.CwUid

All Implemented Interfaces:
java.io.Serializable

public class CwUid
extends java.lang.Object
implements java.io.Serializable

This class represents the unique identifier of an object. Depending upon the object it represents, the string representation of a CwUid can have one of the following forms:

Since:
release specific (what release of product did this appear in)
See Also:
Serialized Form

Field Summary
static java.lang.String COMPONENT_SEPARATOR
static int OBJECT_TYPE_ALL
static int OBJECT_TYPE_RESOURCE
static int OBJECT_TYPE_RESOURCE_ITEM
static int OBJECT_TYPE_WORKSPACE

Constructor Summary
CwUid(java.lang.String workspaceId)
Constructor for creating a new UID for a workspace.
CwUid(java.lang.String workspaceId, CwResourceItemType resourceItemType, java.lang.String resourceId, java.lang.String resourceItemId)
Constructor for creating a new UID for a resource item.
CwUid(java.lang.String workspaceId, CwResourceType resourceType, java.lang.String resourceId)
Constructor for creating a new UID for a resource.

Method Summary
boolean equals(java.lang.Object obj)
Equals determines if two objects have the same UID.
CwEntityType getEntityType()
Get the entity type
static java.lang.String getIdFromResourceTypeIdString(java.lang.String string)
Get the id from resource type id
java.lang.String getItemId()
Returns the resource item ID.
int getObjectType()
Get the object type
java.lang.String getResourceId()
Returns the resource Id as a string
CwUid getResourceUid()
Returns the resource Id as a CwUid instance.
static CwResourceType getTypeFromResourceTypeIdString(java.lang.String string)
Get the CwResourceType instance from resource type id
java.lang.String getWorkspaceId()
Returns the workspace Id as a string.
CwUid getWorkspaceUid()
Returns the workspace Id as CwUid instance.
int hashCode()
Get the hash code
static CwUid parseStringToUid(java.lang.String string)
Converts the string representation of a UID to an actual UID.
static java.lang.String toResourceTypeIdString(CwResourceType rsrcType, java.lang.String resourceId)
A helper to return the string representation of the resource type - resource id pair.
java.lang.String toString()
Stringifies the uid.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail

COMPONENT_SEPARATOR

public static final java.lang.String COMPONENT_SEPARATOR
See Also:
Constant Field Values

OBJECT_TYPE_ALL

public static final int OBJECT_TYPE_ALL
See Also:
Constant Field Values

OBJECT_TYPE_RESOURCE

public static final int OBJECT_TYPE_RESOURCE
See Also:
Constant Field Values

OBJECT_TYPE_RESOURCE_ITEM

public static final int OBJECT_TYPE_RESOURCE_ITEM
See Also:
Constant Field Values

OBJECT_TYPE_WORKSPACE

public static final int OBJECT_TYPE_WORKSPACE
See Also:
Constant Field Values

Constructor Detail

CwUid

public CwUid(java.lang.String workspaceId)
      throws CwException
Constructor for creating a new UID for a workspace.

CwUid

public CwUid(java.lang.String workspaceId,
             CwResourceItemType resourceItemType,
             java.lang.String resourceId,
             java.lang.String resourceItemId)
      throws CwException
Constructor for creating a new UID for a resource item.

CwUid

public CwUid(java.lang.String workspaceId,
             CwResourceType resourceType,
             java.lang.String resourceId)
      throws CwException
Constructor for creating a new UID for a resource.

Method Detail

equals

public boolean equals(java.lang.Object obj)
Equals determines if two objects have the same UID.
Parameters:
obj - the other CwUid to compare to

getEntityType

public CwEntityType getEntityType()
Get the entity type

getIdFromResourceTypeIdString

public static java.lang.String getIdFromResourceTypeIdString(java.lang.String string)
                                                      throws CwException
Get the id from resource type id
Throws:
CwException

getItemId

public java.lang.String getItemId()
Returns the resource item ID.

getObjectType

public int getObjectType()
Get the object type

getResourceId

public java.lang.String getResourceId()
Returns the resource Id as a string

getResourceUid

public CwUid getResourceUid()
                     throws CwException
Returns the resource Id as a CwUid instance.
Throws:
CwException

getTypeFromResourceTypeIdString

public static CwResourceType getTypeFromResourceTypeIdString(java.lang.String string)
                                                      throws CwException
Get the CwResourceType instance from resource type id
Throws:
CwException

getWorkspaceId

public java.lang.String getWorkspaceId()
Returns the workspace Id as a string.

getWorkspaceUid

public CwUid getWorkspaceUid()
                      throws CwException
Returns the workspace Id as CwUid instance.
Throws:
CwException

hashCode

public int hashCode()
Get the hash code

parseStringToUid

public static CwUid parseStringToUid(java.lang.String string)
                              throws CwException
Converts the string representation of a UID to an actual UID.
Throws:
CwException

toResourceTypeIdString

public static java.lang.String toResourceTypeIdString(CwResourceType rsrcType,
                                                      java.lang.String resourceId)
A helper to return the string representation of the resource type - resource id pair.

toString

public java.lang.String toString()
Stringifies the uid.

Copyright © 2001, 2005, Oracle. All rights reserved.