net.bluemind.mailshare.api

Interface IMailshare

All Superinterfaces:

IDirEntryPhotoSupport

All Known Implementing Classes:

MailshareService

@Path(value="/mailshares/{domainUid}")
public interface IMailshare
extends IDirEntryPhotoSupport

Method Summary

Modifier and Type	Method and Description
java.util.List<ItemValue<Mailshare>>	allComplete() Fetches all Mailshares
void	create(java.lang.String uid, Mailshare mailshare) Creates a new Mailshare entry.
TaskRef	delete(java.lang.String uid) Delete Mailshare entry
ItemValue<Mailshare>	getComplete(java.lang.String uid) Fetch a Mailshare from its unique uid
void	update(java.lang.String uid, Mailshare mailshare) Modifies an existing Mailshare entry.

Methods inherited from interface net.bluemind.directory.api.IDirEntryPhotoSupport

deletePhoto, getIcon, getPhoto, setPhoto

Method Detail

create

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

Creates a new Mailshare entry.

Parameters:

uid - uid of the entry

mailshare - value of the entry

Throws:

ServerFault

update

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

Modifies an existing Mailshare entry.

Parameters:

uid - uid of the entry

mailshare - value of the entry

Throws:

ServerFault

getComplete

@GET
 @Path(value="{uid}/complete")
ItemValue<Mailshare> getComplete(@PathParam(value="uid")
                                                                     java.lang.String uid)
                                                              throws ServerFault

Fetch a Mailshare from its unique uid

Parameters:

uid -

Returns:

ItemValue

Throws:

ServerFault

allComplete

@GET
 @Path(value="_complete")
java.util.List<ItemValue<Mailshare>> allComplete()
                                                                         throws ServerFault

Fetches all Mailshares

Returns:

list of all Mailshares

Throws:

ServerFault

delete

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

Delete Mailshare entry

Parameters:

uid -

Throws:

ServerFault