net.bluemind.resource.api

Interface IResources

All Known Implementing Classes:

ResourcesService

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

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) Fetches a ResourceDescriptor item from the database with its email.
java.util.List<java.lang.String>	byType(java.lang.String typeUid) Search resources by type.
void	create(java.lang.String uid, ResourceDescriptor rd) Creates a resource
TaskRef	delete(java.lang.String uid) Deletes an existing resource
ResourceDescriptor	get(java.lang.String uid) Retrieve an existing resource
byte[]	getIcon(java.lang.String uid)
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)
void	update(java.lang.String uid, ResourceDescriptor rd) Modifies an existing resource

Method Detail

create

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

Creates a resource

Parameters:

domain -

Throws:

ServerFault - { ResourceDescriptor

ServerFault - standard error object

update

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

Modifies an existing resource

Parameters:

domain -

Throws:

ServerFault - updated { ResourceDescriptor

ServerFault - standard error object

delete

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

Deletes an existing resource

Throws:

ServerFault

ServerFault - standard error object

get

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

Retrieve an existing resource

Parameters:

uid -

Returns:

Throws:

ServerFault

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

Throws:

ServerFault

setIcon

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

Throws:

ServerFault

byEmail

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

Fetches a ResourceDescriptor item from the database with its email.

Parameters:

uid -

Returns:

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

Search resources by type.

Parameters:

typeUid - ResourceType.identifier

Returns:

Throws:

ServerFault

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