Skip to main content
Version: latest 1.3.x

API - Resource

The Resource abstract class represents a resource (e.g., person, department, equipment).

Fields

FieldTypeDescription
idStringUnique identifier
locationNameStringResource location
typeNameStringResource type name
roleNameStringAssigned role name
attributesList<Attribute>Associated attributes
attributeGroupsList<AttributeGroup>Attribute groups

Header attributes

/**
* @return the technical UUID of the resource
*/
String getId();

/**
* @return the name of the location the resource is assigned to.
* If the resource is not assigned to a location than null is returned.
*/
String getLocationName();

/**
* @return the name (former Manual ID) of the resource type
*/
String getTypeName();

/**
* @return the name of the role assigned to the resource.
* If the resource is not assigned to a role than null is returned.
*/
String getRoleName();

/**
*
* @param locationName the name of the location (former manual id) to assign the resource to.
* @throws DataAccessException
*/
void setLocation(String locationName) throws DataAccessException;

Dynamic attributes

See also Attributes and AttributeGroups.

/**
* @return the list of attributes associated with the resource
*/
List<Attribute> getAttributes();

/**
*
* @return the list of attribute groups associated with the resource
*/
List<AttributeGroup> getAttributeGroups();