net.bluemind.resource.service.internal

Class ResourcesService

java.lang.Object

net.bluemind.resource.service.internal.ResourcesService

All Implemented Interfaces:

IResources

public class ResourcesService
extends java.lang.Object
implements IResources

Constructor Summary

Constructors

Constructor and Description
ResourcesService(BmContext context, ItemValue<Domain> domain, Container resourcesContainer)

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 rd) 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 rd) Modify an existing ResourceDescriptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourcesService

public ResourcesService(BmContext context,
                        ItemValue<Domain> domain,
                        Container resourcesContainer)
                 throws ServerFault

Throws:

ServerFault

Method Detail

create

public void create(java.lang.String uid,
                   ResourceDescriptor rd)
            throws ServerFault

Description copied from interface: IResources

Creates a ResourceDescriptor.

Specified by:

create in interface IResources

Parameters:

uid - { @link ResourceDescriptor } unique id

rd - { ResourceDescriptor

Throws:

ServerFault - standard error object

update

public void update(java.lang.String uid,
                   ResourceDescriptor rd)
            throws ServerFault

Description copied from interface: IResources

Modify an existing ResourceDescriptor.

Specified by:

update in interface IResources

Parameters:

uid - { @link ResourceDescriptor } unique id

rd - updated { ResourceDescriptor

Throws:

ServerFault - standard error object

delete

public TaskRef delete(java.lang.String uid)
               throws ServerFault

Description copied from interface: IResources

Delete an existing ResourceDescriptor.

Specified by:

delete in interface IResources

Parameters:

uid - { @link ResourceDescriptor } unique id

Throws:

ServerFault - standard error object

get

public ResourceDescriptor get(java.lang.String uid)
                       throws ServerFault

Description copied from interface: IResources

Fetch an existing ResourceDescriptor by its unique id.

Specified by:

get in interface IResources

Parameters:

uid - { @link ResourceDescriptor } unique id

Returns:

ResourceDescriptor, or null if the ResourceDescriptor does not exist

Throws:

ServerFault - standard error object

getIcon

public byte[] getIcon(java.lang.String uid)
               throws ServerFault

Description copied from interface: IResources

Fetch a ResourceDescriptor icon.

Specified by:

getIcon in interface IResources

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

public void setIcon(java.lang.String uid,
                    byte[] icon)
             throws ServerFault

Description copied from interface: IResources

Set a ResourceDescriptor icon.

Specified by:

setIcon in interface IResources

Parameters:

uid - { @link ResourceDescriptor } unique id

icon - icon binary data (png format)

Throws:

ServerFault - standard error object

byEmail

public ItemValue<ResourceDescriptor> byEmail(java.lang.String email)
                                      throws ServerFault

Description copied from interface: IResources

Fetch an existing ResourceDescriptor by its email.

Specified by:

byEmail in interface IResources

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

public java.util.List<java.lang.String> byType(java.lang.String typeUid)
                                        throws ServerFault

Description copied from interface: IResources

List all ResourceDescriptor by type.

Specified by:

byType in interface IResources

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

public java.lang.String addToEventDescription(java.lang.String resourceUid,
                                              EventInfo eventInfo)

Description copied from interface: IResources

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

Specified by:

addToEventDescription in interface IResources

Parameters:

resourceUid - the identifier of ResourceDescriptor

Returns:

the modified - or not - eventDescription

See Also:

ResourceTypeDescriptor.templates

removeFromEventDescription

public java.lang.String removeFromEventDescription(java.lang.String resourceUid,
                                                   EventInfo eventInfo)

Description copied from interface: IResources

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

Specified by:

removeFromEventDescription in interface IResources

Parameters:

resourceUid - the identifier of ResourceDescriptor

Returns:

the modified - or not - eventDescription

See Also:

ResourceTypeDescriptor.templates