Interface IResources

All Superinterfaces:
IRestoreDirEntryWithMailboxSupport<ResourceDescriptor>, IRestoreSupport<ResourceDescriptor>
@Path("/resources/{domainUid}") public interface IResources extends IRestoreDirEntryWithMailboxSupport<ResourceDescriptor>
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 Details

    • create

      @PUT @Path("{uid}") void create(@PathParam("uid") String uid, ResourceDescriptor resourceDescriptor) throws net.bluemind.core.api.fault.ServerFault
      Creates a ResourceDescriptor.
      Parameters:
      uid - { @link ResourceDescriptor } unique id
      resourceDescriptor - { ResourceDescriptor
      Throws:
      net.bluemind.core.api.fault.ServerFault - standard error object

    • update

      @POST @Path("{uid}") void update(@PathParam("uid") String uid, ResourceDescriptor resourceDescriptor) throws net.bluemind.core.api.fault.ServerFault
      Modify an existing ResourceDescriptor.
      Parameters:
      uid - { @link ResourceDescriptor } unique id
      resourceDescriptor - updated { ResourceDescriptor
      Throws:
      net.bluemind.core.api.fault.ServerFault - standard error object

    • delete

      @DELETE @Path("{uid}") TaskRef delete(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.ServerFault
      Delete an existing ResourceDescriptor.
      Specified by:
      delete in interface IRestoreDirEntryWithMailboxSupport<ResourceDescriptor>
      Parameters:
      uid - { @link ResourceDescriptor } unique id
      Throws:
      net.bluemind.core.api.fault.ServerFault - standard error object

    • get

      @GET @Path("{uid}") ResourceDescriptor get(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.ServerFault
      Fetch an existing ResourceDescriptor by its unique id.
      Specified by:
      get in interface IRestoreSupport<ResourceDescriptor>
      Parameters:
      uid - { @link ResourceDescriptor } unique id
      Returns:
      ResourceDescriptor, or null if the ResourceDescriptor does not exist
      Throws:
      net.bluemind.core.api.fault.ServerFault - standard error object

    • getIcon

      @GET @Path("{uid}/icon") @Produces("image/png") byte[] getIcon(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.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:
      net.bluemind.core.api.fault.ServerFault - standard error object

    • setIcon

      @POST @Path("{uid}/icon") @Consumes("image/png") void setIcon(@PathParam("uid") String uid, byte[] icon) throws net.bluemind.core.api.fault.ServerFault
      Set a ResourceDescriptor icon.
      Parameters:
      uid - { @link ResourceDescriptor } unique id
      icon - icon binary data (png format)
      Throws:
      net.bluemind.core.api.fault.ServerFault - standard error object

    • byEmail

      @GET @Path("byEmail/{email}") ItemValue<ResourceDescriptor> byEmail(@PathParam("email") String email) throws net.bluemind.core.api.fault.ServerFault
      Fetch an existing ResourceDescriptor by its email.
      Parameters:
      email - { @link ResourceDescriptor } email
      Returns:
      ResourceDescriptor ItemValue, or null if the ResourceDescriptor does not exist
      Throws:
      net.bluemind.core.api.fault.ServerFault - standard error object

    • byType

      @GET @Path("byType/{type}") List<String> byType(@PathParam("type") String typeUid) throws net.bluemind.core.api.fault.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:
      net.bluemind.core.api.fault.ServerFault - standard error object

    • addToEventDescription

      @POST @Path("{uid}/addToEventDesc") String addToEventDescription(@PathParam("uid") String resourceUid, EventInfo eventInfo) throws net.bluemind.core.api.fault.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
      eventInfo - the calendar event information
      Returns:
      the modified - or not - eventDescription
      Throws:
      net.bluemind.core.api.fault.ServerFault - standard error object
      See Also:

    • removeFromEventDescription

      @POST @Path("{uid}/removeFromEventDesc") String removeFromEventDescription(@PathParam("uid") String resourceUid, EventInfo eventInfo) throws net.bluemind.core.api.fault.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:
      net.bluemind.core.api.fault.ServerFault - standard error object
      See Also: