com.vmware.vise.data.query

Interface ObjectReferenceService

All Known Subinterfaces:

VimObjectReferenceService

public interface ObjectReferenceService

Collection of methods that provide : - mappings between reference and UID. - fragments of the reference.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getReference(java.lang.String uid) Retuns a reference for the given uid.
java.lang.Object	getReference(java.lang.String uid, boolean decoded) Retuns a reference for the given uid.
java.lang.String	getResourceObjectType(java.lang.Object reference) Returns the type for the given reference.
java.lang.String	getServerGuid(java.lang.Object reference) Returns GUID of the server that owns the given reference.
java.lang.String	getUid(java.lang.Object reference) Returns a uid for the given reference.
java.lang.String	getUid(java.lang.Object reference, boolean encode) Returns a uid for the given reference.

Method Detail

getResourceObjectType

java.lang.String getResourceObjectType(java.lang.Object reference)

Returns the type for the given reference.

Parameters:

reference - The reference object.

Returns:

The reference type. A null return value may indicate that no ObjectRefAdapter could be found for the reference, or that the reference was not supported by its ObjectRefAdapter.

Throws:

java.lang.IllegalArgumentException - If the reference reference is null.

getServerGuid

java.lang.String getServerGuid(java.lang.Object reference)

Returns GUID of the server that owns the given reference.

Parameters:

reference - The reference object.

Returns:

The Guid of the server that owns the given reference object. A null return value may indicate that no ObjectRefAdapter could be found for the reference, or that the reference was not supported by its ObjectRefAdapter.

Throws:

java.lang.IllegalArgumentException - If the reference reference is null.

getUid

java.lang.String getUid(java.lang.Object reference)

Returns a uid for the given reference.

Parameters:

reference - The reference object.

Returns:

The reference uid. A null return value may indicate that no ObjectRefAdapter could be found for the reference, or that the reference was not supported by its ObjectRefAdapter.

Throws:

java.lang.IllegalArgumentException - If the reference reference is null.

getReference

java.lang.Object getReference(java.lang.String uid)

Retuns a reference for the given uid.

Parameters:

uid - The uid.

Returns:

The entity reference. A null return value may indicate that no ObjectRefAdapter could be found for the uid, or that the uid was not supported by its ObjectRefAdapter.

Throws:

java.lang.IllegalArgumentException - if the uid is null.

getUid

java.lang.String getUid(java.lang.Object reference,
                        boolean encode)

Returns a uid for the given reference. The uid will be encoded if the flag is set to be true.

Parameters:

reference - The reference object.

encoded - True if we want to encode the uid.

Returns:

The reference uid. A null return value may indicate that no ObjectRefAdapter could be found for the reference, or that the reference was not supported by its ObjectRefAdapter.

Throws:

java.lang.IllegalArgumentException - If the reference reference is null.

getReference

java.lang.Object getReference(java.lang.String uid,
                              boolean decoded)

Retuns a reference for the given uid. The uid will be decoded if the flag is set to be true.

Parameters:

uid - The uid.

decoded - True if we want to decode the uid.

Returns:

The entity reference. A null return value may indicate that no ObjectRefAdapter could be found for the uid, or that the uid was not supported by its ObjectRefAdapter.

Throws:

java.lang.IllegalArgumentException - if the uid is null.