net.bluemind.resource.api

Interface IResources

All Known Implementing Classes:

ResourcesService

@Path(value="/resources/{domainUid}")
public interface IResources

Resources API. Resources are used, for example, to create an entity like a vehicle, a meeting room, a video-projector, etc. They can be categorized by type. Once created, you can invite a resource to a calendar event. It simply means the resource is booked during the time of the event. Resource are part of a domain (and only one).

Method Summary

Modifier and Type	Method and Description
java.lang.String	addToEventDescription(java.lang.String resourceUid, EventInfo eventInfo) Compute the transformed template associated to the given resource if any, then append it to the given eventDescription.
ItemValue<ResourceDescriptor>	byEmail(java.lang.String email) Fetch an existing ResourceDescriptor by its email.
java.util.List<java.lang.String>	byType(java.lang.String typeUid) List all ResourceDescriptor by type.
void	create(java.lang.String uid, ResourceDescriptor resourceDescriptor) Creates a ResourceDescriptor.
void	createWithItem(ItemValue<ResourceDescriptor> resourceDescriptorItem) Creates a ResourceDescriptor.
TaskRef	delete(java.lang.String uid) Delete an existing ResourceDescriptor.
ResourceDescriptor	get(java.lang.String uid) Fetch an existing ResourceDescriptor by its unique id.
byte[]	getIcon(java.lang.String uid) Fetch a ResourceDescriptor icon.
java.lang.String	removeFromEventDescription(java.lang.String resourceUid, EventInfo eventInfo) Remove the transformed template associated to the given resource from the given eventDescription.
void	setIcon(java.lang.String uid, byte[] icon) Set a ResourceDescriptor icon.
void	update(java.lang.String uid, ResourceDescriptor resourceDescriptor) Modify an existing ResourceDescriptor.
void	updateWithItem(ItemValue<ResourceDescriptor> resourceDescriptorItem) Modify an existing ResourceDescriptor.

Method Detail

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       ResourceDescriptor resourceDescriptor)
                                throws ServerFault

Creates a ResourceDescriptor.

Parameters:

uid - { @link ResourceDescriptor } unique id

resourceDescriptor - { ResourceDescriptor

Throws:

ServerFault - standard error object

createWithItem

@PUT
 @Path(value="_createWithItem")
void createWithItem(ItemValue<ResourceDescriptor> resourceDescriptorItem)
                                                  throws ServerFault

Creates a ResourceDescriptor.

Parameters:

resourceDescriptorItem - { ItemValue

Throws:

ServerFault - standard error object

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        ResourceDescriptor resourceDescriptor)
                                 throws ServerFault

Modify an existing ResourceDescriptor.

Parameters:

uid - { @link ResourceDescriptor } unique id

resourceDescriptor - updated { ResourceDescriptor

Throws:

ServerFault - standard error object

updateWithItem

@POST
 @Path(value="_updateWithItem")
void updateWithItem(ItemValue<ResourceDescriptor> resourceDescriptorItem)
                                                   throws ServerFault

Modify an existing ResourceDescriptor.

Parameters:

resourceDescriptorItem - updated { ResourceDescriptor

Throws:

ServerFault - standard error object

delete

@DELETE
 @Path(value="{uid}")
TaskRef delete(@PathParam(value="uid")
                                             java.lang.String uid)
                                      throws ServerFault

Delete an existing ResourceDescriptor.

Parameters:

uid - { @link ResourceDescriptor } unique id

Throws:

ServerFault - standard error object

get

@GET
 @Path(value="{uid}")
ResourceDescriptor get(@PathParam(value="uid")
                                                  java.lang.String uid)
                                           throws ServerFault

Fetch an existing ResourceDescriptor by its unique id.

Parameters:

uid - { @link ResourceDescriptor } unique id

Returns:

ResourceDescriptor, or null if the ResourceDescriptor does not exist

Throws:

ServerFault - standard error object

getIcon

@GET
 @Path(value="{uid}/icon")
 @Produces(value="image/png")
byte[] getIcon(@PathParam(value="uid")
                                                                             java.lang.String uid)
                                                                      throws ServerFault

Fetch a ResourceDescriptor icon.

Parameters:

uid - { @link ResourceDescriptor } unique id

Returns:

icon binary data (png format) or null if the ResourceDescriptor does not exist

Throws:

ServerFault - standard error object

setIcon

@POST
 @Path(value="{uid}/icon")
 @Consumes(value="image/png")
void setIcon(@PathParam(value="uid")
                                                                            java.lang.String uid,
                                                                            byte[] icon)
                                                                     throws ServerFault

Set a ResourceDescriptor icon.

Parameters:

uid - { @link ResourceDescriptor } unique id

icon - icon binary data (png format)

Throws:

ServerFault - standard error object

byEmail

@GET
 @Path(value="byEmail/{email}")
ItemValue<ResourceDescriptor> byEmail(@PathParam(value="email")
                                                                           java.lang.String email)
                                                                    throws ServerFault

Fetch an existing ResourceDescriptor by its email.

Parameters:

email - { @link ResourceDescriptor } email

Returns:

ResourceDescriptor net.bluemind.core.container.api.ItemValue, or null if the ResourceDescriptor does not exist

Throws:

ServerFault - standard error object

byType

@GET
 @Path(value="byType/{type}")
java.util.List<java.lang.String> byType(@PathParam(value="type")
                                                                           java.lang.String typeUid)
                                                                    throws ServerFault

List all ResourceDescriptor by type.

Parameters:

typeUid - { @link net.bluemind.resource.api.type.ResourceType } unique id

Returns:

list of ResourceDescriptor uids or null if the type does not exists or if there are no ResourceDescriptor matching.

Throws:

ServerFault - standard error object

addToEventDescription

@POST
 @Path(value="{uid}/addToEventDesc")
java.lang.String addToEventDescription(@PathParam(value="uid")
                                                                                  java.lang.String resourceUid,
                                                                                  EventInfo eventInfo)
                                                                           throws ServerFault

Compute the transformed template associated to the given resource if any, then append it to the given eventDescription.

Parameters:

resourceUid - the identifier of ResourceDescriptor

organizer - the organizer of the calendar event

Returns:

the modified - or not - eventDescription

Throws:

ServerFault - standard error object

See Also:

ResourceTypeDescriptor.templates

removeFromEventDescription

@POST
 @Path(value="{uid}/removeFromEventDesc")
java.lang.String removeFromEventDescription(@PathParam(value="uid")
                                                                                            java.lang.String resourceUid,
                                                                                            EventInfo eventInfo)
                                                                                     throws ServerFault

Remove the transformed template associated to the given resource from the given eventDescription.

Parameters:

resourceUid - the identifier of ResourceDescriptor

Returns:

the modified - or not - eventDescription

Throws:

ServerFault - standard error object

See Also:

ResourceTypeDescriptor.templates