Overview - Common API - Client API - Admin API - Runtime API
Resource
Resource is an instance that has a type. The type of the resource specifies a set of properites (which themselves have types).
Type information in Composer is used to validate the structure of Resource instances and for serialization.
Resources are used in Composer to represent Assets, Participants, Transactions and other domain classes that can be serialized for long-term persistent storage.
Details
Extends Identifiable
Module common
See also
- See Resource
Method Summary
| Name | Returns | Description |
|---|---|---|
| isResource | boolean |
Determine if this identifiable is a resource |
| toString | String |
Returns the string representation of this class |
Inherited Method Summary
| Supertype | Name | Returns | Description |
|---|---|---|---|
| Typed | getType | string |
Get the type of the instance (a short name, not including namespace) |
| Identifiable | getIdentifier | string |
Get the identifier of this instance |
| Identifiable | getFullyQualifiedIdentifier | string |
Get the fully qualified identifier of this instance |
| Identifiable | isRelationship | boolean |
Determine if this identifiable is a relationship |
| Identifiable | toURI | String |
Returns a URI representation of a reference to this identifiable |
| Identifiable | setIdentifier | void |
Set the identifier of this instance |
| Typed | getFullyQualifiedType | string |
Get the fully-qualified type name of the instance (including namespace) |
| Typed | getNamespace | string |
Get the namespace of the instance |
| Typed | setPropertyValue | void |
Sets a property on this Resource |
| Typed | addArrayValue | void |
Adds a value to an array property on this Resource |
| Typed | instanceOf | boolean |
Check to see if this instance is an instance of the specified fully qualified type name |
Method Details
toString
String toString( )
Returns the string representation of this class
Returns
String - the string representation of the class
See also
Parameters
No parameters
isResource
boolean isResource( )
Determine if this identifiable is a resource.
Returns
boolean - True if this identifiable is a resource, false if not.
See also
Parameters
No parameters
Inherited methods
getIdentifier
string getIdentifier( )
Inherited from: Identifiable
Get the identifier of this instance
Returns
string - The identifier for this object
See also
Parameters
No parameters
setIdentifier
void setIdentifier( string id )
Inherited from: Identifiable
Set the identifier of this instance
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| id | string | Yes | the new identifier for this object |
getFullyQualifiedIdentifier
string getFullyQualifiedIdentifier( )
Inherited from: Identifiable
Get the fully qualified identifier of this instance. (namespace '.' type '#' identifier).
Returns
string - the fully qualified identifier of this instance
See also
Parameters
No parameters
isRelationship
boolean isRelationship( )
Inherited from: Identifiable
Determine if this identifiable is a relationship.
Returns
boolean - True if this identifiable is a relationship, false if not.
See also
Parameters
No parameters
toURI
String toURI( )
Inherited from: Identifiable
Returns a URI representation of a reference to this identifiable
Returns
String - the URI for the identifiable
See also
Parameters
No parameters
getType
string getType( )
Inherited from: Typed
Get the type of the instance (a short name, not including namespace).
Returns
string - The type of this object
See also
Parameters
No parameters
getFullyQualifiedType
string getFullyQualifiedType( )
Inherited from: Typed
Get the fully-qualified type name of the instance (including namespace).
Returns
string - The fully-qualified type name of this object
See also
Parameters
No parameters
getNamespace
string getNamespace( )
Inherited from: Typed
Get the namespace of the instance.
Returns
string - The namespace of this object
See also
Parameters
No parameters
setPropertyValue
void setPropertyValue( string propname, string value )
Inherited from: Typed
Sets a property on this Resource
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| propName | string | Yes | the name of the field |
| value | string | Yes | the value of the property |
addArrayValue
void addArrayValue( string propname, string value )
Inherited from: Typed
Adds a value to an array property on this Resource
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| propName | string | Yes | the name of the field |
| value | string | Yes | the value of the property |
instanceOf
boolean instanceOf( String fqt )
Inherited from: Typed
Check to see if this instance is an instance of the specified fully qualified type name.
Returns
boolean - True if this instance is an instance of the specified fully qualified type name, false otherwise.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| fqt | String | Yes | The fully qualified type name. |