Page tree
Skip to end of metadata
Go to start of metadata

The Resource class is a base class which is the fundamental building block from which all resources in the system are derived.

Methods for Resource object

Name

Return type

Description

equals(Object)

boolean

Determine if the supplied Object is equal to the Resource.

getBillingEntityName()

String

Gets the name of the BillingEntity to which the Resource belongs.

getBillingEntityUUID()

String

Gets the UUID of the BillingEntity to which the Resource belongs.

getConfigurableFieldValue(String)

Object

Gets the value from a configurable field.

getLastModifiedTime()

Long

Gets the time, in milliseconds from epoch, when the resource was last modified.

getProviderValues()

HashMap<String, HashMap>

Gets a map containing the associated config providers configured values for this resource.

getProviderValues(String)

Map<String, String>

Gets the configurable values for the specified config provider

getResourceCreateDate()

Date

Gets the date the Resource was created.

getResourceKey()

ArrayList<ResourceKey>

Gets the keys attached to the Resource.

getResourceMetadata()

ResourceMetadata

Gets the metadata attached to the Resource.

getResourceName()

String

Gets the name of the Resource.

getResourceState()

ResourceState

Gets the current state of the Resource.

getResourceType()

ResourceType

Gets the type of the Resource.

getResourceUUID()

String

Gets the UUID for the Resource.

getSortOrder()

Integer

Gets the sort order value for the resource

setBillingEntityName(String)

void

Sets the name of the BillingEntity to which the Resource belongs.

setBillingEntityUUID(String)

void

Sets the UUID of the BillingEntity to which the Resource belongs.

setConfigurableFieldValue(String, String)

int

Sets the value of a configurable field.

setResourceCreateDate(Date)

void

Sets the date the Resource was created.

setResourceKey(ArrayList<ResourceKey>)

void

Sets the keys attached to the Resource.

setResourceMetadata(ResourceMetadata)

void

Sets the metadata attached to the Resource.

setResourceName(String)

void

Sets the name of the Resource.

setResourceState(ResourceState)

void

Sets the current state of the Resource.

setResourceType(ResourceType)

void

Sets the type of the Resource.

setResourceUUID(String)

void

Sets the UUID for the Resource.

setSortOrder(Integer)

void

Sets the sort order value for the resource

Remarks

The Resource class provides resource naming, state management, metadata, and keys. Note that most virtual objects are derived from VirtualResource.

boolean equals(Object)

Determine if the supplied Object is equal to the Resource.

Input parameters

Name

Type

Description

resource

Object

The other Resource object.

Returned value

Type

Description

boolean

true if the two Resources objects are equal to each other; otherwise, false.

String getBillingEntityName()

Gets the name of the BillingEntity to which the Resource belongs.

Returned value

Type

Description

String

The name of the BillingEntity to which the Resource belongs.

String getBillingEntityUUID()

Gets the UUID of the BillingEntity to which the Resource belongs.

Returned value

Type

Description

String

The UUID of the BillingEntity to which the Resource belongs.

Object getConfigurableFieldValue(String)

Gets the value from a configurable field.

Input parameters

Name

Type

Description

fieldName

String

The name of the configurable field.

Returned value

Type

Description

Object

The value of the configurable field if it is a valid field; otherwise, null.

Long getLastModifiedTime()

Gets the time, in milliseconds from epoch, when the resource was last modified.

Returned value

Type

Description

Long

The time the resource was last modified.

HashMap<String, HashMap> getProviderValues()

Gets a map containing the associated config providers configured values for this resource.

Returned value

Type

Description

HashMap<String, HashMap>

A map containing the associated config providers configured values for this resource.

Map<String, String> getProviderValues(String)

Gets the configurable values for the specified config provider

Input parameters

Name

Type

Description

providerType

String

The config provider type

Returned value

Type

Description

Map<String, String>

The configurable values for the specified config provider

Date getResourceCreateDate()

Gets the date the Resource was created.

Returned value

Type

Description

Date

The date the resource was created.

ArrayList<ResourceKey> getResourceKey()

Gets the keys attached to the Resource.

Returned value

Type

Description

ArrayList<ResourceKey>

The keys attached to the Resource.

ResourceMetadata getResourceMetadata()

Gets the metadata attached to the Resource.

Returned value

Type

Description

ResourceMetadata

The metadata attached to the Resource.

String getResourceName()

Gets the name of the Resource.

Returned value

Type

Description

String

The name of the Resource.

ResourceState getResourceState()

Gets the current state of the Resource.

Returned value

Type

Description

ResourceState

The current state of the resource.

ResourceType getResourceType()

Gets the type of the Resource.

Returned value

Type

Description

ResourceType

The type of the Resource.

String getResourceUUID()

Gets the UUID for the Resource.

Returned value

Type

Description

String

The UUID for the Resource.

Integer getSortOrder()

Gets the sort order value for the resource

Returned value

Type

Description

Integer

The sort order value for the resource

void setBillingEntityName(String)

Sets the name of the BillingEntity to which the Resource belongs.

Input parameters

Name

Type

Description

billingEntityName

String

The name of the BillingEntity to which the Resource belongs.

Returned value

Type

Description

void

This method does not return a value.

void setBillingEntityUUID(String)

Sets the UUID of the BillingEntity to which the Resource belongs.

Input parameters

Name

Type

Description

billingEntityUUID

String

The UUID of the BillingEntity to which the Resource belongs.

Returned value

Type

Description

void

This method does not return a value.

int setConfigurableFieldValue(String, String)

Sets the value of a configurable field.

Input parameters

Name

Type

Description

fieldName

String

The name of the configurable field.

value

String

The new value for the field

Returned value

Type

Description

int

An integer value representing the state of the method. 1 for success, 0 for no such field, -1 for the given value is not valid for the specified field.

void setResourceCreateDate(Date)

Sets the date the Resource was created.

Input parameters

Name

Type

Description

resourceCreateData

Date

The date the resource was created.

Returned value

Type

Description

void

This method does not return a value.

void setResourceKey(ArrayList<ResourceKey>)

Sets the keys attached to the Resource.

Input parameters

Name

Type

Description

resourceKey

ArrayList<ResourceKey>

The keys attached to the Resource.

Returned value

Type

Description

void

This method does not return a value.

void setResourceMetadata(ResourceMetadata)

Sets the metadata attached to the Resource.

Input parameters

Name

Type

Description

resourceMetadata

ResourceMetadata

The metadata attached to the Resource.

Returned value

Type

Description

void

This method does not return a value.

void setResourceName(String)

Sets the name of the Resource.

Input parameters

Name

Type

Description

resourceName

String

The name of the Resource.

Returned value

Type

Description

void

This method does not return a value.

void setResourceState(ResourceState)

Sets the current state of the Resource.

Input parameters

Name

Type

Description

resourceStrare

ResourceState

The new state of the resource.

Returned value

Type

Description

void

This method does not return a value.

void setResourceType(ResourceType)

Sets the type of the Resource.

Input parameters

Name

Type

Description

resourceType

ResourceType

The new type of the Resource.

Returned value

Type

Description

void

This method does not return a value.

void setResourceUUID(String)

Sets the UUID for the Resource.

Input parameters

Name

Type

Description

resourceUUID

String

The new UUID for the Resource.

Returned value

Type

Description

void

This method does not return a value.

void setSortOrder(Integer)

Sets the sort order value for the resource

Input parameters

Name

Type

Description

sortOrder

Integer

The sort order value for the resource

Returned value

Type

Description

void

This method does not return a value.

  • No labels